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 ofIWorkflowProviderthat is available during bean validation of the workflow. Bean validation may be triggered in two different ways: via theWorkflowValidatoror 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, seeSingleChoiceorMultiChoice. 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 envData, WorkflowElementIndex elementIndex)Creates a new UI independent workflow provider with the given context. 
- 
Method Summary
All Methods Instance Methods Concrete 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<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<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()List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>>getAllUserSelectItems()List<WebDavAccess>getAllWebDavConnections()List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>>getAllWebDavConnectionsSelectItems()List<? extends de.xima.cmn.validation.spec.IChoiceEntry<ResourceItem>>getAvailableResources(boolean includeForm, boolean includeClient, boolean includeExternal, boolean includeAttachmentSearch, boolean includeUpload, boolean includeProvidingAction, String... extensions)Returns a list of all available resources, which may include client resources, form resources, and external resource URLs.List<? extends de.xima.cmn.validation.spec.IChoiceEntry<ResourceItem>>getAvailableResources(NodeKey currentNodeKey, boolean includeForm, boolean includeClient, boolean includeExternal, boolean includeAttachmentSearch, boolean includeUpload, boolean includeProvidingAction)Returns a list of all available resources, which may include client resources, form resources, and external resource URLs.List<? extends de.xima.cmn.validation.spec.IChoiceEntry<ResourceItem>>getAvailableResources(NodeKey currentNodeKey, boolean includeForm, boolean includeClient, boolean includeExternal, boolean includeAttachmentSearch, boolean includeUpload, boolean includeProvidingAction, String... extensions)Returns a list of all available resources, which may include client resources, form resources, and external resource URLs.MandantgetClient()List<Charset>getInstalledCharsets()List<String>getInstalledFontNames()UUIDgetInvalidEntityUuid()StringgetInvalidEntityUuidString()LocalegetLocale()List<BaseConfigViewModel>getNonOrderableAuthenticatorConfigs()List<BaseConfigViewModel>getOrderableAuthenticatorConfigs()List<INodeWithName>getPredecessors()List<INodeWithName>getPredecessors(NodeKey nodeKey)ProjektgetProject()List<INodeWithName>getProvidingPredecessors()Returns a list of all predecessors of the currently selected node, if it provides files.List<INodeWithName>getProvidingPredecessors(NodeKey nodeKey)Returns a list of all predecessors of the given node that provide files.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 
 - 
 
 - 
 
- 
- 
Constructor Detail
- 
ValidationWorkflowProvider
public ValidationWorkflowProvider(IWorkflowValidationEnvironmentData envData, WorkflowElementIndex elementIndex)
Creates a new UI independent workflow provider with the given context.- Parameters:
 envData- 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:
 getAllAttachmentSourcesin interfaceIWorkflowProvider- Returns:
 - a list of all attachment sources
 
 
- 
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. 
 
- 
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. 
 
- 
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.
 
 
- 
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. 
 
- 
getAllClientResources
public List<MandantRessource> getAllClientResources()
- Specified by:
 getAllClientResourcesin interfaceIWorkflowProvider- Returns:
 - A list of all client resources of the current client.
 
 
- 
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.
 
 
- 
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. 
 
- 
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. 
 
- 
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. 
 
- 
getAllFormElements
public List<String> getAllFormElements()
- Specified by:
 getAllFormElementsin interfaceIWorkflowProvider- Returns:
 - All from elements of the current form version. Empty list if none are found.
 
 
- 
getAllInboxes
public List<Postfach> getAllInboxes()
- Specified by:
 getAllInboxesin interfaceIWorkflowProvider- Returns:
 - All inboxes available to the current client. 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. 
 
- 
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.
 
 
- 
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. 
 
- 
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.- 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.- Returns:
 - Same as 
IWorkflowProvider.getAllNodesOfType(String), but returns select items with the value set to theNodeKeyand the name of the LDAP query. 
 
- 
getAllProjectResources
public List<ProjektRessource> getAllProjectResources()
- Specified by:
 getAllProjectResourcesin interfaceIWorkflowProvider- Returns:
 - A list of all project resource of the current project.
 
 
- 
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.
 
 
- 
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. 
 
- 
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.
 
 
- 
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. 
 
- 
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.
 
 
- 
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. 
 
- 
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.
 
 
- 
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.
 
 
- 
getAllTriggersOfType
public List<ITriggerWithName> getAllTriggersOfType(String type, boolean excludeSelf)
- Specified by:
 getAllTriggersOfTypein interfaceIWorkflowProvider- Parameters:
 type-typeof the triggers to retrieve.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.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.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.taskToExclude- Task to exclude in the result,nullto exclude none.- Returns:
 - All triggers in the current process that are of the given type.
 
 
- 
getAllUploadElements
public List<String> getAllUploadElements()
- Specified by:
 getAllUploadElementsin interfaceIWorkflowProvider- Returns:
 - A list with all upload elements available to the currently selected action.
 
 
- 
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. 
 
- 
getAllUserGroups
public List<BenutzerGruppe> getAllUserGroups()
- Specified by:
 getAllUserGroupsin interfaceIWorkflowProvider- Returns:
 - All user groups available to the current client. Empty list if none are found.
 
 
