Package de.xima.fc.interfaces.workflow

Interface IWorkflowProvider

All Known Implementing Classes:
ValidationWorkflowProvider, WorkflowProviderBean
public interface IWorkflowProvider
A provider for the workflow designer that lets you access various data related to the workflow, such a list of all user groups or text templates.
Since:
7.0.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • getAllAttachmentSources

      List<EAttachmentSource> getAllAttachmentSources()
      Returns:
      a list of all attachment sources

    • getAllClientCounterRefs

      List<EntityRef> getAllClientCounterRefs()
      Returns:
      Similar to getAllClientCounters(), but includes a EntityRef.forNameValue(String) entry that lets the user enter a counter by its name.

    • getAllClientCounterRefSelectItems

      List<? extends de.xima.cmn.validation.spec.IChoiceEntry<EntityRef>> getAllClientCounterRefSelectItems()
      Returns:
      Similar to getAllClientCounterSelectItems(), but includes a EntityRef.forNameValue(String) entry that lets the user enter a counter by its name.

    • getAllClientCounters

      List<ClientCounter> getAllClientCounters()
      Returns:
      A list of all client counters available to the current client. Empty list if none are found.

    • getAllClientCounterSelectItems

      List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> getAllClientCounterSelectItems()
      Returns:
      Same as getAllClientCounters(), but returns select items with the value and the name of the LDAP query.

    • getAllClientResources

      List<MandantRessource> getAllClientResources()
      Returns:
      A list of all client resources of the current client.

    • getAllDatabaseConnections

      List<DatenbankZugriff> getAllDatabaseConnections()
      Returns:
      A list of all database connection available to the current client. Empty list if none are found.

    • getAllDatabaseConnectionSelectItems

      List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> getAllDatabaseConnectionSelectItems()
      Returns:
      Same as getAllDatabaseConnections(), but returns select items with the value and the name of the database connection.

    • getAllDatabaseQueries

      List<Datenquelle> getAllDatabaseQueries()
      Returns:
      A list of all database queries that are defined in client scope. Empty list when none are available.

    • getAllDatabaseQuerySelectItems

      List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> getAllDatabaseQuerySelectItems()
      Returns:
      Same as getAllDatabaseQueries(), but returns select items with the value and the name of the database query.

    • getAllDirectClientAuthorizations

      List<DirectClientAuthorization> getAllDirectClientAuthorizations()
      Returns:
      All direct client authorizations available to the current client. Empty list if none are found.
      Since:
      8.0.0

    • getAllDirectClientAuthorizationSelectItems

      List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> getAllDirectClientAuthorizationSelectItems()
      Returns:
      Same as getAllDirectClientAuthorizations(), but returns select items with the value and the name of the user.
      Since:
      8.0.0

    • getAllFormElements

      List<String> getAllFormElements()
      Returns:
      All from elements of the current form version. Empty list if none are found.

    • getAllInboxes

      List<Postfach> getAllInboxes()
      Returns:
      All inboxes available to the current client. Empty list if none are found.

    • getAllInboxSelectItems

      List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> getAllInboxSelectItems()
      Returns:
      Same as getAllInboxes(), but returns select items with the value and the name of the inbox.

    • getAllLdapConnections

      List<LDAPZugriff> getAllLdapConnections()
      Returns:
      A list of all LDAP queries available to the current client. Empty list if none are found.

    • getAllLdapConnectionSelectItems

      List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> getAllLdapConnectionSelectItems()
      Returns:
      Same as getAllLdapConnections(), but returns select items with the value and the name of the LDAP connection.

    • getAllLdapQueries

      List<LDAPAbfrage> getAllLdapQueries()
      Returns:
      A list of all LDAP queries available to the current client. Empty list if none are found.

    • getAllLdapQuerySelectItems

      List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> getAllLdapQuerySelectItems()
      Returns:
      Same as getAllLdapQueries(), but returns select items with the value and the name of the LDAP query.

    • getAllNodesOfType

      List<INodeWithName> getAllNodesOfType(String type)
      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

      List<? extends de.xima.cmn.validation.spec.IChoiceEntry<NodeKey>> getAllNodesOfTypeSelectItems(String type)
      Parameters:
      type - type of the nodes to retrieve. Can be empty to retrieve all nodes.
      Returns:
      Same as getAllNodesOfType(String), but returns select items with the value set to the NodeKey and the name of the LDAP query.

    • getAllProjectResources

      List<ProjektRessource> getAllProjectResources()
      Returns:
      A list of all project resource of the current project.

    • getAllQualifiedSubmitButtons

      List<IWorkflowQualifiedSubmitButton> getAllQualifiedSubmitButtons()
      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

      List<? extends de.xima.cmn.validation.spec.IChoiceEntry<QualifiedSubmitButton>> getAllQualifiedSubmitButtonSelectItems()
      Returns:
      Same as getAllSubmitButtons(), but converted to select items with the button name as the value.

    • getAllStates

      List<WorkflowStateModel> getAllStates(boolean includeMarkedForDeletion)
      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.

    • getAllStateSelectItems

      List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> getAllStateSelectItems(boolean includeMarkedForDeletion)
      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 getAllStates(boolean), but returns select items with the value and the name of the state.

    • getAllSubmitButtons

      List<IWorkflowSubmitButton> getAllSubmitButtons()
      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

      List<? extends de.xima.cmn.validation.spec.IChoiceEntry<String>> getAllSubmitButtonSelectItems()
      Returns:
      Same as getAllSubmitButtons(), but converted to select items with the button name as the value.

    • getAllTasks

      List<ITaskWithName> getAllTasks(boolean excludeSelf)
      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

      List<ITaskWithName> getAllTasks(UUID taskToExclude)
      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.

    • getAllTaskSelectItems

      List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UUID>> getAllTaskSelectItems(boolean excludeSelf)
      Same as getAllTriggersOfType(String, UUID), but converted to select items with the trigger key as the value.
      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

      List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UUID>> getAllTaskSelectItems(UUID taskToExclude)
      Same as getAllTasks(UUID), but converted to select items with the task key as the value.
      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

      List<ITriggerWithName> getAllTriggersOfType(String type, boolean excludeSelf)
      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

      List<ITriggerWithName> getAllTriggersOfType(String type, UUID taskToExclude)
      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

      List<? extends de.xima.cmn.validation.spec.IChoiceEntry<TriggerKey>> getAllTriggersOfTypeSelectItems(String type, boolean excludeSelf)
      Same as getAllTriggersOfType(String, boolean), but converted to select items with the trigger key as the value.
      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

      List<? extends de.xima.cmn.validation.spec.IChoiceEntry<TriggerKey>> getAllTriggersOfTypeSelectItems(String type, UUID taskToExclude)
      Same as getAllTriggersOfType(String, UUID), but converted to select items with the trigger key as the value.
      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.

    • getAllUploadElements

      List<String> getAllUploadElements()
      Returns:
      A list with all upload elements available to the currently selected action.

    • getAllUploadElementSelectItems

      List<? extends de.xima.cmn.validation.spec.IChoiceEntry<String>> getAllUploadElementSelectItems()
      Returns:
      Same as getAllUploadElements(), but converted to select items with the field name as the value.

    • getAllUserGroups

      List<BenutzerGruppe> getAllUserGroups()
      Returns:
      All user groups available to the current client. Empty list if none are found.

    • getAllUserGroupSelectItems

      List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> getAllUserGroupSelectItems()
      Returns:
      Same as getAllUserGroups(), but returns select items with the value and the name of the user group.

    • getAllWebDavConnections

      List<WebDavAccess> getAllWebDavConnections()
      Returns:
      A list of all WebDAV connections available to the current client. Empty list if none are found.

    • getAllWebDavConnectionsSelectItems

      List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> getAllWebDavConnectionsSelectItems()
      Returns:
      Same as getAllWebDavConnections(), but returns select items with the value and the name of the database connection.

    • getAvailableAttachments

      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.
      Parameters:
      params - Parameters for retrieving the available attachments. When null, uses GetAvailableAttachmentsParams.defaults().
      Returns:
      A list of all attachment items available for the given node.
      Since:
      8.1.0
      See Also:

    • getAvailableAttachments

      List<? extends de.xima.cmn.validation.spec.IChoiceEntry<AttachmentItem>> getAvailableAttachments(NodeKey nodeKey, GetAvailableAttachmentsParams params)
      Returns a list of all available attachment items that are available for the given workflow node.
      Parameters:
      nodeKey - NodeKey of the currently selected node.
      params - Parameters for retrieving the available attachments. When null, uses GetAvailableAttachmentsParams.defaults().
      Returns:
      A list of all attachment items available for the given node.
      Since:
      8.1.0

    • getAvailableResources

      default List<? extends de.xima.cmn.validation.spec.IChoiceEntry<ResourceItem>> getAvailableResources(boolean includeForm, boolean includeClient, boolean includeExternal, boolean includeAttachmentSearch, boolean includeUpload, boolean includeProvidingAction, List<String> extensions)
      Returns a list of all available resources, which may include client resources, form resources, and external resource URLs.
      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 attachment
      includeUpload - Specifies whether to add available file upload elements to the result list
      includeProvidingAction - Specifies whether to add all available providing-file actions
      extensions - 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. On@Override ly resources with the given extensions are returned.

    • getAvailableResources

      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.
      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 attachment
      includeUpload - Specifies whether to add available file upload elements to the result list
      includeProvidingAction - Specifies whether to add all available providing-file actions
      extensions - 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

      List<? extends de.xima.cmn.validation.spec.IChoiceEntry<ResourceItem>> getAvailableResources(@Nullable NodeKey nodeKey, 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.
      Parameters:
      nodeKey - NodeKey of 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 attachment
      includeUpload - Specifies whether to add available file upload elements to the result list
      includeProvidingAction - Specifies whether to add all available providing-file actions
      Returns:
      A list of all available resources (files).

    • getAvailableResources

      List<? extends de.xima.cmn.validation.spec.IChoiceEntry<ResourceItem>> getAvailableResources(@Nullable NodeKey nodeKey, 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.
      Parameters:
      nodeKey - NodeKey of 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 attachment
      includeUpload - Specifies whether to add available file upload elements to the result list
      includeProvidingAction - Specifies whether to add all available providing-file actions
      extensions - 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. So getAvailableResources(nodeKey, true,true,true,true,true,"pdf,docx") is the same as getAvailableResources(nodeKey, true,true,true,true,true,"pdf", "docx")
      Returns:
      A list of all available resources. Only resources with the given extensions are returned.

    • getClient

      Mandant getClient()
      Returns:
      The current client for which the workflow is being edited.

    • getInstalledCharsets

      List<Charset> getInstalledCharsets()
      Returns:
      A list of all character supported by the server.

    • getInstalledFontNames

      List<String> getInstalledFontNames()
      Returns:
      A list of all font names that are currently installed on the system.

    • getInvalidEntityUuid

      UUID getInvalidEntityUuid()
      Returns:
      The UUID that is considered invalid. May be used as a default or no select option.

    • getInvalidEntityUuidString

      String getInvalidEntityUuidString()
      Returns:
      The UUID that is considered invalid. May be used as a default or no select option.

    • getLocale

      Locale getLocale()
      Returns:
      The current locale that is to be used for locale-sensitive operations.

    • getNonOrderableAuthenticatorConfigs

      List<BaseConfigViewModel> getNonOrderableAuthenticatorConfigs()
      Returns:
      All non-orderable authenticator configurations that are available to the current project.

    • getNormalCompletionPredecessors

      List<INodeWithName> getNormalCompletionPredecessors()
      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 getPredecessors(NodeKey) and specify the node directly.
      Since:
      8.0.0

    • getNormalCompletionPredecessors

      List<INodeWithName> getNormalCompletionPredecessors(NodeKey key)
      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.
      Since:
      8.0.0

    • getNormalCompletionProvidingPredecessors

      List<INodeWithName> getNormalCompletionProvidingPredecessors()
      Returns a list of all predecessors of the currently selected node, if it provides files. Specifically, return all workflow nodes X with the following properties:
      Returns:
      A list of all workflow nodes that can provide files to the currently selected node.
      Since:
      8.0.0

    • getNormalCompletionProvidingPredecessors

      List<INodeWithName> getNormalCompletionProvidingPredecessors(NodeKey key)
      Returns a list of all predecessors of the given node that provide files. Specifically, return all workflow nodes X with the following properties:
      Parameters:
      key - Key of the node to check.
      Returns:
      A list of all workflow nodes that can provide files to the given node.
      Since:
      8.0.0

    • getNormalCompletionAttachmentProvidingPredecessors

      List<INodeWithName> getNormalCompletionAttachmentProvidingPredecessors()
      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 a normal edge.
      • the node X provides or creates attachments, see getAttachmentValueDescriptor)
      This method is available only when a node is currently selected, e.g. when the workflow designer UI is opened. Otherwise, use getNormalCompletionProvidingPredecessors and specify the node directly.
      Returns:
      A list of all workflow nodes that can provide files to the currently selected node.
      Since:
      8.1.0

    • getNormalCompletionAttachmentProvidingPredecessors

      List<INodeWithName> getNormalCompletionAttachmentProvidingPredecessors(NodeKey key)
      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 a normal edge.
      • the node X provides or creates attachments, see getAttachmentValueDescriptor)
      Returns:
      A list of all workflow nodes that can provide files to the given node.
      Since:
      8.1.0

    • getOrderableAuthenticatorConfigs

      List<BaseConfigViewModel> getOrderableAuthenticatorConfigs()
      Returns:
      All orderable authenticator configurations that are available to the current project.

    • getProject

      Projekt getProject()
      Returns:
      The current project for which the workflow is being edited.

    • getStandardSupportedCharsets

      List<Charset> getStandardSupportedCharsets()
      Returns:
      A list of all character sets normally supported by formcycle.

    • getTextTemplatesByCategory

      List<Textbaustein> getTextTemplatesByCategory(ETextbausteinKategorie category)
      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

      List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> getTextTemplateSelectItemsByCategory(ETextbausteinKategorie category)
      Parameters:
      category - The template category for which to return the available templates.
      Returns:
      Same as getTextTemplatesByCategory(ETextbausteinKategorie), but returns select items with the value and the name of the template.

    • getWorkflowVersion

      WorkflowVersion getWorkflowVersion()
      Returns:
      The current version in which the workflow is

    • getAllUsers

      @Deprecated List<Benutzer> getAllUsers()
      Deprecated.
      Use getAllDirectClientAuthorizations().
      Returns:
      All users available to the current client. Empty list if none are found.

    • getAllUserSelectItems

      @Deprecated List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> getAllUserSelectItems()
      Deprecated.
      Use getAllDirectClientAuthorizationSelectItems().
      Returns:
      Same as getAllUsers(), but returns select items with the value and the name of the user .

    • getPredecessors

      @Deprecated default List<INodeWithName> getPredecessors()
      Deprecated.
      Use getNormalCompletionPredecessors().
      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 getPredecessors(NodeKey) and specify the node directly.

    • getPredecessors

      @Deprecated default List<INodeWithName> getPredecessors(NodeKey key)
      Deprecated.
      Use getNormalCompletionPredecessors(NodeKey).
      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.

    • getProvidingPredecessors

      @Deprecated default List<INodeWithName> getProvidingPredecessors()
      Deprecated.
      Use getNormalCompletionProvidingPredecessors().
      Returns a list of all predecessors of the currently selected node, if it provides files. Specifically, return all workflow nodes X with the following properties:
      Returns:
      A list of all workflow nodes that can provide files to the currently selected node.

    • getProvidingPredecessors

      @Deprecated default List<INodeWithName> getProvidingPredecessors(NodeKey key)
      Deprecated.
      Use getNormalCompletionProvidingPredecessors(NodeKey).
      Returns a list of all predecessors of the given node that provide files. Specifically, return all workflow nodes X with the following properties:
      Parameters:
      key - Key of the node to check.
      Returns:
      A list of all workflow nodes that can provide files to the given node.