Package de.xima.fc.workflow.processor.logic.validation

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 of IWorkflowProvider that is available during bean validation of the workflow. Bean validation may be triggered in two different ways: via the WorkflowValidator 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, see SingleChoice or MultiChoice. To acquire that access, they are injected with an instance of IWorkflowProvider, 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

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<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 as IWorkflowProvider.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 as IWorkflowProvider.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 as IWorkflowProvider.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 as IWorkflowProvider.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<? 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(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.
Mandant	getClient()
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()
List<INodeWithName>	getNormalCompletionPredecessors(NodeKey nodeKey)
List<INodeWithName>	getNormalCompletionProvidingPredecessors()	Returns a list of all predecessors of the currently selected node, if it provides files.
List<INodeWithName>	getNormalCompletionProvidingPredecessors(NodeKey nodeKey)	Returns a list of all predecessors of the given node that provide files.
List<BaseConfigViewModel>	getOrderableAuthenticatorConfigs()
List<INodeWithName>	getPredecessors()
Projekt	getProject()
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, getPredecessors, getProvidingPredecessors, getProvidingPredecessors

Constructor Details

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 Details

getAllAttachmentSources

public List<EAttachmentSource> getAllAttachmentSources()

Specified by:

getAllAttachmentSources in interface IWorkflowProvider

Returns:

a list of all attachment sources

getAllClientCounterRefs

public List<EntityRef> getAllClientCounterRefs()

Specified by:

getAllClientCounterRefs in interface IWorkflowProvider

Returns:

Similar to IWorkflowProvider.getAllClientCounters(), but includes a EntityRef.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:

getAllClientCounterRefSelectItems in interface IWorkflowProvider

Returns:

Similar to IWorkflowProvider.getAllClientCounterSelectItems(), but includes a EntityRef.forNameValue(String) entry that lets the user enter a counter by its name.

getAllClientCounters

public List<ClientCounter> getAllClientCounters()

Specified by:

getAllClientCounters in interface IWorkflowProvider

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:

getAllClientCounterSelectItems in interface IWorkflowProvider

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:

getAllClientResources in interface IWorkflowProvider

Returns:

A list of all client resources of the current client.

getAllDatabaseConnections

public List<DatenbankZugriff> getAllDatabaseConnections()

Specified by:

getAllDatabaseConnections in interface IWorkflowProvider

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:

getAllDatabaseConnectionSelectItems in interface IWorkflowProvider

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:

getAllDatabaseQueries in interface IWorkflowProvider

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 interface IWorkflowProvider

Returns:

Same as IWorkflowProvider.getAllDatabaseQueries(), but returns select items with the value and the name of the database query.

getAllDirectClientAuthorizations

public List<DirectClientAuthorization> getAllDirectClientAuthorizations()

Specified by:

getAllDirectClientAuthorizations in interface IWorkflowProvider

Returns:

All direct client authorizations available to the current client. Empty list if none are found.

getAllDirectClientAuthorizationSelectItems

public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> getAllDirectClientAuthorizationSelectItems()

Specified by:

getAllDirectClientAuthorizationSelectItems in interface IWorkflowProvider

Returns:

Same as IWorkflowProvider.getAllDirectClientAuthorizations(), but returns select items with the value and the name of the user.

getAllFormElements

public List<String> getAllFormElements()

Specified by:

getAllFormElements in interface IWorkflowProvider

Returns:

All from elements of the current form version. Empty list if none are found.

getAllInboxes

public List<Postfach> getAllInboxes()

Specified by:

getAllInboxes in interface IWorkflowProvider

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:

getAllInboxSelectItems in interface IWorkflowProvider

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:

getAllLdapConnections in interface IWorkflowProvider

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:

getAllLdapConnectionSelectItems in interface IWorkflowProvider

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:

getAllLdapQueries in interface IWorkflowProvider

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 interface IWorkflowProvider

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 interface IWorkflowProvider

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 interface IWorkflowProvider

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 the NodeKey and the name of the LDAP query.

getAllProjectResources

public List<ProjektRessource> getAllProjectResources()

Specified by:

getAllProjectResources in interface IWorkflowProvider

Returns:

A list of all project resource of the current project.

getAllQualifiedSubmitButtons

public List<IWorkflowQualifiedSubmitButton> getAllQualifiedSubmitButtons()

Specified by:

getAllQualifiedSubmitButtons in interface IWorkflowProvider

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:

getAllQualifiedSubmitButtonSelectItems in interface IWorkflowProvider

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:

getAllStates in interface IWorkflowProvider

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

public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UuidEntityRef>> getAllStateSelectItems(boolean includeMarkedForDeletion)

Specified by:

getAllStateSelectItems in interface IWorkflowProvider

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.

getAllSubmitButtons

public List<IWorkflowSubmitButton> getAllSubmitButtons()

Specified by:

getAllSubmitButtons in interface IWorkflowProvider

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:

getAllSubmitButtonSelectItems in interface IWorkflowProvider

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:

getAllTasks in interface IWorkflowProvider

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 interface IWorkflowProvider

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

public List<? extends de.xima.cmn.validation.spec.IChoiceEntry<UUID>> getAllTaskSelectItems(boolean excludeSelf)

Description copied from interface: IWorkflowProvider

Same as IWorkflowProvider.getAllTriggersOfType(String, UUID), but converted to select items with the trigger key as the value.

Specified by:

getAllTaskSelectItems in interface IWorkflowProvider

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 as IWorkflowProvider.getAllTasks(UUID), but converted to select items with the task key as the value.

Specified by:

getAllTaskSelectItems in interface IWorkflowProvider

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 interface IWorkflowProvider

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 interface IWorkflowProvider

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 as IWorkflowProvider.getAllTriggersOfType(String, boolean), but converted to select items with the trigger key as the value.

Specified by:

getAllTriggersOfTypeSelectItems in interface IWorkflowProvider

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 as IWorkflowProvider.getAllTriggersOfType(String, UUID), but converted to select items with the trigger key as the value.

Specified by:

getAllTriggersOfTypeSelectItems in interface IWorkflowProvider

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

public List<String> getAllUploadElements()

Specified by:

getAllUploadElements in interface IWorkflowProvider

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:

getAllUploadElementSelectItems in interface IWorkflowProvider

Returns:

Same as IWorkflowProvider.getAllUploadElements(), but converted to select items with the field name as the value.

getAllUserGroups

public List<BenutzerGruppe> getAllUserGroups()

Specified by:

getAllUserGroups in interface IWorkflowProvider

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:

getAllUserGroupSelectItems in interface IWorkflowProvider

Returns:

Same as IWorkflowProvider.getAllUserGroups(), but returns select items with the value and the name of the user group.

getAllUsers

@Deprecated
public List<Benutzer> getAllUsers()

Deprecated.

Specified by:

getAllUsers in interface IWorkflowProvider

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:

getAllUserSelectItems in interface IWorkflowProvider

Returns:

Same as IWorkflowProvider.getAllUsers(), but returns select items with the value and the name of the user .

getAllWebDavConnections

public List<WebDavAccess> getAllWebDavConnections()

Specified by:

getAllWebDavConnections in interface IWorkflowProvider

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 interface IWorkflowProvider

Returns:

Same as IWorkflowProvider.getAllWebDavConnections(), but returns select items with the value and the name of the database connection.

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 interface IWorkflowProvider

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.

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 interface IWorkflowProvider

Parameters:

currentNodeKey - 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.

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: IWorkflowProvider

Returns a list of all available resources, which may include client resources, form resources, and external resource URLs.

Specified by:

getAvailableResources in interface IWorkflowProvider

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

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: IWorkflowProvider

Returns a list of all available resources, which may include client resources, form resources, and external resource URLs.

Specified by:

getAvailableResources in interface IWorkflowProvider

Parameters:

currentNodeKey - 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

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: IWorkflowProvider

Returns a list of all available resources, which may include client resources, form resources, and external resource URLs.

Specified by:

getAvailableResources in interface IWorkflowProvider

Parameters:

currentNodeKey - 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

public Mandant getClient()

Specified by:

getClient in interface IWorkflowProvider

Returns:

The current client for which the workflow is being edited.

getInstalledCharsets

public List<Charset> getInstalledCharsets()

Specified by:

getInstalledCharsets in interface IWorkflowProvider

Returns:

A list of all character supported by the server.

getInstalledFontNames

public List<String> getInstalledFontNames()

Specified by:

getInstalledFontNames in interface IWorkflowProvider

Returns:

A list of all font names that are currently installed on the system.

getInvalidEntityUuid

public UUID getInvalidEntityUuid()

Specified by:

getInvalidEntityUuid in interface IWorkflowProvider

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 interface IWorkflowProvider

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 interface IWorkflowProvider

Returns:

The current locale that is to be used for locale-sensitive operations.

getNonOrderableAuthenticatorConfigs

public List<BaseConfigViewModel> getNonOrderableAuthenticatorConfigs()

Specified by:

getNonOrderableAuthenticatorConfigs in interface IWorkflowProvider

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 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.

Specified by:

getNormalCompletionAttachmentProvidingPredecessors in interface IWorkflowProvider

Returns:

A list of all workflow nodes that can provide files to the currently selected node.

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 a normal edge.
• the node X provides or creates attachments, see getAttachmentValueDescriptor)