- 
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. 
 
- 
getAllUsers
public List<Benutzer> getAllUsers()
- Specified by:
 getAllUsersin interfaceIWorkflowProvider- Returns:
 - All users 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:
 getAllUserSelectItemsin interfaceIWorkflowProvider- Returns:
 - Same as 
IWorkflowProvider.getAllUsers(), but returns select items with the value and the name of the user . 
 
- 
getAvailableResources
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<ResourceItem>> getAvailableResources(boolean includeForm, boolean includeClient, boolean includeExternal, boolean includeAttachmentSearch, boolean includeUpload, boolean includeProvidingAction, String... extensions)
Description copied from interface:IWorkflowProviderReturns a list of all available resources, which may include client resources, form resources, and external resource URLs.- Specified by:
 getAvailableResourcesin interfaceIWorkflowProvider- Parameters:
 includeForm- Whether to include the available form resources.includeClient- Whether to include the available client resources.includeExternal- Whether to include an option for entering an external resource URL.includeAttachmentSearch- Specifies whether to include an option to search by file name for a form record attachmentincludeUpload- Specifies whether to add available file upload elements to the result listincludeProvidingAction- Specifies whether to add all available providing-file actionsextensions- A list of extensions for filtering the returned resources. When no extensions are given, no filtering is applied.- Returns:
 - A list of all available resources. Only resources with the given extensions are returned.
 
 
- 
getAvailableResources
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<ResourceItem>> getAvailableResources(NodeKey currentNodeKey, boolean includeForm, boolean includeClient, boolean includeExternal, boolean includeAttachmentSearch, boolean includeUpload, boolean includeProvidingAction)
Description copied from interface:IWorkflowProviderReturns a list of all available resources, which may include client resources, form resources, and external resource URLs.- Specified by:
 getAvailableResourcesin interfaceIWorkflowProvider- Parameters:
 currentNodeKey-NodeKeyof the current selected node.includeForm- Whether to include the available form resources.includeClient- Whether to include the available client resources.includeExternal- Whether to include an option for entering an external resource URL.includeAttachmentSearch- Specifies whether to include an option to search by file name for a form record attachmentincludeUpload- Specifies whether to add available file upload elements to the result listincludeProvidingAction- Specifies whether to add all available providing-file actions- Returns:
 - A list of all available resources (files).
 
 
- 
getAvailableResources
public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<ResourceItem>> getAvailableResources(NodeKey currentNodeKey, boolean includeForm, boolean includeClient, boolean includeExternal, boolean includeAttachmentSearch, boolean includeUpload, boolean includeProvidingAction, String... extensions)
Description copied from interface:IWorkflowProviderReturns a list of all available resources, which may include client resources, form resources, and external resource URLs.- Specified by:
 getAvailableResourcesin interfaceIWorkflowProvider- Parameters:
 currentNodeKey-NodeKeyof the current selected node.includeForm- Whether to include the available form resources.includeClient- Whether to include the available client resources.includeExternal- Whether to include an option for entering an external resource URL.includeAttachmentSearch- Specifies whether to include an option to search by file name for a form record attachmentincludeUpload- Specifies whether to add available file upload elements to the result listincludeProvidingAction- Specifies whether to add all available providing-file actionsextensions- A list of extensions for filtering the returned resources. When no extensions are given, no filtering is applied. When an item of this array contains a comma, it is split into several extension. SogetAvailableResources(nodeKey, true,true,true,true,true,"pdf,docx")is the same asgetAvailableResources(nodeKey, true,true,true,true,true,"pdf", "docx")- Returns:
 - A list of all available resources. Only resources with the given extensions are returned.
 
 
- 
getClient
public Mandant getClient()
- Specified by:
 getClientin interfaceIWorkflowProvider- Returns:
 - The current client for which the workflow is being edited.
 
 
- 
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.
 
 
- 
getOrderableAuthenticatorConfigs
public List<BaseConfigViewModel> getOrderableAuthenticatorConfigs()
- Specified by:
 getOrderableAuthenticatorConfigsin interfaceIWorkflowProvider- Returns:
 - All orderable authenticator configurations that are available to the current project.
 
 
- 
getPredecessors
public List<INodeWithName> getPredecessors()
- 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
public List<INodeWithName> getPredecessors(NodeKey nodeKey)
- Specified by:
 getPredecessorsin interfaceIWorkflowProvider- Parameters:
 nodeKey- 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.
 
 
- 
getProvidingPredecessors
public List<INodeWithName> getProvidingPredecessors()
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
public List<INodeWithName> getProvidingPredecessors(NodeKey nodeKey)
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:
 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 
 
- 
getStandardSupportedCharsets
public List<Charset> getStandardSupportedCharsets()
- Specified by:
 getStandardSupportedCharsetsin interfaceIWorkflowProvider- Returns:
 - A list of all character sets normally supported by FORMCYCLE.
 
 
- 
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.
 
 
- 
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. 
 
- 
getWorkflowVersion
public WorkflowVersion getWorkflowVersion()
- Specified by:
 getWorkflowVersionin interfaceIWorkflowProvider- Returns:
 - The current version in which the workflow is
 
 
 - 
 
 -