Class ValidationWorkflowProvider
- java.lang.Object
-
- de.xima.fc.workflow.processor.logic.validation.ValidationWorkflowProvider
-
- All Implemented Interfaces:
IWorkflowProvider
public class ValidationWorkflowProvider extends Object implements IWorkflowProvider
An implementation ofIWorkflowProvider
that is available during bean validation of the workflow. Bean validation may be triggered in two different ways: via theWorkflowValidator
or via the JSF (or rather OmniFaces') whole bean validator. Some bean constraint validators require access to the workflow context, such as the validators that check whether a valid user group or workflow state was selected, seeSingleChoice
orMultiChoice
. To acquire that access, they are injected with an instance ofIWorkflowProvider
, which is provided by this class.- Since:
- 7.0.0
- Author:
- XIMA MEDIA GmbH
-
-
Constructor Summary
Constructors Constructor Description ValidationWorkflowProvider(IWorkflowValidationEnvironmentData env, WorkflowElementIndex elementIndex)
Creates a new UI independent workflow provider with the given context.
-
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 arerepeated
containers.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()
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 nodeKey)
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 nodeKey)
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 nodeKey)
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.Mandant
getClient()
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 nodeKey)
A list of all nodes that have finished execution and that precede the given node n; i.e.List<Charset>
getInstalledCharsets()
List<String>
getInstalledFontNames()
UUID
getInvalidEntityUuid()
String
getInvalidEntityUuidString()
Locale
getLocale()
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 nodeKey)
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 nodeKey)
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 nodeKey)
Returns a list of all predecessors of the given node N that provide files.List<BaseConfigViewModel>
getOrderableAuthenticatorConfigs()
List<INodeWithName>
getParentControlTransferTargets(NodeKey nodeKey, 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 nodeKey)
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()
Projekt
getProject()
List<IFileProvidingNodeWithName>
getProvidingParents()
Returns a list of all nodes that are parents of the currently selected node n.List<IFileProvidingNodeWithName>
getProvidingParents(NodeKey nodeKey)
Returns a list of all nodes that are parents of the given node and that provides or creates files, seegetFileValueDescriptor
).List<Charset>
getStandardSupportedCharsets()
List<Textbaustein>
getTextTemplatesByCategory(ETextbausteinKategorie category)
List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>>
getTextTemplateSelectItemsByCategory(ETextbausteinKategorie category)
WorkflowVersion
getWorkflowVersion()
-
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, getPredecessors, getProvidingPredecessors, getProvidingPredecessors
-
-
-
-
Constructor Detail
-
ValidationWorkflowProvider
public ValidationWorkflowProvider(IWorkflowValidationEnvironmentData env, WorkflowElementIndex elementIndex)
Creates a new UI independent workflow provider with the given context.- Parameters:
env
- Environment data with the client, project etc.elementIndex
- Element index with the available workflow triggers, workflow nodes etc.
-
-
Method Detail
-
getAllAttachmentSources
public List<EAttachmentSource> getAllAttachmentSources()
- Specified by:
getAllAttachmentSources
in interfaceIWorkflowProvider
- Returns:
- a list of all attachment sources
-
getAllClientCounterRefSelectItems
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<EntityRef>> getAllClientCounterRefSelectItems()
- Specified by:
getAllClientCounterRefSelectItems
in 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:
getAllClientCounterRefs
in 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:
getAllClientCounterSelectItems
in 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:
getAllClientCounters
in 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:
getAllClientResources
in 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:
getAllDatabaseConnectionSelectItems
in 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:
getAllDatabaseConnections
in 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:
getAllDatabaseQueries
in 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:
getAllDatabaseQuerySelectItems
in 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:
getAllDirectClientAuthorizationSelectItems
in 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:
getAllDirectClientAuthorizations
in interfaceIWorkflowProvider
- Returns:
- All direct client authorizations available to the current client. Empty list if none are found.
-
getAllFormElements
public List<String> getAllFormElements()
- Specified by:
getAllFormElements
in interfaceIWorkflowProvider
- Returns:
- All
valuable
form 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:
getAllInboxSelectItems
in 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:
getAllInboxes
in 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:
getAllLdapConnectionSelectItems
in 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:
getAllLdapConnections
in 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:
getAllLdapQueries
in 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:
getAllLdapQuerySelectItems
in 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:
getAllNodesOfType
in interfaceIWorkflowProvider
- Parameters:
type
-type
of 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:
getAllNodesOfTypeSelectItems
in interfaceIWorkflowProvider
- Parameters:
type
-type
of 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 theNodeKey
and the name to the name of the node.
-
getAllProjectResources
public List<ProjektRessource> getAllProjectResources()
- Specified by:
getAllProjectResources
in 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:
getAllQualifiedSubmitButtonSelectItems
in 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:
getAllQualifiedSubmitButtons
in 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:IWorkflowProvider
Gets all form elements of the current form version that arerepeated
containers. This does not include form element inside repeated containers, useIWorkflowProvider.getAllRepeatedFormElements()
for that.- Specified by:
getAllRepeatedFormElementContainers
in interfaceIWorkflowProvider
- Returns:
- All repetition containers.
-
getAllRepeatedFormElements
public List<String> getAllRepeatedFormElements()
Description copied from interface:IWorkflowProvider
Gets all form elements of the current form version that are eitherrepeated
container; or avaluable
and either themselves repeated or are inside a repeated container.- Specified by:
getAllRepeatedFormElements
in 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:
getAllStateSelectItems
in interfaceIWorkflowProvider
- Parameters:
includeMarkedForDeletion
-true
to include states that have been marked for deletion when the workflow is saved,false
to 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:
getAllStates
in interfaceIWorkflowProvider
- Parameters:
includeMarkedForDeletion
-true
to include states that have been marked for deletion when the workflow is saved,false
to 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:
getAllSubmitButtonSelectItems
in 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:
getAllSubmitButtons
in 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:IWorkflowProvider
Same asIWorkflowProvider.getAllTriggersOfType(String, UUID)
, but converted to select items with the trigger key as the value.- Specified by:
getAllTaskSelectItems
in interfaceIWorkflowProvider
- Parameters:
excludeSelf
-true
to exclude the task of the current trigger,true
to 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:IWorkflowProvider
Same asIWorkflowProvider.getAllTasks(UUID)
, but converted to select items with the task key as the value.- Specified by:
getAllTaskSelectItems
in interfaceIWorkflowProvider
- Parameters:
taskToExclude
- Task to exclude in the result,null
to 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:
getAllTasks
in interfaceIWorkflowProvider
- Parameters:
excludeSelf
-true
to exclude the task of the current trigger,true
to 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:
getAllTasks
in interfaceIWorkflowProvider
- Parameters:
taskToExclude
- Task to exclude in the result,null
to 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:
getAllTriggersOfType
in interfaceIWorkflowProvider
- Parameters:
type
-type
of the triggers to retrieve. Can be empty to retrieve all triggers.excludeSelf
-true
to exclude the task of the current trigger,true
to 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:
getAllTriggersOfType
in interfaceIWorkflowProvider
- Parameters:
type
-type
of the triggers to retrieve. Can be empty to retrieve all triggers.taskToExclude
- Task to exclude in the result,null
to 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:IWorkflowProvider
Same asIWorkflowProvider.getAllTriggersOfType(String, boolean)
, but converted to select items with the trigger key as the value.- Specified by:
getAllTriggersOfTypeSelectItems
in interfaceIWorkflowProvider
- Parameters:
type
-type
of the triggers to retrieve. Can be empty to retrieve all triggers.excludeSelf
-true
to exclude the task of the current trigger,true
to 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:IWorkflowProvider
Same asIWorkflowProvider.getAllTriggersOfType(String, UUID)
, but converted to select items with the trigger key as the value.- Specified by:
getAllTriggersOfTypeSelectItems
in interfaceIWorkflowProvider
- Parameters:
type
-type
of the triggers to retrieve. Can be empty to retrieve all triggers.taskToExclude
- Task to exclude in the result,null
to 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:
getAllUploadElementSelectItems
in 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:
getAllUploadElements
in 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:
getAllUserGroupSelectItems
in 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:
getAllUserGroups
in interfaceIWorkflowProvider
- Returns:
- All user groups available to the current client. Empty list if none are found.
-
getAllUserSelectItems
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> getAllUserSelectItems()
- Specified by:
getAllUserSelectItems
in 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:
getAllUsers
in interfaceIWorkflowProvider
- Returns:
- All users available to the current client. Empty list if none are found.
-
getAllWebDavConnections
public List<WebDavAccess> getAllWebDavConnections()
- Specified by:
getAllWebDavConnections
in 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:
getAllWebDavConnectionsSelectItems
in 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()
Description copied from interface:IWorkflowProvider
Returns 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
getNormalCompletionProvidingPredecessors
and specify the node directly.- Specified by:
getAssignedProvidingTriggers
in interfaceIWorkflowProvider
- Returns:
- A list of all triggers that control the execution of the processing chain with the given node.
-
getAssignedProvidingTriggers
public List<IFileProvidingTriggerWithName> getAssignedProvidingTriggers(NodeKey nodeKey)
Description copied from interface:IWorkflowProvider
Returns 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:
getAssignedProvidingTriggers
in interfaceIWorkflowProvider
- Parameters:
nodeKey
- Key of the node to process.- 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:IWorkflowProvider
Returns 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
getNormalCompletionProvidingPredecessors
and specify the node directly.- Specified by:
getAssignedTriggers
in 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 nodeKey)
Description copied from interface:IWorkflowProvider
Returns 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:
getAssignedTriggers
in interfaceIWorkflowProvider
- Parameters:
nodeKey
- 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:IWorkflowProvider
Returns 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:
getAttachmentProvidingParents
in 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 nodeKey)
Description copied from interface:IWorkflowProvider
Returns 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:
getAttachmentProvidingParents
in interfaceIWorkflowProvider
- Parameters:
nodeKey
- 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:IWorkflowProvider
Returns a list of all available attachment items that are available for the currently selected workflow node.- Specified by:
getAvailableAttachments
in 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:IWorkflowProvider
Returns a list of all available attachment items that are available for the given workflow node.- Specified by:
getAvailableAttachments
in interfaceIWorkflowProvider
- Parameters:
currentNodeKey
-NodeKey
of 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:
getAvailableResources
in interfaceIWorkflowProvider
-
getAvailableResources
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<ResourceItem>> getAvailableResources(NodeKey currentNodeKey, GetAvailableResourcesParams params)
Description copied from interface:IWorkflowProvider
Returns a list of all available resources, which may include client resources, form resources, and external resource URLs, etc.- Specified by:
getAvailableResources
in interfaceIWorkflowProvider
- Parameters:
currentNodeKey
-NodeKey
of 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:
getClient
in interfaceIWorkflowProvider
- Returns:
- The current client for which the workflow is being edited.
-
getErrorCompletionPredecessors
public List<INodeWithName> getErrorCompletionPredecessors()
Description copied from interface:IWorkflowProvider
A 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 includebackwards
edges 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:
getErrorCompletionPredecessors
in interfaceIWorkflowProvider
- Returns:
- A list of all nodes that have finished execution and that precede the currently selected node.
-
getErrorCompletionPredecessors
public List<INodeWithName> getErrorCompletionPredecessors(NodeKey nodeKey)
Description copied from interface:IWorkflowProvider
A 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 includebackwards
edges and starts with athrowing edge
.- Specified by:
getErrorCompletionPredecessors
in interfaceIWorkflowProvider
- Parameters:
nodeKey
- 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:
getInstalledCharsets
in interfaceIWorkflowProvider
- Returns:
- A list of all character supported by the server.
-
getInstalledFontNames
public List<String> getInstalledFontNames()
- Specified by:
getInstalledFontNames
in interfaceIWorkflowProvider
- Returns:
- A list of all font names that are currently installed on the system.
-
getInvalidEntityUuid
public UUID getInvalidEntityUuid()
- Specified by:
getInvalidEntityUuid
in interfaceIWorkflowProvider
- Returns:
- The UUID that is considered invalid. May be used as a default or no select option.
-
getInvalidEntityUuidString
public String getInvalidEntityUuidString()
- Specified by:
getInvalidEntityUuidString
in interfaceIWorkflowProvider
- Returns:
- The UUID that is considered invalid. May be used as a default or no select option.
-
getLocale
public Locale getLocale()
- Specified by:
getLocale
in interfaceIWorkflowProvider
- Returns:
- The current locale that is to be used for locale-sensitive operations.
-
getNonOrderableAuthenticatorConfigs
public List<BaseConfigViewModel> getNonOrderableAuthenticatorConfigs()
- Specified by:
getNonOrderableAuthenticatorConfigs
in interfaceIWorkflowProvider
- Returns:
- All non-orderable authenticator configurations that are available to the current project.
-
getNormalCompletionAttachmentProvidingPredecessors
public List<INodeWithName> getNormalCompletionAttachmentProvidingPredecessors()
Description copied from interface:IWorkflowProvider
Returns 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
WorkflowTask
as 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
getPotentialPredecessorsOf
via a path that does not include backwards edges and starts with anormal
edge. - the node X provides or creates attachments, see
getAttachmentValueDescriptor
)
getNormalCompletionProvidingPredecessors
and specify the node directly.- Specified by:
getNormalCompletionAttachmentProvidingPredecessors
in 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 nodeKey)
Description copied from interface:IWorkflowProvider
Returns 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
WorkflowTask
as 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
getPotentialPredecessorsOf
via a path that does not include backwards edges and starts with anormal
edge. - the node X provides or creates attachments, see
getAttachmentValueDescriptor
)
- Specified by:
getNormalCompletionAttachmentProvidingPredecessors
in 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:IWorkflowProvider
A 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 includebackwards
edges and starts with anormal edge
.This method is available only when the workflow designer UI is opened. Use
getNormalCompletionPredecessors
and specify the node directly.- Specified by:
getNormalCompletionPredecessors
in interfaceIWorkflowProvider
- Returns:
- A list of all nodes that have finished execution and that precede the currently selected node.
-
getNormalCompletionPredecessors
public List<INodeWithName> getNormalCompletionPredecessors(NodeKey nodeKey)
Description copied from interface:IWorkflowProvider
A 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 includebackwards
edges and starts with anormal edge
.- Specified by:
getNormalCompletionPredecessors
in interfaceIWorkflowProvider
- Parameters:
nodeKey
- 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:IWorkflowProvider
Returns 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
WorkflowTask
as 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
getPotentialPredecessorsOf
via a path that does not includebackwards
edges and starts with anormal
edge. - the node X provides or creates files, see
getFileValueDescriptor
)
getNormalCompletionProvidingPredecessors
and specify the node directly.- Specified by:
getNormalCompletionProvidingPredecessors
in 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 nodeKey)
Description copied from interface:IWorkflowProvider
Returns 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
WorkflowTask
as 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 includebackwards
edges and starts with anormal
edge. - the node X provides or creates files, see
getFileValueDescriptor
)
- Specified by:
getNormalCompletionProvidingPredecessors
in interfaceIWorkflowProvider
- Parameters:
nodeKey
- 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:
getOrderableAuthenticatorConfigs
in interfaceIWorkflowProvider
- Returns:
- All orderable authenticator configurations that are available to the current project.
-
getParentControlTransferTargets
public List<INodeWithName> getParentControlTransferTargets(NodeKey nodeKey, String... controlTransferTypes)
- Specified by:
getParentControlTransferTargets
in interfaceIWorkflowProvider
- Parameters:
nodeKey
- 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:
getParentControlTransferTargets
in 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:
getParentControlTransferTargetsSelectItems
in 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 theNodeKey
and the name to the name of the node.
-
getParentControlTransferTargetsSelectItems
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<NodeKey>> getParentControlTransferTargetsSelectItems(String... controlTransferTypes)
- Specified by:
getParentControlTransferTargetsSelectItems
in 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 theNodeKey
and the name to the name of the node.
-
getParents
public List<INodeWithName> getParents()
- Specified by:
getParents
in 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 nodeKey)
- Specified by:
getParents
in interfaceIWorkflowProvider
- Parameters:
nodeKey
- 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:
getParentsSelectItems
in interfaceIWorkflowProvider
- Returns:
- Same as
IWorkflowProvider.getParents()
, but returns select items with the value set to theNodeKey
and the name to the name of the node.
-
getParentsSelectItems
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<NodeKey>> getParentsSelectItems(NodeKey key)
- Specified by:
getParentsSelectItems
in 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 theNodeKey
and the name to the name of the node.
-
getPredecessors
public List<INodeWithName> getPredecessors()
- Specified by:
getPredecessors
in 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.
-
getProject
public Projekt getProject()
- Specified by:
getProject
in interfaceIWorkflowProvider
- Returns:
- The current project for which the workflow is being edited.
-
getProvidingParents
public List<IFileProvidingNodeWithName> getProvidingParents()
Description copied from interface:IWorkflowProvider
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. UseIWorkflowProvider.getParents(NodeKey)
and specify the node directly. Parent nodes such as loops may provide files during their execution.- Specified by:
getProvidingParents
in 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 nodeKey)
Description copied from interface:IWorkflowProvider
Returns 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:
getProvidingParents
in interfaceIWorkflowProvider
- Parameters:
nodeKey
- Key of the node to check.- Returns:
- A list of all workflow nodes that are a parent of the given node and provide files.
-
getStandardSupportedCharsets
public List<Charset> getStandardSupportedCharsets()
- Specified by:
getStandardSupportedCharsets
in 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:
getTextTemplateSelectItemsByCategory
in 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:
getTextTemplatesByCategory
in 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:
getWorkflowVersion
in interfaceIWorkflowProvider
- Returns:
- The current version in which the workflow is
-
-