Specified by:

getNormalCompletionAttachmentProvidingPredecessors in interface IWorkflowProvider

Returns:

A list of all workflow nodes that can provide files to the given node.

getNormalCompletionPredecessors

public List<INodeWithName> getNormalCompletionPredecessors()

Specified by:

getNormalCompletionPredecessors in interface IWorkflowProvider

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.

getNormalCompletionPredecessors

public List<INodeWithName> getNormalCompletionPredecessors(NodeKey nodeKey)

Specified by:

getNormalCompletionPredecessors in interface IWorkflowProvider

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.

getNormalCompletionProvidingPredecessors

public List<INodeWithName> getNormalCompletionProvidingPredecessors()

Description copied from interface: IWorkflowProvider

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:

• the node X is part of the same WorkflowTask as the currently selected node
• the currently selected node is potentially reachable from node X (see IWorkflowFlowAnalysis.getPotentialPredecessorsOf(NodeKey, de.xima.fc.interfaces.workflow.analysis.FlowGraphFilter.Backward)
• the node X provides or creates files, see IExecutionResultDescriptor.getFileValueDescriptor())

Specified by:

getNormalCompletionProvidingPredecessors in interface IWorkflowProvider

Returns:

A list of all workflow nodes that can provide files to the currently selected node.

getNormalCompletionProvidingPredecessors

