Class WorkflowProviderBean
- java.lang.Object
-
- de.xima.fc.workflow.designer.bean.WorkflowProviderBean
-
- All Implemented Interfaces:
IWorkflowProvider,Serializable
@ViewScoped @Named public class WorkflowProviderBean extends Object implements IWorkflowProvider, Serializable
Provides common data related to the workflow, often used as select options by UI elements.- Since:
- 7.0.0
- Author:
- XIMA MEDIA GmbH
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description WorkflowProviderBean()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description List<EAttachmentSource>getAllAttachmentSources()List<EntityRef>getAllClientCounterRefs()List<? extends de.xima.cmn.validation.spec.IChoiceEntry<EntityRef>>getAllClientCounterRefSelectItems()List<ClientCounter>getAllClientCounters()List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>>getAllClientCounterSelectItems()List<MandantRessource>getAllClientResources()List<DatenbankZugriff>getAllDatabaseConnections()List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>>getAllDatabaseConnectionSelectItems()List<Datenquelle>getAllDatabaseQueries()List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>>getAllDatabaseQuerySelectItems()List<DirectClientAuthorization>getAllDirectClientAuthorizations()List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>>getAllDirectClientAuthorizationSelectItems()List<String>getAllFormElements()List<Postfach>getAllInboxes()List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>>getAllInboxSelectItems()List<LDAPZugriff>getAllLdapConnections()List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>>getAllLdapConnectionSelectItems()List<LDAPAbfrage>getAllLdapQueries()List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>>getAllLdapQuerySelectItems()List<INodeWithName>getAllNodesOfType(String type)List<? extends de.xima.cmn.validation.spec.IChoiceEntry<NodeKey>>getAllNodesOfTypeSelectItems(String type)List<ProjektRessource>getAllProjectResources()List<IWorkflowQualifiedSubmitButton>getAllQualifiedSubmitButtons()List<? extends de.xima.cmn.validation.spec.IChoiceEntry<QualifiedSubmitButton>>getAllQualifiedSubmitButtonSelectItems()List<String>getAllRepeatedFormElementContainers()Gets all form elements of the current form version that arerepeatedcontainers.List<String>getAllRepeatedFormElements()List<WorkflowStateModel>getAllStates(boolean includeMarkedForDeletion)List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>>getAllStateSelectItems(boolean includeMarkedForDeletion)List<IWorkflowSubmitButton>getAllSubmitButtons()List<? extends de.xima.cmn.validation.spec.IChoiceEntry<String>>getAllSubmitButtonSelectItems()List<ITaskWithName>getAllTasks(boolean excludeSelf)List<ITaskWithName>getAllTasks(UUID taskToExclude)List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UUID>>getAllTaskSelectItems(boolean excludeSelf)Same asIWorkflowProvider.getAllTriggersOfType(String, UUID), but converted to select items with the trigger key as the value.List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UUID>>getAllTaskSelectItems(UUID taskToExclude)Same asIWorkflowProvider.getAllTasks(UUID), but converted to select items with the task key as the value.List<ITriggerWithName>getAllTriggersOfType(String type, boolean excludeSelf)List<ITriggerWithName>getAllTriggersOfType(String type, UUID taskToExclude)List<? extends de.xima.cmn.validation.spec.IChoiceEntry<TriggerKey>>getAllTriggersOfTypeSelectItems(String type, boolean excludeSelf)Same asIWorkflowProvider.getAllTriggersOfType(String, boolean), but converted to select items with the trigger key as the value.List<? extends de.xima.cmn.validation.spec.IChoiceEntry<TriggerKey>>getAllTriggersOfTypeSelectItems(String type, UUID taskToExclude)Same asIWorkflowProvider.getAllTriggersOfType(String, UUID), but converted to select items with the trigger key as the value.List<String>getAllUploadElements()List<? extends de.xima.cmn.validation.spec.IChoiceEntry<String>>getAllUploadElementSelectItems()List<BenutzerGruppe>getAllUserGroups()List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>>getAllUserGroupSelectItems()List<Benutzer>getAllUsers()Deprecated.List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>>getAllUserSelectItems()Deprecated.List<WebDavAccess>getAllWebDavConnections()List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>>getAllWebDavConnectionsSelectItems()List<IFileProvidingTriggerWithName>getAssignedProvidingTriggers()Returns the triggers of the workflow task that contains the given node and also provide files.List<IFileProvidingTriggerWithName>getAssignedProvidingTriggers(NodeKey key)Returns the triggers of the workflow task that contains the given node and also provide files.List<ITriggerWithName>getAssignedTriggers()Returns the triggers of the workflow task that contains the given node.List<ITriggerWithName>getAssignedTriggers(NodeKey key)Returns the triggers of the workflow task that contains the given node.List<INodeWithName>getAttachmentProvidingParents()Returns a list of all nodes that are parents of the currently selected node n and that provide attachment to the currently selected node.List<INodeWithName>getAttachmentProvidingParents(NodeKey key)Returns a list of all nodes that are parents of the given node and that provides or creates attachments, seegetAttachmentValueDescriptor).List<? extends de.xima.cmn.validation.spec.IChoiceEntry<AttachmentItem>>getAvailableAttachments(GetAvailableAttachmentsParams params)Returns a list of all available attachment items that are available for the currently selected workflow node.List<? extends de.xima.cmn.validation.spec.IChoiceEntry<AttachmentItem>>getAvailableAttachments(NodeKey currentNodeKey, GetAvailableAttachmentsParams params)Returns a list of all available attachment items that are available for the given workflow node.List<? extends de.xima.cmn.validation.spec.IChoiceEntry<ResourceItem>>getAvailableResources(GetAvailableResourcesParams params)List<? extends de.xima.cmn.validation.spec.IChoiceEntry<ResourceItem>>getAvailableResources(NodeKey currentNodeKey, GetAvailableResourcesParams params)Returns a list of all available resources, which may include client resources, form resources, and external resource URLs, etc.MandantgetClient()List<INodeWithName>getErrorCompletionPredecessors()A list of all nodes that have finished execution and that precede the currently selected node n; i.e.List<INodeWithName>getErrorCompletionPredecessors(NodeKey key)A list of all nodes that have finished execution and that precede the given node n; i.e.List<Charset>getInstalledCharsets()List<String>getInstalledFontNames()UUIDgetInvalidEntityUuid()StringgetInvalidEntityUuidString()LocalegetLocale()List<BaseConfigViewModel>getNonOrderableAuthenticatorConfigs()List<INodeWithName>getNormalCompletionAttachmentProvidingPredecessors()Returns a list of all predecessors of the currently selected node N, that have finished execution and that provide attachments.List<INodeWithName>getNormalCompletionAttachmentProvidingPredecessors(NodeKey key)Returns a list of all predecessors of the given node N, that have finished execution and that provide attachments.List<INodeWithName>getNormalCompletionPredecessors()A list of all nodes that have finished execution and that precede the currently selected node n; i.e.List<INodeWithName>getNormalCompletionPredecessors(NodeKey key)A list of all nodes that have finished execution and that precede the given node n; i.e.List<IFileProvidingNodeWithName>getNormalCompletionProvidingPredecessors()Returns a list of all predecessors of the currently selected node N, that have finished execution and that provide files.List<IFileProvidingNodeWithName>getNormalCompletionProvidingPredecessors(NodeKey key)Returns a list of all predecessors of the given node N that provide files.List<BaseConfigViewModel>getOrderableAuthenticatorConfigs()List<INodeWithName>getParentControlTransferTargets(NodeKey key, String... controlTransferTypes)List<INodeWithName>getParentControlTransferTargets(String... controlTransferTypes)List<? extends de.xima.cmn.validation.spec.IChoiceEntry<NodeKey>>getParentControlTransferTargetsSelectItems(NodeKey key, String... controlTransferTypes)List<? extends de.xima.cmn.validation.spec.IChoiceEntry<NodeKey>>getParentControlTransferTargetsSelectItems(String... controlTransferTypes)List<INodeWithName>getParents()List<INodeWithName>getParents(NodeKey key)List<? extends de.xima.cmn.validation.spec.IChoiceEntry<NodeKey>>getParentsSelectItems()List<? extends de.xima.cmn.validation.spec.IChoiceEntry<NodeKey>>getParentsSelectItems(NodeKey key)List<INodeWithName>getPredecessors()Deprecated.List<INodeWithName>getPredecessors(NodeKey key)Deprecated.ProjektgetProject()List<IFileProvidingNodeWithName>getProvidingParents()Returns a list of all nodes that are parents of the currently selected node n.List<IFileProvidingNodeWithName>getProvidingParents(NodeKey key)Returns a list of all nodes that are parents of the given node and that provides or creates files, seegetFileValueDescriptor).List<IFileProvidingNodeWithName>getProvidingPredecessors()Deprecated.List<IFileProvidingNodeWithName>getProvidingPredecessors(NodeKey key)Deprecated.List<Charset>getStandardSupportedCharsets()List<Textbaustein>getTextTemplatesByCategory(ETextbausteinKategorie category)List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>>getTextTemplateSelectItemsByCategory(ETextbausteinKategorie category)WorkflowVersiongetWorkflowVersion()-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface de.xima.fc.interfaces.workflow.IWorkflowProvider
getAvailableResources, getAvailableResources, getAvailableResources, getAvailableResources
-
-
-
-
Method Detail
-
getAllAttachmentSources
public List<EAttachmentSource> getAllAttachmentSources()
- Specified by:
getAllAttachmentSourcesin interfaceIWorkflowProvider- Returns:
- a list of all attachment sources
-
getAllClientCounterRefSelectItems
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<EntityRef>> getAllClientCounterRefSelectItems()
- Specified by:
getAllClientCounterRefSelectItemsin interfaceIWorkflowProvider- Returns:
- Similar to
IWorkflowProvider.getAllClientCounterSelectItems(), but includes aEntityRef.forNameValue(String)entry that lets the user enter a counter by its name.
-
getAllClientCounterRefs
public List<EntityRef> getAllClientCounterRefs()
- Specified by:
getAllClientCounterRefsin interfaceIWorkflowProvider- Returns:
- Similar to
IWorkflowProvider.getAllClientCounters(), but includes aEntityRef.forNameValue(String)entry that lets the user enter a counter by its name.
-
getAllClientCounterSelectItems
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> getAllClientCounterSelectItems()
- Specified by:
getAllClientCounterSelectItemsin interfaceIWorkflowProvider- Returns:
- Same as
IWorkflowProvider.getAllClientCounters(), but returns select items with the value and the name of the LDAP query.
-
getAllClientCounters
public List<ClientCounter> getAllClientCounters()
- Specified by:
getAllClientCountersin interfaceIWorkflowProvider- Returns:
- A list of all client counters available to the current client. Empty list if none are found.
-
getAllClientResources
public List<MandantRessource> getAllClientResources()
- Specified by:
getAllClientResourcesin interfaceIWorkflowProvider- Returns:
- A list of all client resources of the current client.
-
getAllDatabaseConnectionSelectItems
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> getAllDatabaseConnectionSelectItems()
- Specified by:
getAllDatabaseConnectionSelectItemsin interfaceIWorkflowProvider- Returns:
- Same as
IWorkflowProvider.getAllDatabaseConnections(), but returns select items with the value and the name of the database connection.
-
getAllDatabaseConnections
public List<DatenbankZugriff> getAllDatabaseConnections()
- Specified by:
getAllDatabaseConnectionsin interfaceIWorkflowProvider- Returns:
- A list of all database connection available to the current client. Empty list if none are found.
-
getAllDatabaseQueries
public List<Datenquelle> getAllDatabaseQueries()
- Specified by:
getAllDatabaseQueriesin interfaceIWorkflowProvider- Returns:
- A list of all database queries that are defined in client scope. Empty list when none are available.
-
getAllDatabaseQuerySelectItems
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> getAllDatabaseQuerySelectItems()
- Specified by:
getAllDatabaseQuerySelectItemsin interfaceIWorkflowProvider- Returns:
- Same as
IWorkflowProvider.getAllDatabaseQueries(), but returns select items with the value and the name of the database query.
-
getAllDirectClientAuthorizationSelectItems
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> getAllDirectClientAuthorizationSelectItems()
- Specified by:
getAllDirectClientAuthorizationSelectItemsin interfaceIWorkflowProvider- Returns:
- Same as
IWorkflowProvider.getAllDirectClientAuthorizations(), but returns select items with the value and the name of the user.
-
getAllDirectClientAuthorizations
public List<DirectClientAuthorization> getAllDirectClientAuthorizations()
- Specified by:
getAllDirectClientAuthorizationsin interfaceIWorkflowProvider- Returns:
- All direct client authorizations available to the current client. Empty list if none are found.
-
getAllFormElements
public List<String> getAllFormElements()
- Specified by:
getAllFormElementsin interfaceIWorkflowProvider- Returns:
- All
valuableform elements of the current form version. Empty list if none are found.
-
getAllInboxSelectItems
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> getAllInboxSelectItems()
- Specified by:
getAllInboxSelectItemsin interfaceIWorkflowProvider- Returns:
- Same as
IWorkflowProvider.getAllInboxes(), but returns select items with the value and the name of the inbox.
-
getAllInboxes
public List<Postfach> getAllInboxes()
- Specified by:
getAllInboxesin interfaceIWorkflowProvider- Returns:
- All inboxes available to the current client. Empty list if none are found.
-
getAllLdapConnectionSelectItems
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> getAllLdapConnectionSelectItems()
- Specified by:
getAllLdapConnectionSelectItemsin interfaceIWorkflowProvider- Returns:
- Same as
IWorkflowProvider.getAllLdapConnections(), but returns select items with the value and the name of the LDAP connection.
-
getAllLdapConnections
public List<LDAPZugriff> getAllLdapConnections()
- Specified by:
getAllLdapConnectionsin interfaceIWorkflowProvider- Returns:
- A list of all LDAP queries available to the current client. Empty list if none are found.
-
getAllLdapQueries
public List<LDAPAbfrage> getAllLdapQueries()
- Specified by:
getAllLdapQueriesin interfaceIWorkflowProvider- Returns:
- A list of all LDAP queries available to the current client. Empty list if none are found.
-
getAllLdapQuerySelectItems
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> getAllLdapQuerySelectItems()
- Specified by:
getAllLdapQuerySelectItemsin interfaceIWorkflowProvider- Returns:
- Same as
IWorkflowProvider.getAllLdapQueries(), but returns select items with the value and the name of the LDAP query.
-
getAllNodesOfType
public List<INodeWithName> getAllNodesOfType(String type)
- Specified by:
getAllNodesOfTypein interfaceIWorkflowProvider- Parameters:
type-typeof the nodes to retrieve. Can be empty to retrieve all nodes.- Returns:
- All nodes in the current process that are of the given type.
-
getAllNodesOfTypeSelectItems
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<NodeKey>> getAllNodesOfTypeSelectItems(String type)
- Specified by:
getAllNodesOfTypeSelectItemsin interfaceIWorkflowProvider- Parameters:
type-typeof the nodes to retrieve. Can be empty to retrieve all nodes.- Returns:
- Same as
IWorkflowProvider.getAllNodesOfType(String), but returns select items with the value set to theNodeKeyand the name to the name of the node.
-
getAllProjectResources
public List<ProjektRessource> getAllProjectResources()
- Specified by:
getAllProjectResourcesin interfaceIWorkflowProvider- Returns:
- A list of all project resource of the current project.
-
getAllQualifiedSubmitButtonSelectItems
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<QualifiedSubmitButton>> getAllQualifiedSubmitButtonSelectItems()
- Specified by:
getAllQualifiedSubmitButtonSelectItemsin interfaceIWorkflowProvider- Returns:
- Same as
IWorkflowProvider.getAllSubmitButtons(), but converted to select items with the button name as the value.
-
getAllQualifiedSubmitButtons
public List<IWorkflowQualifiedSubmitButton> getAllQualifiedSubmitButtons()
- Specified by:
getAllQualifiedSubmitButtonsin interfaceIWorkflowProvider- Returns:
- A list of all qualified submit buttons contained in the project whose workflow is being edited. When there are buttons with the same button name, they are included multiple times.
-
getAllRepeatedFormElementContainers
public List<String> getAllRepeatedFormElementContainers()
Description copied from interface:IWorkflowProviderGets all form elements of the current form version that arerepeatedcontainers. This does not include form element inside repeated containers, useIWorkflowProvider.getAllRepeatedFormElements()for that.- Specified by:
getAllRepeatedFormElementContainersin interfaceIWorkflowProvider- Returns:
- All repetition containers.
-
getAllRepeatedFormElements
public List<String> getAllRepeatedFormElements()
Description copied from interface:IWorkflowProviderGets all form elements of the current form version that are eitherrepeatedcontainer; or avaluableand either themselves repeated or are inside a repeated container.- Specified by:
getAllRepeatedFormElementsin interfaceIWorkflowProvider- Returns:
- All repeated elements or elements inside repeated containers.
-
getAllStateSelectItems
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> getAllStateSelectItems(boolean includeMarkedForDeletion)
- Specified by:
getAllStateSelectItemsin interfaceIWorkflowProvider- Parameters:
includeMarkedForDeletion-trueto include states that have been marked for deletion when the workflow is saved,falseto exclude those states and return only states that are still present.- Returns:
- Same as
IWorkflowProvider.getAllStates(boolean), but returns select items with the value and the name of the state.
-
getAllStates
public List<WorkflowStateModel> getAllStates(boolean includeMarkedForDeletion)
- Specified by:
getAllStatesin interfaceIWorkflowProvider- Parameters:
includeMarkedForDeletion-trueto include states that have been marked for deletion when the workflow is saved,falseto exclude those states and return only states that are still present.- Returns:
- A list of all states for the current project.
-
getAllSubmitButtonSelectItems
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<String>> getAllSubmitButtonSelectItems()
- Specified by:
getAllSubmitButtonSelectItemsin interfaceIWorkflowProvider- Returns:
- Same as
IWorkflowProvider.getAllSubmitButtons(), but converted to select items with the button name as the value.
-
getAllSubmitButtons
public List<IWorkflowSubmitButton> getAllSubmitButtons()
- Specified by:
getAllSubmitButtonsin interfaceIWorkflowProvider- Returns:
- A list of all submit buttons contained in the project whose workflow is being edited. When there are buttons with the same button name, only one is included.
-
getAllTaskSelectItems
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UUID>> getAllTaskSelectItems(boolean excludeSelf)
Description copied from interface:IWorkflowProviderSame asIWorkflowProvider.getAllTriggersOfType(String, UUID), but converted to select items with the trigger key as the value.- Specified by:
getAllTaskSelectItemsin interfaceIWorkflowProvider- Parameters:
excludeSelf-trueto exclude the task of the current trigger,trueto include all.- Returns:
- All task in the current process, without the task to exclude if given.
-
getAllTaskSelectItems
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UUID>> getAllTaskSelectItems(UUID taskToExclude)
Description copied from interface:IWorkflowProviderSame asIWorkflowProvider.getAllTasks(UUID), but converted to select items with the task key as the value.- Specified by:
getAllTaskSelectItemsin interfaceIWorkflowProvider- Parameters:
taskToExclude- Task to exclude in the result,nullto exclude none.- Returns:
- All task in the current process, without the task to exclude if given.
-
getAllTasks
public List<ITaskWithName> getAllTasks(boolean excludeSelf)
- Specified by:
getAllTasksin interfaceIWorkflowProvider- Parameters:
excludeSelf-trueto exclude the task of the current trigger,trueto include all.- Returns:
- All task in the current process, without the task to exclude if given.
-
getAllTasks
public List<ITaskWithName> getAllTasks(UUID taskToExclude)
- Specified by:
getAllTasksin interfaceIWorkflowProvider- Parameters:
taskToExclude- Task to exclude in the result,nullto exclude none.- Returns:
- All task in the current process, without the task to exclude if given.
-
getAllTriggersOfType
public List<ITriggerWithName> getAllTriggersOfType(String type, boolean excludeSelf)
- Specified by:
getAllTriggersOfTypein interfaceIWorkflowProvider- Parameters:
type-typeof the triggers to retrieve. Can be empty to retrieve all triggers.excludeSelf-trueto exclude the task of the current trigger,trueto include all.- Returns:
- All triggers in the current process that are of the given type.
-
getAllTriggersOfType
public List<ITriggerWithName> getAllTriggersOfType(String type, UUID taskToExclude)
- Specified by:
getAllTriggersOfTypein interfaceIWorkflowProvider- Parameters:
type-typeof the triggers to retrieve. Can be empty to retrieve all triggers.taskToExclude- Task to exclude in the result,nullto exclude none.- Returns:
- All triggers in the current process that are of the given type.
-
getAllTriggersOfTypeSelectItems
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<TriggerKey>> getAllTriggersOfTypeSelectItems(String type, boolean excludeSelf)
Description copied from interface:IWorkflowProviderSame asIWorkflowProvider.getAllTriggersOfType(String, boolean), but converted to select items with the trigger key as the value.- Specified by:
getAllTriggersOfTypeSelectItemsin interfaceIWorkflowProvider- Parameters:
type-typeof the triggers to retrieve. Can be empty to retrieve all triggers.excludeSelf-trueto exclude the task of the current trigger,trueto include all.- Returns:
- All triggers in the current process that are of the given type.
-
getAllTriggersOfTypeSelectItems
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<TriggerKey>> getAllTriggersOfTypeSelectItems(String type, UUID taskToExclude)
Description copied from interface:IWorkflowProviderSame asIWorkflowProvider.getAllTriggersOfType(String, UUID), but converted to select items with the trigger key as the value.- Specified by:
getAllTriggersOfTypeSelectItemsin interfaceIWorkflowProvider- Parameters:
type-typeof the triggers to retrieve. Can be empty to retrieve all triggers.taskToExclude- Task to exclude in the result,nullto exclude none.- Returns:
- All triggers in the current process that are of the given type.
-
getAllUploadElementSelectItems
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<String>> getAllUploadElementSelectItems()
- Specified by:
getAllUploadElementSelectItemsin interfaceIWorkflowProvider- Returns:
- Same as
IWorkflowProvider.getAllUploadElements(), but converted to select items with the field name as the value.
-
getAllUploadElements
public List<String> getAllUploadElements()
- Specified by:
getAllUploadElementsin interfaceIWorkflowProvider- Returns:
- A list with all upload elements available to the currently selected action.
-
getAllUserGroupSelectItems
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> getAllUserGroupSelectItems()
- Specified by:
getAllUserGroupSelectItemsin interfaceIWorkflowProvider- Returns:
- Same as
IWorkflowProvider.getAllUserGroups(), but returns select items with the value and the name of the user group.
-
getAllUserGroups
public List<BenutzerGruppe> getAllUserGroups()
- Specified by:
getAllUserGroupsin interfaceIWorkflowProvider- Returns:
- All user groups available to the current client. Empty list if none are found.
-
getAllUserSelectItems
@Deprecated public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> getAllUserSelectItems()
Deprecated.- Specified by:
getAllUserSelectItemsin interfaceIWorkflowProvider- Returns:
- Same as
IWorkflowProvider.getAllUsers(), but returns select items with the value and the name of the user .
-
getAllUsers
@Deprecated public List<Benutzer> getAllUsers()
Deprecated.- Specified by:
getAllUsersin interfaceIWorkflowProvider- Returns:
- All users available to the current client. Empty list if none are found.
-
getAllWebDavConnections
public List<WebDavAccess> getAllWebDavConnections()
- Specified by:
getAllWebDavConnectionsin interfaceIWorkflowProvider- Returns:
- A list of all WebDAV connections available to the current client. Empty list if none are found.
-
getAllWebDavConnectionsSelectItems
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> getAllWebDavConnectionsSelectItems()
- Specified by:
getAllWebDavConnectionsSelectItemsin interfaceIWorkflowProvider- Returns:
- Same as
IWorkflowProvider.getAllWebDavConnections(), but returns select items with the value and the name of the database connection.
-
getAssignedProvidingTriggers
public List<IFileProvidingTriggerWithName> getAssignedProvidingTriggers(NodeKey key)
Description copied from interface:IWorkflowProviderReturns the triggers of the workflow task that contains the given node and also provide files. When those triggers fire, the processing chain with the node gets executed.- Specified by:
getAssignedProvidingTriggersin interfaceIWorkflowProvider- Parameters:
key- Key of the node to process.- Returns:
- A list of all triggers that control the execution of the processing chain with the given node.
-
getAssignedProvidingTriggers
public List<IFileProvidingTriggerWithName> getAssignedProvidingTriggers()
Description copied from interface:IWorkflowProviderReturns the triggers of the workflow task that contains the given node and also provide files. When those triggers fire, the processing chain with the node gets executed.This method is available only when the workflow designer UI is opened. Use
getNormalCompletionProvidingPredecessorsand specify the node directly.- Specified by:
getAssignedProvidingTriggersin interfaceIWorkflowProvider- Returns:
- A list of all triggers that control the execution of the processing chain with the given node.
-
getAssignedTriggers
public List<ITriggerWithName> getAssignedTriggers()
Description copied from interface:IWorkflowProviderReturns the triggers of the workflow task that contains the given node. When those triggers fire, the processing chain with the node gets executed.This method is available only when the workflow designer UI is opened. Use
getNormalCompletionProvidingPredecessorsand specify the node directly.- Specified by:
getAssignedTriggersin interfaceIWorkflowProvider- Returns:
- A list of all triggers that control the execution of the processing chain with the given node.
-
getAssignedTriggers
public List<ITriggerWithName> getAssignedTriggers(NodeKey key)
Description copied from interface:IWorkflowProviderReturns the triggers of the workflow task that contains the given node. When those triggers fire, the processing chain with the node gets executed.- Specified by:
getAssignedTriggersin interfaceIWorkflowProvider- Parameters:
key- Key of the node to process.- Returns:
- A list of all triggers that control the execution of the processing chain with the given node.
-
getAttachmentProvidingParents
public List<INodeWithName> getAttachmentProvidingParents()
Description copied from interface:IWorkflowProviderReturns a list of all nodes that are parents of the currently selected node n and that provide attachment to the currently selected node. This method is available only when the workflow designer UI is opened. UseIWorkflowProvider.getParents(NodeKey)and specify the node directly. Parent nodes such as loops may provide attachments during their execution.- Specified by:
getAttachmentProvidingParentsin interfaceIWorkflowProvider- Returns:
- A list of all workflow nodes that are a parent of the current node and provide attachments.
-
getAttachmentProvidingParents
public List<INodeWithName> getAttachmentProvidingParents(NodeKey key)
Description copied from interface:IWorkflowProviderReturns a list of all nodes that are parents of the given node and that provides or creates attachments, seegetAttachmentValueDescriptor). Parent nodes such as loops may provide attachments during their execution.- Specified by:
getAttachmentProvidingParentsin interfaceIWorkflowProvider- Parameters:
key- Key of the node to check.- Returns:
- A list of all workflow nodes that are a parent of the given node and provide attachments.
-
getAvailableAttachments
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<AttachmentItem>> getAvailableAttachments(GetAvailableAttachmentsParams params)
Description copied from interface:IWorkflowProviderReturns a list of all available attachment items that are available for the currently selected workflow node.- Specified by:
getAvailableAttachmentsin interfaceIWorkflowProvider- Parameters:
params- Parameters for retrieving the available attachments. Whennull, usesGetAvailableAttachmentsParams.defaults().- Returns:
- A list of all attachment items available for the given node.
- See Also:
IWorkflowProvider.getAvailableAttachments(NodeKey, GetAvailableAttachmentsParams)
-
getAvailableAttachments
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<AttachmentItem>> getAvailableAttachments(NodeKey currentNodeKey, GetAvailableAttachmentsParams params)
Description copied from interface:IWorkflowProviderReturns a list of all available attachment items that are available for the given workflow node.- Specified by:
getAvailableAttachmentsin interfaceIWorkflowProvider- Parameters:
currentNodeKey-NodeKeyof the currently selected node.params- Parameters for retrieving the available attachments. Whennull, usesGetAvailableAttachmentsParams.defaults().- Returns:
- A list of all attachment items available for the given node.
-
getAvailableResources
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<ResourceItem>> getAvailableResources(GetAvailableResourcesParams params)
- Specified by:
getAvailableResourcesin interfaceIWorkflowProvider
-
getAvailableResources
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<ResourceItem>> getAvailableResources(NodeKey currentNodeKey, GetAvailableResourcesParams params)
Description copied from interface:IWorkflowProviderReturns a list of all available resources, which may include client resources, form resources, and external resource URLs, etc.- Specified by:
getAvailableResourcesin interfaceIWorkflowProvider- Parameters:
currentNodeKey-NodeKeyof the current selected node.params- Parameters controlling the search for available resources, e.g. which files to include.- Returns:
- A list of all available resources matching the search criteria.
-
getClient
public Mandant getClient()
- Specified by:
getClientin interfaceIWorkflowProvider- Returns:
- The current client for which the workflow is being edited.
-
getErrorCompletionPredecessors
public List<INodeWithName> getErrorCompletionPredecessors()
Description copied from interface:IWorkflowProviderA list of all nodes that have finished execution and that precede the currently selected node n; i.e. the set of all nodes {m} such that m is not a parent of n and that there exists at least one code path where m is executed before n, where the path does not includebackwardsedges and starts with athrowing edge.This method is available only when the workflow designer UI is opened. Use
IWorkflowProvider.getErrorCompletionPredecessors(NodeKey)and specify the node directly.- Specified by:
getErrorCompletionPredecessorsin interfaceIWorkflowProvider- Returns:
- A list of all nodes that have finished execution and that precede the currently selected node.
-
getErrorCompletionPredecessors
public List<INodeWithName> getErrorCompletionPredecessors(NodeKey key)
Description copied from interface:IWorkflowProviderA list of all nodes that have finished execution and that precede the given node n; i.e. the set of all nodes {m} such that m is not a parent of n and that there exists at least one code path where m is executed before n, where the path does not includebackwardsedges and starts with athrowing edge.- Specified by:
getErrorCompletionPredecessorsin interfaceIWorkflowProvider- Parameters:
key- Node for which to find its predecessors.- Returns:
- A list of all nodes that have finished execution and that precede the given node.
-
getInstalledCharsets
public List<Charset> getInstalledCharsets()
- Specified by:
getInstalledCharsetsin interfaceIWorkflowProvider- Returns:
- A list of all character supported by the server.
-
getInstalledFontNames
public List<String> getInstalledFontNames()
- Specified by:
getInstalledFontNamesin interfaceIWorkflowProvider- Returns:
- A list of all font names that are currently installed on the system.
-
getInvalidEntityUuid
public UUID getInvalidEntityUuid()
- Specified by:
getInvalidEntityUuidin interfaceIWorkflowProvider- Returns:
- The UUID that is considered invalid. May be used as a default or no select option.
-
getInvalidEntityUuidString
public String getInvalidEntityUuidString()
- Specified by:
getInvalidEntityUuidStringin interfaceIWorkflowProvider- Returns:
- The UUID that is considered invalid. May be used as a default or no select option.
-
getLocale
public Locale getLocale()
- Specified by:
getLocalein interfaceIWorkflowProvider- Returns:
- The current locale that is to be used for locale-sensitive operations.
-
getNonOrderableAuthenticatorConfigs
public List<BaseConfigViewModel> getNonOrderableAuthenticatorConfigs()
- Specified by:
getNonOrderableAuthenticatorConfigsin interfaceIWorkflowProvider- Returns:
- All non-orderable authenticator configurations that are available to the current project.
-
getNormalCompletionAttachmentProvidingPredecessors
public List<INodeWithName> getNormalCompletionAttachmentProvidingPredecessors()
Description copied from interface:IWorkflowProviderReturns a list of all predecessors of the currently selected node N, that have finished execution and that provide attachments. Specifically, returns all workflow nodes X with the following properties:- the node X is part of the same
WorkflowTaskas the currently selected node N - the node X is not a parent of the currently selected node N (as such nodes are still executing)
- the currently selected node N is potentially reachable from node X (see
getPotentialPredecessorsOfvia a path that does not include backwards edges and starts with anormaledge. - the node X provides or creates attachments, see
getAttachmentValueDescriptor)
getNormalCompletionProvidingPredecessorsand specify the node directly.- Specified by:
getNormalCompletionAttachmentProvidingPredecessorsin interfaceIWorkflowProvider- Returns:
- A list of all workflow nodes that can provide files to the currently selected node.
- the node X is part of the same
-
getNormalCompletionAttachmentProvidingPredecessors
public List<INodeWithName> getNormalCompletionAttachmentProvidingPredecessors(NodeKey key)
Description copied from interface:IWorkflowProviderReturns a list of all predecessors of the given node N, that have finished execution and that provide attachments. Specifically, returns all workflow nodes X with the following properties:- the node X is part of the same
WorkflowTaskas the given node N - the node X is not a parent of the given node N (as such nodes are still executing)
- the given node N is potentially reachable from node X (see
getPotentialPredecessorsOfvia a path that does not include backwards edges and starts with anormaledge. - the node X provides or creates attachments, see
getAttachmentValueDescriptor)
- Specified by:
getNormalCompletionAttachmentProvidingPredecessorsin interfaceIWorkflowProvider- Returns:
- A list of all workflow nodes that can provide files to the given node.
- the node X is part of the same
-
getNormalCompletionPredecessors
public List<INodeWithName> getNormalCompletionPredecessors()
Description copied from interface:IWorkflowProviderA list of all nodes that have finished execution and that precede the currently selected node n; i.e. the set of all nodes {m} such that m is not a parent of n and that there exists at least one code path where m is executed before n, where the path does not includebackwardsedges and starts with anormal edge.This method is available only when the workflow designer UI is opened. Use
getNormalCompletionPredecessorsand specify the node directly.- Specified by:
getNormalCompletionPredecessorsin interfaceIWorkflowProvider- Returns:
- A list of all nodes that have finished execution and that precede the currently selected node.
-
getNormalCompletionPredecessors
public List<INodeWithName> getNormalCompletionPredecessors(NodeKey key)
Description copied from interface:IWorkflowProviderA list of all nodes that have finished execution and that precede the given node n; i.e. the set of all nodes {m} such that m is not a parent of n and that there exists at least one code path where m is executed before n, where the path does not includebackwardsedges and starts with anormal edge.- Specified by:
getNormalCompletionPredecessorsin interfaceIWorkflowProvider- Parameters:
key- Node for which to find its predecessors.- Returns:
- A list of all nodes that have finished execution and that precede the given node.
-
getNormalCompletionProvidingPredecessors
public List<IFileProvidingNodeWithName> getNormalCompletionProvidingPredecessors()
Description copied from interface:IWorkflowProviderReturns a list of all predecessors of the currently selected node N, that have finished execution and that provide files. Specifically, return all workflow nodes X with the following properties:- the node X is part of the same
WorkflowTaskas the currently selected node N - the node X is not a parent of the currently selected node N (as such nodes are still executing)
- the currently selected node N is potentially reachable from node X (see
getPotentialPredecessorsOfvia a path that does not includebackwardsedges and starts with anormaledge. - the node X provides or creates files, see
getFileValueDescriptor)
getNormalCompletionProvidingPredecessorsand specify the node directly.- Specified by:
getNormalCompletionProvidingPredecessorsin interfaceIWorkflowProvider- Returns:
- A list of all workflow nodes that can provide files to the currently selected node.
- the node X is part of the same
-
getNormalCompletionProvidingPredecessors
public List<IFileProvidingNodeWithName> getNormalCompletionProvidingPredecessors(NodeKey key)
Description copied from interface:IWorkflowProviderReturns a list of all predecessors of the given node N that provide files. Specifically, return all workflow nodes X with the following properties:- the node X is part of the same
WorkflowTaskas the given node - the node X is not a parent of the given node N (as such nodes are still executing)
- the currently selected node N is potentially reachable from node X (see
getPotentialPredecessorsOf) via a path that does not includebackwardsedges and starts with anormaledge. - the node X provides or creates files, see
getFileValueDescriptor)
- Specified by:
getNormalCompletionProvidingPredecessorsin interfaceIWorkflowProvider- Parameters:
key- Key of the node to check.- Returns:
- A list of all workflow nodes that can provide files to the given node.
- the node X is part of the same
-
getOrderableAuthenticatorConfigs
public List<BaseConfigViewModel> getOrderableAuthenticatorConfigs()
- Specified by:
getOrderableAuthenticatorConfigsin interfaceIWorkflowProvider- Returns:
- All orderable authenticator configurations that are available to the current project.
-
getParentControlTransferTargets
public List<INodeWithName> getParentControlTransferTargets(NodeKey key, String... controlTransferTypes)
- Specified by:
getParentControlTransferTargetsin interfaceIWorkflowProvider- Parameters:
key- Node for which to find its control transfer parents.controlTransferTypes- Control transfer types to look for. When none are given, all nodes that support at least one control transfer type are returned.- Returns:
- Similar to
IWorkflowProvider.getParents(NodeKey), but only returnsbreakable.
-
getParentControlTransferTargets
public List<INodeWithName> getParentControlTransferTargets(String... controlTransferTypes)
- Specified by:
getParentControlTransferTargetsin interfaceIWorkflowProvider- Parameters:
controlTransferTypes- Control transfer types to look for. When none are given, all nodes that support at least one control transfer type are returned.- Returns:
- Similar to
IWorkflowProvider.getParents(NodeKey), but only returnsbreakable.
-
getParentControlTransferTargetsSelectItems
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<NodeKey>> getParentControlTransferTargetsSelectItems(NodeKey key, String... controlTransferTypes)
- Specified by:
getParentControlTransferTargetsSelectItemsin interfaceIWorkflowProvider- Parameters:
key- Node for which to find its predecessors.controlTransferTypes- Control transfer types to look for. When none are given, all nodes that support at least one control transfer type are returned.- Returns:
- Same as
IWorkflowProvider.getParentControlTransferTargets(NodeKey, String[]), but returns select items with the value set to theNodeKeyand the name to the name of the node.
-
getParentControlTransferTargetsSelectItems
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<NodeKey>> getParentControlTransferTargetsSelectItems(String... controlTransferTypes)
- Specified by:
getParentControlTransferTargetsSelectItemsin interfaceIWorkflowProvider- Parameters:
controlTransferTypes- Control transfer types to look for. When none are given, all nodes that support at least one control transfer type are returned.- Returns:
- Same as
IWorkflowProvider.getParentControlTransferTargets(String[]), but returns select items with the value set to theNodeKeyand the name to the name of the node.
-
getParents
public List<INodeWithName> getParents()
- Specified by:
getParentsin interfaceIWorkflowProvider- Returns:
- A list of all nodes that are parents of the currently selected node n. This method is
available only when the workflow designer UI is opened. Use
IWorkflowProvider.getParents(NodeKey)and specify the node directly.
-
getParents
public List<INodeWithName> getParents(NodeKey key)
- Specified by:
getParentsin interfaceIWorkflowProvider- Parameters:
key- Node for which to find its parents.- Returns:
- A list of all nodes that are parents of the currently selected node n.
-
getParentsSelectItems
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<NodeKey>> getParentsSelectItems()
- Specified by:
getParentsSelectItemsin interfaceIWorkflowProvider- Returns:
- Same as
IWorkflowProvider.getParents(), but returns select items with the value set to theNodeKeyand the name to the name of the node.
-
getParentsSelectItems
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<NodeKey>> getParentsSelectItems(NodeKey key)
- Specified by:
getParentsSelectItemsin interfaceIWorkflowProvider- Parameters:
key- Node for which to find its predecessors.- Returns:
- Same as
IWorkflowProvider.getParents(NodeKey), but returns select items with the value set to theNodeKeyand the name to the name of the node.
-
getPredecessors
@Deprecated public List<INodeWithName> getPredecessors()
Deprecated.- Specified by:
getPredecessorsin interfaceIWorkflowProvider- Returns:
- A list of all nodes that precede the currently selected node n, i.e. the set of all
nodes {m} such that there exists at least one code path where m is
executed before n. This method is available only when the workflow designer UI is opened.
Use
IWorkflowProvider.getPredecessors(NodeKey)and specify the node directly.
-
getPredecessors
@Deprecated public List<INodeWithName> getPredecessors(NodeKey key)
Deprecated.- Specified by:
getPredecessorsin interfaceIWorkflowProvider- Parameters:
key- Node for which to find its predecessors.- Returns:
- A list of all nodes that precede the given node n, i.e. the set of all nodes {m} such that there exists at least one code path where m is executed before n.
-
getProject
public Projekt getProject()
- Specified by:
getProjectin interfaceIWorkflowProvider- Returns:
- The current project for which the workflow is being edited.
-
getProvidingParents
public List<IFileProvidingNodeWithName> getProvidingParents()
Description copied from interface:IWorkflowProviderReturns a list of all nodes that are parents of the currently selected node n. This method is available only when the workflow designer UI is opened. UseIWorkflowProvider.getParents(NodeKey)and specify the node directly. Parent nodes such as loops may provide files during their execution.- Specified by:
getProvidingParentsin interfaceIWorkflowProvider- Returns:
- A list of all workflow nodes that are a parent of the current node and provide files.
-
getProvidingParents
public List<IFileProvidingNodeWithName> getProvidingParents(NodeKey key)
Description copied from interface:IWorkflowProviderReturns a list of all nodes that are parents of the given node and that provides or creates files, seegetFileValueDescriptor). Parent nodes such as loops may provide files during their execution.- Specified by:
getProvidingParentsin interfaceIWorkflowProvider- Parameters:
key- Key of the node to check.- Returns:
- A list of all workflow nodes that are a parent of the given node and provide files.
-
getProvidingPredecessors
@Deprecated public List<IFileProvidingNodeWithName> getProvidingPredecessors()
Deprecated.Description copied from interface:IWorkflowProviderReturns a list of all predecessors of the currently selected node, if it provides files. Specifically, return all workflow nodes X with the following properties:- the node X is part of the same
WorkflowTaskas the currently selected node - the currently selected node is potentially reachable from node X (see
IWorkflowFlowAnalysis.getPotentialPredecessorsOf(NodeKey) - the node X provides or creates files, see
IExecutionResultDescriptor.getFileValueDescriptor())
- Specified by:
getProvidingPredecessorsin interfaceIWorkflowProvider- Returns:
- A list of all workflow nodes that can provide files to the currently selected node.
- the node X is part of the same
-
getProvidingPredecessors
@Deprecated public List<IFileProvidingNodeWithName> getProvidingPredecessors(NodeKey key)
Deprecated.Description copied from interface:IWorkflowProviderReturns a list of all predecessors of the given node that provide files. Specifically, return all workflow nodes X with the following properties:- the node X is part of the same
WorkflowTaskas the given node - the given node is potentially reachable from node X (see
IWorkflowFlowAnalysis.getPotentialPredecessorsOf(NodeKey) - the node X provides or creates files, see
IExecutionResultDescriptor.getFileValueDescriptor())
- Specified by:
getProvidingPredecessorsin interfaceIWorkflowProvider- Parameters:
key- Key of the node to check.- Returns:
- A list of all workflow nodes that can provide files to the given node.
- the node X is part of the same
-
getStandardSupportedCharsets
public List<Charset> getStandardSupportedCharsets()
- Specified by:
getStandardSupportedCharsetsin interfaceIWorkflowProvider- Returns:
- A list of all character sets normally supported by FORMCYCLE.
-
getTextTemplateSelectItemsByCategory
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> getTextTemplateSelectItemsByCategory(ETextbausteinKategorie category)
- Specified by:
getTextTemplateSelectItemsByCategoryin interfaceIWorkflowProvider- Parameters:
category- The template category for which to return the available templates.- Returns:
- Same as
IWorkflowProvider.getTextTemplatesByCategory(ETextbausteinKategorie), but returns select items with the value and the name of the template.
-
getTextTemplatesByCategory
public List<Textbaustein> getTextTemplatesByCategory(ETextbausteinKategorie category)
- Specified by:
getTextTemplatesByCategoryin interfaceIWorkflowProvider- Parameters:
category- The template category for which to return the available templates.- Returns:
- A list of all templates of the given category. Empty list when none are available.
-
getWorkflowVersion
public WorkflowVersion getWorkflowVersion()
- Specified by:
getWorkflowVersionin interfaceIWorkflowProvider- Returns:
- The current version in which the workflow is
-
-