public List<INodeWithName> getNormalCompletionProvidingPredecessors(NodeKey nodeKey)

Description copied from interface: IWorkflowProvider

Returns 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 WorkflowTask as the given node
• the given node is potentially reachable from node X (see IWorkflowFlowAnalysis.getPotentialPredecessorsOf(NodeKey, de.xima.fc.interfaces.workflow.analysis.FlowGraphFilter.Backward)
• the node X provides or creates files, see IExecutionResultDescriptor.getFileValueDescriptor())

Specified by:

getNormalCompletionProvidingPredecessors in interface IWorkflowProvider

Parameters:

nodeKey - Key of the node to check.

Returns:

A list of all workflow nodes that can provide files to the given node.

getOrderableAuthenticatorConfigs

public List<BaseConfigViewModel> getOrderableAuthenticatorConfigs()

Specified by:

getOrderableAuthenticatorConfigs in interface IWorkflowProvider

Returns:

All orderable authenticator configurations that are available to the current project.

getPredecessors

public List<INodeWithName> getPredecessors()

Specified by:

getPredecessors in interface IWorkflowProvider

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 interface IWorkflowProvider

Returns:

The current project for which the workflow is being edited.

getStandardSupportedCharsets

public List<Charset> getStandardSupportedCharsets()

Specified by:

getStandardSupportedCharsets in interface IWorkflowProvider

Returns:

A list of all character sets normally supported by formcycle.

getTextTemplatesByCategory

public List<Textbaustein> getTextTemplatesByCategory(ETextbausteinKategorie category)

Specified by:

getTextTemplatesByCategory in interface IWorkflowProvider

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:

getTextTemplateSelectItemsByCategory in interface IWorkflowProvider

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:

getWorkflowVersion in interface IWorkflowProvider

Returns:

The current version in which the workflow is