Class WorkflowModuleImpl
- All Implemented Interfaces:
com.axemble.vdoc.core.interfaces.InternalProcessModule
,IBaseWorkflowModule
,IModule
,IWorkflowModule
,Serializable
,Remote
- Direct Known Subclasses:
com.axemble.vdoc.sdk.impl.ProcessWorkflowModule
- Author:
- vlygeros
- See Also:
-
Field Summary
Fields inherited from class com.axemble.vdoc.sdk.impl.CoreModule
LOGGER, properties
-
Constructor Summary
ConstructorDescriptionDeprecated.Use com.axemble.vdoc.sdk.Modules.getWorkflowModule() instead. -
Method Summary
Modifier and TypeMethodDescriptionvoid
abort
(IContext context, IWorkflowInstance instance, String comment) Allows to abort workflow instance.addAttachment
(IResource resource, String propertyName, IAttachment attachment) Adds an attachment from an attachment.addAttachment
(IResource resource, String propertyName, File file) Adds an attachment as a java.io.File object.addAttachment
(IResource resource, String propertyName, String fileName, InputStream input) Adds an attachment as an java.io.InputStream object.addAttachment
(IResource resource, String propertyName, String fileName, String fullPath) Adds an attachment with its full path.void
Adds a group to a role.void
Adds a user to a role.buildMailMessage
(IResource resource, IMailForm mailForm, String language) Evaluates the form and returns the HTML content as a java.lang.String object.buildMailMessage
(ITaskInstance taskInstance, IMailForm mailForm, String language) Evaluates the form and returns the HTML content as a java.lang.String object.canDeleteDiscussionMessage
(IContext context, IDiscussionMessage iDiscussionMessage) Allows knowing if an IDiscussionMessage can be deleted in the current IContext or notcanModifyDiscussionMessage
(IContext context, IDiscussionMessage iDiscussionMessage) Allows knowing if an IDiscussionMessage can be modified in the current IContext or notcreateCatalog
(IContext context, String name, String label) Allows to create a new catalog.createCatalog
(IContext context, String name, String label, IProject project) Allows to create a new catalog.createDiscussionMessage
(IContext context, IWorkflowInstance iWorkflowInstance, String content, Collection<IAttachment> attachments, String visibility, Collection<IUser> recipients, IOrganization visibilityOrganization) Create and add a new message for an IWorkflowInstance.createDynamicLocalizationsWrapper
(IContext context, ICatalog catalog) Creates a dynamicLocalizationsWrapper object by specifying the parentICatalog
object.Creates a generic resource for mail purposes.createLinkedResource
(IResource resource, String propertyName) Creates a linked resource into a specified property table.createListOption
(Object key, String text) createOperatorRole
(IContext context, ICatalog catalog, String name) Creates aIOperatorRole
into the catalog object.createRole
(IContext context, ICatalog catalog, String name) Deprecated.createStorageResource
(IContext context, IResourceDefinition resourceDefinition, String reference) Creates a storage resource object by specifying theIResourceDefinition
object, its reference.createStorageResource
(IContext context, IResourceDefinition resourceDefinition, String reference, String label) Creates a storage resource object by specifying theIResourceDefinition
object, its reference, and its label.createWorkflow
(IContext context, IWorkflowContainer container, String name, byte[] content) Creates a workflow within a workflow container.createWorkflowContainer
(IContext context, ICatalog catalog, String name) Creates a workflow container within aICatalog
object.createWorkflowInstance
(IContext context, IWorkflow workflow, String reference) Creates a workflow instance object by specifying theIWorkflow
object, its reference.createWorkflowInstance
(IContext context, IWorkflow workflow, String reference, String label) Creates a workflow instance object by specifying theIWorkflow
object, its reference, and its label.void
deleteDiscussionMessage
(IContext context, IWorkflowInstanceDiscussionMessage iWorkflowInstanceDiscussionMessage, IWorkflowInstance iWorkflowInstance) Delete an IWorkflowInstanceDiscussionMessage for an IWorkflowInstance.void
end
(IContext context, ITaskInstance instance, IAction action, String comment) Crosses a transition.void
Allows to cross a transition for another user.evaluatedHtml
(IResource resource, IMailForm mailForm) Evaluates the form and returns the HTML content as a java.lang.String object.evaluatedHtml
(ITaskInstance taskInstance, IMailForm mailForm) Evaluates the form and returns the HTML content as a java.lang.String object.evaluatedMailForm
(IResource resource, IMailForm mailForm, String language) Evaluate mail formevaluatedMailForm
(ITaskInstance taskInstance, IMailForm mailForm, String language) Evaluate mail formvoid
Allows to execute an agent.void
Allows to execute an agent.findStorageResourceByReference
(IContext context, IResourceDefinition resourceDefinition, String reference) Find a storage resource object by specifying theIResourceDefinition
object, its reference.int
generateChrono
(IResourceDefinition resourceDefinition) Evaluate the next chrono based on the format specified on the Designer tool.generateReference
(IResource resource) Evaluate the next reference based on the format specified on the Designer tool.generateReference
(IResourceDefinition resourceDefinition) Evaluate the next reference based on the format specified on the Designer tool.generateReference
(IResourceDefinition resourceDefinition, String format) Evaluate the next reference based on the passed format.generateReference
(IResource resource, String format) Evaluate the next reference based on the specified format.generateReference
(IResource resource, Document format) Evaluate the next reference based specified format.generateSystemName
(String label) Generate a valid system name for this module and this label.Collection
<? extends ITaskInstance> getAbortedTaskInstances
(IContext context, IWorkflowInstance instance) Retrieves all the aborted task instances of a workflow instance.Retrieve a specificIAction
object from its system name.getAction
(IStorageKey key) Gets an action object from its identifier.Collection
<? extends IAction> getActions
(IContext context, ITask task) Gets an agent from its name.Collection
<? extends ICatalog> getAllCatalogs
(IContext context) Retrieves a collection ofICatalog
object.Gets a archiving controller to archiveIElement
objects.getAttachment
(IResource resource, String propertyName, String fileName) Gets an attachment by its file name.Collection
<? extends IAttachment> getAttachments
(IResource resource, String propertyName) Gets all the attachments associated with a property.getCatalog
(IContext context, String name) Retrieves a catalog form its name.getCatalog
(IContext context, String name, int catalogType) Retrieves a catalog form its name.getCatalog
(IContext context, String name, int catalogType, IProject project) Retrieves a catalog form its name.getCatalog
(IContext context, String name, IProject project) Retrieves a catalog form its name.getCatalog
(IResourceDefinition resourceDefinition) Gets aICatalog
object from a resource definitino.getCatalog
(IStorageKey key) Gets a catalog object from its identifier.getCatalog
(IWorkflow workflow) Retrieves the catalog of aIWorkflow
object.Collection
<? extends ICatalog> getCatalogs
(IContext context) Retrieves a collection ofICatalog
object.Collection
<? extends ICatalog> getCatalogs
(IContext context, int catalogType) Retrieves a collection ofICatalog
object.Collection
<? extends ICatalog> getCatalogs
(IContext context, int catalogType, IProject project) Retrieves a collection ofICatalog
object.Collection
<? extends ICatalog> getCatalogs
(IContext context, IProject project) Retrieves a collection ofICatalog
object.Gets a catalog view transformer to transformICatalog
objects.getController
(IResource resource) Gets the resource controller object.getDataSourceReference
(String name) Gets a data source reference from its JNDI name.Gets the default data source reference.Gets a delegation controller to delegateIDelegationSupport
objects.getDiscussionMessagesOrderByCreationDateDesc
(IContext context, IWorkflowInstance iWorkflowInstance) Retrieve IWorkflowInstance's messageCollection
<? extends ITaskInstance> getEndedTaskInstances
(IContext context, IWorkflowInstance instance) Retrieves all the ended task instances of a workflow instance.Collection
<?> getExternalElements
(IResource resource, String propertyName) Gets a collection ofIElement
objects from a multiple selector property.getExternalFile
(IResource resource, String propertyName) Gets aIFile
object from a single file selector property.getExternalFolder
(IResource resource, String propertyName) Gets aIFolder
object from a single folder selector property.getExternalGroup
(IResource resource, String propertyName) Gets aIGroup
object from a single group selector property.getExternalLibrary
(IResource resource, String propertyName) Gets aILibrary
object from a single library selector property.getExternalLocalization
(IResource resource, String propertyName) Gets aILocalization
object from a single localization selector property.getExternalOrganization
(IResource resource, String propertyName) Gets aIOrganization
object from a single organization selector property.getExternalUser
(IResource resource, String propertyName) Gets aIUser
object from a single user selector property.Gets a action form by its name.getForm
(IContext context, IResourceDefinition resourceDefinition, String formName) Gets a resource definition form by its name.Gets a task form by its name.Gets a workflow form by its name.Get a group from its idgetGroupByName
(String name) Gets a group by its namegetJdbcReference
(IContext context, String name) Gets a JDBC reference from its name.Collection
<? extends IJdbcReference> getJdbcReferences
(IContext context) Gets a collection of JDBC references.Collection
<? extends ILinkedResource> getLinkedResources
(IResource resource, String propertyName) Gets all the linked resources associated with a table property.Gets a list object from a catalog by its name.Collection
<? extends IOptionList.IOption> Gets the available values of a list property.getListLabel
(ICatalog catalog, String listName, String key, String language) get translated value of a listCollection
<? extends IList> Gets a collection of a the lists available on a specifiedICatalog
object.getMailForm
(IContext context, IWorkflow workflow, String mailFormName) Collection
<? extends IMailForm> getMailForms
(IContext context, IWorkflow workflow) Gets all the mail forms from a specifiedIWorkflow
object.Collection
<? extends IMailForm> getMailForms
(IContext context, IWorkflow workflow, String startsWith) Collection
<? extends ITaskInstance> getManualTaskInstances
(IContext context, IWorkflowInstance instance) Retrieves all the manual task instances of a workflow instance.Collection
<? extends ITaskInstance> getManualTaskInstancesByStatus
(IContext context, int status) Retrieves all the manual task instances for a status.Collection
<? extends ITaskInstance> getManualTaskInstancesModifiedSince
(IContext context, Date date) Retrieves all the manual task instances modified since.Collection
<? extends ITask> getManualTasks
(IContext context, IWorkflow workflow) Get manual task from workflowgetOneTaskInstance
(IContext context, IWorkflowInstance instance) Gets one of the task instances (any).getOperator
(IStorageKey key) Gets an operator object from its identifier.getOperator
(String id) Gets aIOperator
object from its string identifier.getOperatorByLogin
(String login) Gets anIOperator
from a user login.getOperatorRole
(IContext context, ICatalog catalog, String name) Retrieves aIOperatorRole
object by its system name.Gets a role object from its identifier.Collection
<? extends IOperatorRole> getOperatorRoles
(IContext context, ICatalog catalog) Retrieves a collection ofIOperatorRole
objects within a specified catalog.Collection
<? extends IOperator> getOperators
(ITaskInstance instance) Retrieves the operators of a task instance.getParentInstance
(ILinkedResource linkedResource) Gets the parent instance of a linked resource.getParentInstance
(IWorkflowInstance instance) Gets the parent instance of a specifiedIWorkflowInstance
object.Collection
<? extends IProperty> getProperties
(IContext context, IResourceDefinition resourceDefinition) Gets all the properties of a specified definition.getProperty
(IContext context, IResourceDefinition resourceDefinition, String name) Gets a property definition by specifying theIResourceDefinition
and its system name.getProperty
(IStorageKey key) Gets a property object from its identifier.getResource
(IStorageKey key) Gets a resource object from its identifier.protected IResource
getResource
(com.axemble.vdp.ui.core.document.CoreDocument document) getResource
(Object document) Gets aIResource
object from an object.getResource
(String id) Gets aIResource
object from its string identifier.getResourceController
(IResource resource) Gets the resource controller object.getResourceDefinition
(IContext context, ICatalog catalog, String name) Retrieves a resource definition by specifying theICatalog
and its system name.Gets a resource definition object from its identifier.Collection
<? extends IResourceDefinition> getResourceDefinitions
(IContext context, ICatalog catalog) Retrieves all resource definitions by specifying theICatalog
getResourceHistory
(IWorkflowInstance workflowInstance) Collection
<? extends IResource> getResources
(IContext context, ICatalog catalog) Gets a collection ofIResource
objects from a catalogCollection
<? extends IResource> getResources
(IContext context, IResourceDefinition resourceDefinition) Gets a collection ofIResource
objects from a resource definition.Gets a resource view transformer to transformIResource
objects.Deprecated.getRole
(IStorageKey key) Deprecated.Collection
<? extends IRole> Deprecated.Gets the defaultISearchController
object.getSearchController
(IConnectionDefinition connectionDefinition) Gets a search controller object by specifying a ConnectionDefinition object.getSearchController
(IDataSourceReference reference) Gets a search controller object by specifying an external data source.getSearchController
(IJdbcReference reference) Gets a search controller object by specifying a JDBC external reference.Gets a search view transformer to transformIResource
objects.getSecurityController
(ISecuritySupport securitySupport) Gets a security controller on a specified object.Collection
<? extends ITaskInstance> getStartedTaskInstances
(IContext context, IWorkflowInstance instance) Retrieves all the started task instances of a workflow instance.getSubForm
(IContext context, IWorkflow workflow, String formName) Gets a sub form by its name.Retrieves a specific task of aIWorkflow
object by its name.getTask
(IStorageKey key) Gets a task object from its identifier.getTask
(ITaskInstance instance) Gets the definition of a task instance.getTaskInstance
(IContext context, IWorkflowInstance instance, String name) Gets the started task instance associated with a specified task name.Gets a task instance object from its identifier.Gets aITaskInstance
object from its string identifier.Collection
<? extends ITaskInstance> getTaskInstances
(IContext context, IWorkflowInstance instance) Retrieves all the task instances of a specified workflow instance.Collection
<? extends ITaskInstance> getTaskInstances
(IContext context, IWorkflowInstance instance, String name) Retrieves all the task instances of a specified workflow instance filtered by the name of aITask
.Gets a task transformer to transformITaskInstance
object.Collection
<? extends ITask> Get task from workflowGets a task view transformer to transformITaskInstance
objects.Gets a transformer to transformIResource
object.Gets the value of a property.Retrieves a view by its name.getView
(IContext context, IResourceDefinition resourceDefinition, String viewName) Retrieves a view by its name.getView
(IContext context, IWorkflowContainer workflowContainer, String viewName) Retrieves a view by its name.Deprecated.getViewController
(IContext context) Gets a view controller to searchIResource
objects through their properties.getViewController
(IContext context, IProject project, com.axemble.vdp.views.query.Definition definition) Internal methodgetViewController
(IContext context, IProject project, InputStream inputStream) Gets a view controller to searchIResource
objects through their properties.getViewController
(IContext context, Class natureClass) Gets a view controller to searchIResource
objects through their properties.getViewController
(IProject project, com.axemble.vdp.views.query.Definition definition) Deprecated.getViewController
(IProject project, InputStream inputStream) Deprecated.getViewController
(Class natureClass) Deprecated.Collection
<? extends IView> Retrieves all the views associated with the catalog.Collection
<? extends IView> getViews
(IContext context, IResourceDefinition resourceDefinition) Retrieves all the views associated with the resource definition.Collection
<? extends IView> getViews
(IContext context, IWorkflowContainer workflowContainer) Retrieves all the views associated with the workflow container.getWorkflow
(IContext context, ICatalog catalog, String name) Retrieves a workflow within aIWorkflow
object and from its system name.getWorkflow
(IContext context, String name) Deprecated.getWorkflow
(IStorageKey key) Gets a workflow object from its identifier.getWorkflow
(ITask task) Gets the associated workflow of a task.getWorkflow
(String id) Get workflow from its idgetWorkflowContainer
(IContext context, ICatalog catalog, String name) Retrieves aIWorkflowContainer
within aICatalog
by its system nameGets a workflow container object from its identifier.getWorkflowContainer
(IWorkflow workflow) Retrieves the workflow container of aIWorkflow
object.Get workflow container from its idCollection
<? extends IWorkflowContainer> getWorkflowContainers
(IContext context, ICatalog catalog) Retrieves a collection ofIWorkflowContainer
objects within aICatalog
object.Gets a workflow container view transformer to transformIWorkflowContainer
objects.Gets a workflow instance object from its identifier.protected IWorkflowInstance
getWorkflowInstance
(com.axemble.vdp.ui.core.document.CoreDocument document) getWorkflowInstance
(Object document) Gets aIWorkflowInstance
object from an object.Gets aIWorkflowInstance
object from its string identifier.Collection
<? extends IWorkflowInstance> getWorkflowInstances
(IContext context, ICatalog catalog) Gets all the workflow instances of a specifiedICatalog
object.Collection
<? extends IWorkflowInstance> getWorkflowInstances
(IContext context, ICatalog catalog, String reference) Gets all the workflow instances with the same reference within a specifiedICatalog
object.Collection
<? extends IWorkflowInstance> getWorkflowInstances
(IContext context, ITask task) Gets all the workflow instances of a specifiedITask
object.Collection
<? extends IWorkflowInstance> getWorkflowInstances
(IContext context, IWorkflow workflow) Gets all the workflow instances of a specifiedIWorkflow
object.Collection
<? extends IWorkflowInstance> getWorkflowInstances
(IContext context, IWorkflow workflow, String reference) Gets all the workflow instances with the same reference within a specifiedIWorkflow
object.Collection
<? extends IWorkflow> getWorkflows
(IContext context, ICatalog catalog) Collection
<? extends IWorkflow> getWorkflows
(IContext context, IWorkflowContainer container) Retrieves a collection ofIWorkflow
objects within aIWorkflowContainer
object.Gets a workflow view transformer to transformIWorkflow
objects.boolean
hasDiscussionThread
(IContext context, IWorkflowInstance iWorkflowInstance) Allows knowing if an IWorkflowInstance has a discussion thread or notboolean
isLockBySDK
(IContext context, IWorkflowInstance workflowInstance) Checks if a specified workflow instance is locked by the SDKboolean
isLocked
(IContext context, IWorkflowInstance workflowInstance) Checks if a specified workflow instance is lockedboolean
isMemberOf
(IUser user, IRole role) Checks if a specified user is member of aIRole
object.boolean
isMemberOf
(IUser user, IRole role, boolean recursive) Checks if a specified user is member of aIRole
object.void
lock
(IContext context, IWorkflowInstance workflowInstance, int delay) Allows to lock workflow instance.lockedBy
(IContext context, IWorkflowInstance workflowInstance) Retrieve the users who locked the workflow instance.void
remind
(IContext context, ITaskInstance instance, String comment) Allows to remind current operators of a specified task instance.void
remind
(IContext context, IWorkflowInstance instance, String comment) Allows to remind current operators of a workflow instance.void
send
(IContext context, IResource resource, IMailForm mailForm, Collection<?> entries, String subject, String content) Sends a mail by specifying the subject and the content of the body.void
send
(IContext context, IResource resource, IMailForm mailForm, Collection<? extends IUser> mailTo, String comment) Sends a mail by specifying the subject and the content of the body.protected final void
send
(IContext context, IResource resource, ITaskInstance taskInstance, IMailForm mailForm, Collection<?> entries, String subject, String content) void
send
(IContext context, ITaskInstance instance, IMailForm form, String comment) Sends a mail using a specified mail form.void
send
(IContext context, ITaskInstance taskInstance, IMailForm mailForm, Collection<?> entries, String subject, String content) Sends a mail by specifying the subject and the content of the body.void
send
(IContext context, ITaskInstance taskInstance, IMailForm mailForm, Collection<? extends IUser> mailTo, String comment) Sends a mail by specifying the subject and the content of the body.void
Sends a mail using a specified mail form.void
send
(IContext context, IWorkflowInstance workflowInstance, String formName, Collection<?> entries) Allows to send a mail with a specific form to a mail recipient.void
send
(IContext context, IWorkflow workflow, IResource resource, String formName, Collection<?> entries) Allows to send a mail.void
send
(IContext context, IWorkflow workflow, String formName, Collection<?> entries) Allows to send a mail.setDynamicLocalizationsWrapperMessageForLanguage
(IContext context, IDynamicLocalizationsWrapper dynamicLocalizationsWrapper, ICatalog catalog, String language, String message) Creates a dynamicLocalizationsWrapper object by specifying the parentICatalog
object.void
setExternalElements
(IResource resource, String propertyName, Collection<?> elements) Sets aIElement
to a multiple selector property.void
setExternalFile
(IResource resource, String propertyName, IFile file) Sets aIFile
to a single selector property.void
setExternalFolder
(IResource resource, String propertyName, IFolder folder) Sets aIFolder
to a single selector property.void
setExternalGroup
(IResource resource, String propertyName, IGroup group) Sets aIGroup
to a single selector property.void
setExternalLibrary
(IResource resource, String propertyName, ILibrary library) Sets aILibrary
to a single selector property.void
setExternalLocalization
(IResource resource, String propertyName, ILocalization localization) Sets aILocalization
to a single selector property.void
setExternalOrganization
(IResource resource, String propertyName, IOrganization organization) Sets aIOrganization
to a single selector property.void
setExternalUser
(IResource resource, String propertyName, IUser user) Sets aIUser
to a single selector property.void
setList
(IResource resource, String propertyName, Collection<? extends IOptionList.IOption> values) Sets the list of available values to a list property.void
Sets a value to a property.void
unlock
(IContext context, IWorkflowInstance workflowInstance) Allows to unlock workflow instance.void
updateDiscussionMessage
(IContext context, IWorkflowInstanceDiscussionMessage iWorkflowInstanceDiscussionMessage, String content, Collection<IAttachment> attachments) Update content and/or attachments of a message.Methods inherited from class com.axemble.vdoc.sdk.impl.CoreModule
beginTransaction, beginTransaction, commitTransaction, commitTransaction, convertId, createAttachment, createAttachment, createAttachment, createAttachment, createProfile, findNativeClass, getAnonymous, getAnonymousContext, getComponentsFactory, getConfiguration, getContext, getContext, getContext, getContextByLogin, getDefinitionsFactory, getElementByProtocolURI, getElementFromExternalElement, getExternalElement, getExternalElement, getLanguage, getLoggedOnUser, getLoggedOnUserContext, getLoggedOnUserLanguage, getProfile, getProfile, getProfiles, getProtocolPath, getProtocolPath, getProtocolURI, getProtocolURI, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getSysadmin, getSysadminContext, getUser, getUser, getUserByLogin, initialize, isTransactionActive, rollbackTransaction, rollbackTransaction, setTransactionTimeout, unInitialize
Methods inherited from class com.axemble.vdoc.sdk.impl.AbstractTranslaterModule
getTranslation, getTranslationForLanguage, getTranslationKey
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.axemble.vdoc.sdk.modules.IBaseWorkflowModule
createProfile, getConfiguration, getElementByProtocolURI, getProfile, getProfile, getProfiles, getUser, getUser, getUserByLogin
Methods inherited from interface com.axemble.vdoc.sdk.modules.IModule
beginTransaction, beginTransaction, commitTransaction, commitTransaction, convertId, findNativeClass, getAnonymous, getAnonymousContext, getContext, getContext, getContextByLogin, getElementFromExternalElement, getExternalElement, getExternalElement, getLoggedOnUser, getLoggedOnUserContext, getLoggedOnUserLanguage, getProtocolPath, getProtocolPath, getProtocolURI, getProtocolURI, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getSysadmin, getSysadminContext, getTranslation, getTranslationForLanguage, getTranslationKey, initialize, isTransactionActive, rollbackTransaction, rollbackTransaction, setTransactionTimeout, unInitialize
Methods inherited from interface com.axemble.vdoc.core.interfaces.InternalProcessModule
getLanguage
Methods inherited from interface com.axemble.vdoc.sdk.modules.IWorkflowModule
getDefinitionsFactory
-
Constructor Details
-
WorkflowModuleImpl
Deprecated.Use com.axemble.vdoc.sdk.Modules.getWorkflowModule() instead.
-
-
Method Details
-
createCatalog
public ICatalog createCatalog(IContext context, String name, String label) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Allows to create a new catalog. This method allows to specify the system name and the label of the catalog.- Specified by:
createCatalog
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.name
- The system name of the catalog.label
- The label of the catalog.- Returns:
- a
ICatalog
object. - Throws:
WorkflowModuleException
- default module exception.
-
createCatalog
public ICatalog createCatalog(IContext context, String name, String label, IProject project) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Allows to create a new catalog. This method allows to specify the system name and the label of the catalog and the project- Specified by:
createCatalog
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.name
- The system name of the catalog.label
- The label of the catalog.project
- TheIProject
representing the project.- Returns:
- a
ICatalog
object. - Throws:
WorkflowModuleException
- default module exception.
-
getCatalog
Description copied from interface:IBaseWorkflowModule
Retrieves a catalog form its name.- Specified by:
getCatalog
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.name
- The system name of the catalog.- Returns:
- a
ICatalog
object. - Throws:
WorkflowModuleException
- default module exception.
-
getCatalog
public ICatalog getCatalog(IContext context, String name, IProject project) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves a catalog form its name.- Specified by:
getCatalog
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.name
- The system name of the catalog.project
- TheIProject
representing the project.- Returns:
- a
ICatalog
object. - Throws:
WorkflowModuleException
- default module exception.
-
getCatalog
public ICatalog getCatalog(IContext context, String name, int catalogType) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves a catalog form its name.- Specified by:
getCatalog
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.name
- The system name of the catalog.catalogType
- TheICatalog.IType
of the catalog.- Returns:
- a
ICatalog
object. - Throws:
WorkflowModuleException
- default module exception.
-
getCatalog
public ICatalog getCatalog(IContext context, String name, int catalogType, IProject project) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves a catalog form its name.- Specified by:
getCatalog
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.name
- The system name of the catalog.catalogType
- TheICatalog.IType
of the catalog.project
- TheIProject
representing the project.- Returns:
- a
ICatalog
object. - Throws:
WorkflowModuleException
- default module exception.
-
getCatalogs
Description copied from interface:IBaseWorkflowModule
Retrieves a collection ofICatalog
object.- Specified by:
getCatalogs
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.- Returns:
- a collection of
ICatalog
objects. - Throws:
WorkflowModuleException
- default module exception.
-
getCatalogs
public Collection<? extends ICatalog> getCatalogs(IContext context, IProject project) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves a collection ofICatalog
object.- Specified by:
getCatalogs
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.project
- TheIProject
representing the project.- Returns:
- a collection of
ICatalog
objects. - Throws:
WorkflowModuleException
- default module exception.
-
getCatalogs
public Collection<? extends ICatalog> getCatalogs(IContext context, int catalogType) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves a collection ofICatalog
object.- Specified by:
getCatalogs
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.catalogType
- TheICatalog.IType
of the catalogs.- Returns:
- a collection of
ICatalog
objects. - Throws:
WorkflowModuleException
- default module exception.
-
getCatalogs
public Collection<? extends ICatalog> getCatalogs(IContext context, int catalogType, IProject project) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves a collection ofICatalog
object.- Specified by:
getCatalogs
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.catalogType
- TheICatalog.IType
of the catalogs.project
- TheIProject
representing the project.- Returns:
- a collection of
ICatalog
objects. - Throws:
WorkflowModuleException
- default module exception.
-
getAllCatalogs
public Collection<? extends ICatalog> getAllCatalogs(IContext context) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves a collection ofICatalog
object.- Specified by:
getAllCatalogs
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.- Returns:
- a collection of
ICatalog
objects. - Throws:
WorkflowModuleException
- default module exception.
-
createRole
@Deprecated public IRole createRole(IContext context, ICatalog catalog, String name) throws WorkflowModuleException Deprecated.Description copied from interface:IBaseWorkflowModule
Creates aIRole
into the catalog object.- Specified by:
createRole
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.catalog
- TheICatalog
object.name
- The system name of theIRole
to be created.- Returns:
- a
IRole
object. - Throws:
WorkflowModuleException
- default module exception.
-
getRole
@Deprecated public IRole getRole(IContext context, ICatalog catalog, String name) throws WorkflowModuleException Deprecated.Description copied from interface:IBaseWorkflowModule
Retrieves aIRole
object by its system name.- Specified by:
getRole
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.catalog
- TheICatalog
scope object.name
- The system name of the role.- Returns:
- a
IRole
object. - Throws:
WorkflowModuleException
- default module exception.
-
getRoles
@Deprecated public Collection<? extends IRole> getRoles(IContext context, ICatalog catalog) throws WorkflowModuleException Deprecated.Description copied from interface:IBaseWorkflowModule
Retrieves a collection ofIRole
objects within a specified catalog.- Specified by:
getRoles
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.catalog
- TheICatalog
object.- Returns:
- a collection of
IRole
objects. - Throws:
WorkflowModuleException
- default module exception.
-
createOperatorRole
public IOperatorRole createOperatorRole(IContext context, ICatalog catalog, String name) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Creates aIOperatorRole
into the catalog object.- Specified by:
createOperatorRole
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.catalog
- TheICatalog
object.name
- The system name of theIRole
to be created.- Returns:
- a
IRole
object. - Throws:
WorkflowModuleException
- default module exception.
-
getOperatorRole
public IOperatorRole getOperatorRole(IContext context, ICatalog catalog, String name) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves aIOperatorRole
object by its system name.- Specified by:
getOperatorRole
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.catalog
- TheICatalog
scope object.name
- The system name of the role.- Returns:
- a
IRole
object. - Throws:
WorkflowModuleException
- default module exception.
-
getOperatorRoles
public Collection<? extends IOperatorRole> getOperatorRoles(IContext context, ICatalog catalog) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves a collection ofIOperatorRole
objects within a specified catalog.- Specified by:
getOperatorRoles
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.catalog
- TheICatalog
object.- Returns:
- a collection of
IRole
objects. - Throws:
WorkflowModuleException
- default module exception.
-
getDefaultDataSourceReference
Description copied from interface:IBaseWorkflowModule
Gets the default data source reference.- Specified by:
getDefaultDataSourceReference
in interfaceIBaseWorkflowModule
- Returns:
- a
IDataSourceReference
object. - Throws:
WorkflowModuleException
- default module exception.
-
getDataSourceReference
Description copied from interface:IBaseWorkflowModule
Gets a data source reference from its JNDI name.- Specified by:
getDataSourceReference
in interfaceIBaseWorkflowModule
- Parameters:
name
- The JNDI name.- Returns:
- a
IDataSourceReference
object. - Throws:
WorkflowModuleException
- default module exception.
-
getJdbcReference
public IJdbcReference getJdbcReference(IContext context, String name) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets a JDBC reference from its name.- Specified by:
getJdbcReference
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.name
- The name of the external reference.- Returns:
- a
IJdbcReference
object. - Throws:
WorkflowModuleException
- default module exception.
-
getJdbcReferences
public Collection<? extends IJdbcReference> getJdbcReferences(IContext context) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets a collection of JDBC references.- Specified by:
getJdbcReferences
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.- Returns:
- a
Collection
of IJdbcReference object. - Throws:
WorkflowModuleException
- default module exception.
-
getList
public IList getList(IContext context, ICatalog catalog, String name) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets a list object from a catalog by its name.- Specified by:
getList
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.catalog
- TheICatalog
representing the application.name
- The name of the list.- Returns:
- a
IList
object. - Throws:
WorkflowModuleException
- default module exception.
-
getLists
public Collection<? extends IList> getLists(IContext context, ICatalog catalog) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets a collection of a the lists available on a specifiedICatalog
object.- Specified by:
getLists
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.catalog
- TheICatalog
representing the application.- Returns:
- a collection of
IList
object - Throws:
WorkflowModuleException
- default module exception.
-
isMemberOf
Description copied from interface:IBaseWorkflowModule
Checks if a specified user is member of aIRole
object.- Specified by:
isMemberOf
in interfaceIBaseWorkflowModule
- Parameters:
user
- TheIUser
object to check.role
- TheIRole
object.- Returns:
- return true if the user is member of the
IRole
object. - Throws:
WorkflowModuleException
- default module exception.
-
isMemberOf
Description copied from interface:IBaseWorkflowModule
Checks if a specified user is member of aIRole
object.- Specified by:
isMemberOf
in interfaceIBaseWorkflowModule
- Parameters:
user
- TheIUser
object to check.role
- TheIRole
object.recursive
- Set to true if you wish to check recursively, false otherwise.- Returns:
- return true if the user is member of the
IRole
object. - Throws:
WorkflowModuleException
- default module exception.
-
createWorkflowContainer
public IWorkflowContainer createWorkflowContainer(IContext context, ICatalog catalog, String name) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Creates a workflow container within aICatalog
object.- Specified by:
createWorkflowContainer
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.catalog
- TheICatalog
object.name
- The system name of theIWorkflowContainer
object.- Returns:
- a
IWorkflowContainer
object. - Throws:
WorkflowModuleException
- default module exception.
-
getWorkflowContainer
public IWorkflowContainer getWorkflowContainer(IContext context, ICatalog catalog, String name) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves aIWorkflowContainer
within aICatalog
by its system name- Specified by:
getWorkflowContainer
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.catalog
- TheICatalog
object.name
- The system name of theIWorkflowContainer
object.- Returns:
- a
IWorkflowContainer
object. - Throws:
WorkflowModuleException
- default module exception.
-
getWorkflowContainers
public Collection<? extends IWorkflowContainer> getWorkflowContainers(IContext context, ICatalog catalog) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves a collection ofIWorkflowContainer
objects within aICatalog
object.- Specified by:
getWorkflowContainers
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.catalog
- TheICatalog
object.- Returns:
- a collection of
IWorkflowContainer
objects. - Throws:
WorkflowModuleException
- default module exception.
-
createWorkflow
public IWorkflow createWorkflow(IContext context, IWorkflowContainer container, String name, byte[] content) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Creates a workflow within a workflow container.- Specified by:
createWorkflow
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.container
- TheIWorkflowContainer
object.name
- The system name of the workflow.content
- The XML content of the workflow.- Returns:
- a
IWorkflow
object. - Throws:
WorkflowModuleException
- default module exception.
-
getWorkflow
@Deprecated public IWorkflow getWorkflow(IContext context, String name) throws WorkflowModuleException Deprecated.Description copied from interface:IBaseWorkflowModule
Retrieves a workflow form its system name.- Specified by:
getWorkflow
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.name
- The system name of the workflow to retrieve.- Returns:
- a
IWorkflow
object. - Throws:
WorkflowModuleException
- default module exception.
-
getWorkflow
public IWorkflow getWorkflow(IContext context, ICatalog catalog, String name) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves a workflow within aIWorkflow
object and from its system name.- Specified by:
getWorkflow
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.catalog
- TheICatalog
object.name
- The system name of the workflow.- Returns:
- a
IWorkflow
object. - Throws:
WorkflowModuleException
- default module exception.
-
getWorkflows
public Collection<? extends IWorkflow> getWorkflows(IContext context, ICatalog catalog) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
- Specified by:
getWorkflows
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.catalog
- TheICatalog
object.- Returns:
- a collection of
IWorkflow
objects. - Throws:
WorkflowModuleException
- default module exception.
-
getWorkflows
public Collection<? extends IWorkflow> getWorkflows(IContext context, IWorkflowContainer container) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves a collection ofIWorkflow
objects within aIWorkflowContainer
object.- Specified by:
getWorkflows
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.container
- TheIWorkflowContainer
object.- Returns:
- a collection of
IWorkflow
objects. - Throws:
WorkflowModuleException
- default module exception.
-
getCatalog
Description copied from interface:IBaseWorkflowModule
Retrieves the catalog of aIWorkflow
object.- Specified by:
getCatalog
in interfaceIBaseWorkflowModule
- Parameters:
workflow
- The workflow object.- Returns:
- a
ICatalog
object - Throws:
WorkflowModuleException
- default module exception.
-
getWorkflowContainer
Description copied from interface:IBaseWorkflowModule
Retrieves the workflow container of aIWorkflow
object.- Specified by:
getWorkflowContainer
in interfaceIBaseWorkflowModule
- Parameters:
workflow
- The workflow object.- Returns:
- a
IWorkflowContainer
object - Throws:
WorkflowModuleException
- default module exception.
-
createWorkflowInstance
public IWorkflowInstance createWorkflowInstance(IContext context, IWorkflow workflow, String reference, String label) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Creates a workflow instance object by specifying theIWorkflow
object, its reference, and its label. The permission to create workflow instance is not checked- Specified by:
createWorkflowInstance
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.workflow
- TheIWorkflow
object.reference
- The reference to set.label
- The label to set.- Returns:
- a
IWorkflowInstance
object. - Throws:
WorkflowModuleException
- default module exception.
-
createWorkflowInstance
public IWorkflowInstance createWorkflowInstance(IContext context, IWorkflow workflow, String reference) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Creates a workflow instance object by specifying theIWorkflow
object, its reference. The permission to create workflow instance is not checked- Specified by:
createWorkflowInstance
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.workflow
- TheIWorkflow
object.reference
- The reference to set.- Returns:
- a
IWorkflowInstance
object. - Throws:
WorkflowModuleException
- default module exception.
-
getWorkflowInstances
public Collection<? extends IWorkflowInstance> getWorkflowInstances(IContext context, ICatalog catalog, String reference) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets all the workflow instances with the same reference within a specifiedICatalog
object.- Specified by:
getWorkflowInstances
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.catalog
- TheICatalog
object.reference
- The reference of the workflow instance.- Returns:
- a collection of
IWorkflowInstance
objects. - Throws:
WorkflowModuleException
- default module exception.
-
getWorkflowInstances
public Collection<? extends IWorkflowInstance> getWorkflowInstances(IContext context, IWorkflow workflow, String reference) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets all the workflow instances with the same reference within a specifiedIWorkflow
object.- Specified by:
getWorkflowInstances
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.workflow
- TheIWorkflow
object.reference
- The reference of the workflow instance.- Returns:
- a collection of
IWorkflowInstance
objects. - Throws:
WorkflowModuleException
- default module exception.
-
getWorkflowInstances
public Collection<? extends IWorkflowInstance> getWorkflowInstances(IContext context, ICatalog catalog) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets all the workflow instances of a specifiedICatalog
object.- Specified by:
getWorkflowInstances
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.catalog
- TheICatalog
object.- Returns:
- a collection of
IWorkflowInstance
objects. - Throws:
WorkflowModuleException
- default module exception.
-
getWorkflowInstances
public Collection<? extends IWorkflowInstance> getWorkflowInstances(IContext context, IWorkflow workflow) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets all the workflow instances of a specifiedIWorkflow
object.- Specified by:
getWorkflowInstances
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.workflow
- TheIWorkflow
object.- Returns:
- a collection of
IWorkflowInstance
objects. - Throws:
WorkflowModuleException
- default module exception.
-
getWorkflowInstances
public Collection<? extends IWorkflowInstance> getWorkflowInstances(IContext context, ITask task) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets all the workflow instances of a specifiedITask
object.- Specified by:
getWorkflowInstances
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.task
- TheITask
object.- Returns:
- a collection of
IWorkflowInstance
objects. - Throws:
WorkflowModuleException
- default module exception.
-
getParentInstance
public IWorkflowInstance getParentInstance(IWorkflowInstance instance) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets the parent instance of a specifiedIWorkflowInstance
object.- Specified by:
getParentInstance
in interfaceIBaseWorkflowModule
- Parameters:
instance
- theIWorkflowInstance
object.- Returns:
- a
IWorkflowInstance
object. - Throws:
WorkflowModuleException
- default module exception.
-
abort
public void abort(IContext context, IWorkflowInstance instance, String comment) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Allows to abort workflow instance.- Specified by:
abort
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.instance
- TheIWorkflowInstance
object.comment
- The reason of the abortion. This comment will appear in the history entries.- Throws:
WorkflowModuleException
- default module exception.
-
remind
public void remind(IContext context, IWorkflowInstance instance, String comment) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Allows to remind current operators of a workflow instance.- Specified by:
remind
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.instance
- TheIWorkflowInstance
object.comment
- The reason of the reminder. This comment will appear in the history entries.- Throws:
WorkflowModuleException
- default module exception.
-
remind
public void remind(IContext context, ITaskInstance instance, String comment) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Allows to remind current operators of a specified task instance.- Specified by:
remind
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.instance
- TheITaskInstance
object.comment
- The reason of the reminder. This comment will appear in the history entries.- Throws:
WorkflowModuleException
- default module exception.
-
setValue
public void setValue(IResource resource, String propertyName, Object value) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Sets a value to a property.- Specified by:
setValue
in interfaceIBaseWorkflowModule
- Parameters:
resource
- TheIWorkflowInstance
object.propertyName
- The system name of the property.value
- The value object to set.- Throws:
WorkflowModuleException
- default module exception.
-
getValue
Description copied from interface:IBaseWorkflowModule
Gets the value of a property.- Specified by:
getValue
in interfaceIBaseWorkflowModule
- Parameters:
resource
- TheIWorkflowInstance
object.propertyName
- The system name of the property.- Returns:
- a
Object
object. - Throws:
WorkflowModuleException
- default module exception.
-
setList
public void setList(IResource resource, String propertyName, Collection<? extends IOptionList.IOption> values) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Sets the list of available values to a list property.- Specified by:
setList
in interfaceIBaseWorkflowModule
- Parameters:
resource
- TheIWorkflowInstance
object.propertyName
- The system name of the property.values
- a collection ofIOptionList.IOption
.- Throws:
WorkflowModuleException
- default module exception.
-
getList
public Collection<? extends IOptionList.IOption> getList(IResource resource, String propertyName) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets the available values of a list property.- Specified by:
getList
in interfaceIBaseWorkflowModule
- Parameters:
resource
- TheIWorkflowInstance
object.propertyName
- The system name of the property.- Returns:
- a collection of
IOptionList.IOption
. - Throws:
WorkflowModuleException
- default module exception.
-
createListOption
- Specified by:
createListOption
in interfaceIBaseWorkflowModule
- Parameters:
key
-text
-- Returns:
- a new
IOptionList.IOption
-
getWorkflow
Description copied from interface:IBaseWorkflowModule
Gets the associated workflow of a task.- Specified by:
getWorkflow
in interfaceIBaseWorkflowModule
- Parameters:
task
- theITask
object.- Returns:
- a
IWorkflow
object. - Throws:
WorkflowModuleException
- default module exception.
-
getTask
public ITask getTask(IContext context, IWorkflow workflow, String name) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves a specific task of aIWorkflow
object by its name.- Specified by:
getTask
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.workflow
- TheIWorkflow
object.name
- The system name of theITask
object.- Returns:
- a
ITask
object. - Throws:
WorkflowModuleException
- default module exception.
-
getActions
public Collection<? extends IAction> getActions(IContext context, ITask task) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
- Specified by:
getActions
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.task
- TheITask
object.- Returns:
- a collection of
IAction
objects. - Throws:
WorkflowModuleException
- default module exception.
-
getAction
Description copied from interface:IBaseWorkflowModule
Retrieve a specificIAction
object from its system name.- Specified by:
getAction
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.task
- TheITask
object.name
- The system name of theIAction
object to retrieve.- Returns:
- a
IAction
object. - Throws:
WorkflowModuleException
- default module exception.
-
getResourceDefinition
public IResourceDefinition getResourceDefinition(IContext context, ICatalog catalog, String name) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves a resource definition by specifying theICatalog
and its system name.- Specified by:
getResourceDefinition
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.catalog
- TheICatalog
object.name
- The system name of the resource definition.- Returns:
- a
IResourceDefinition
object. - Throws:
WorkflowModuleException
- default module exception.
-
getResourceDefinitions
public Collection<? extends IResourceDefinition> getResourceDefinitions(IContext context, ICatalog catalog) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves all resource definitions by specifying theICatalog
- Specified by:
getResourceDefinitions
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.catalog
- TheICatalog
object.- Returns:
- a collection of
IResourceDefinition
objects. - Throws:
WorkflowModuleException
- default module exception.
-
getView
public IView getView(IContext context, ICatalog catalog, String viewName) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves a view by its name.- Specified by:
getView
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.catalog
- TheICatalog
object.viewName
- The name of the view.- Returns:
- a
IView
object. - Throws:
WorkflowModuleException
- default module exception.
-
getViews
public Collection<? extends IView> getViews(IContext context, ICatalog catalog) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves all the views associated with the catalog.- Specified by:
getViews
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.catalog
- TheICatalog
object.- Returns:
- a
IView
object. - Throws:
WorkflowModuleException
- default module exception.
-
getView
public IView getView(IContext context, IWorkflowContainer workflowContainer, String viewName) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves a view by its name.- Specified by:
getView
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.workflowContainer
- TheIWorkflowContainer
object.viewName
- The name of the view.- Returns:
- a
IView
object. - Throws:
WorkflowModuleException
- default module exception.
-
getViews
public Collection<? extends IView> getViews(IContext context, IWorkflowContainer workflowContainer) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves all the views associated with the workflow container.- Specified by:
getViews
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.workflowContainer
- TheIWorkflowContainer
object.- Returns:
- a
IView
object. - Throws:
WorkflowModuleException
- default module exception.
-
getView
public IView getView(IContext context, IResourceDefinition resourceDefinition, String viewName) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves a view by its name.- Specified by:
getView
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.resourceDefinition
- TheIResourceDefinition
object.viewName
- The name of the view.- Returns:
- a
IView
object. - Throws:
WorkflowModuleException
- default module exception.
-
getViews
public Collection<? extends IView> getViews(IContext context, IResourceDefinition resourceDefinition) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves all the views associated with the resource definition.- Specified by:
getViews
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.resourceDefinition
- TheIResourceDefinition
object.- Returns:
- a
IView
object. - Throws:
WorkflowModuleException
- default module exception.
-
getProperties
public Collection<? extends IProperty> getProperties(IContext context, IResourceDefinition resourceDefinition) Description copied from interface:IBaseWorkflowModule
Gets all the properties of a specified definition.- Specified by:
getProperties
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.resourceDefinition
- aIResourceDefinition
object.- Returns:
- a collection of
IProperty
objects.
-
getProperty
Description copied from interface:IBaseWorkflowModule
Gets a property definition by specifying theIResourceDefinition
and its system name.- Specified by:
getProperty
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.resourceDefinition
- TheIResourceDefinition
object.name
- The system name of the property.- Returns:
- a
IProperty
object.
-
getTasks
public Collection<? extends ITask> getTasks(IContext context, IWorkflow workflow) throws WorkflowModuleException Get task from workflow- Parameters:
context
- the current contextworkflow
- the workflow- Returns:
- the task
- Throws:
WorkflowModuleException
- on error
-
getManualTasks
public Collection<? extends ITask> getManualTasks(IContext context, IWorkflow workflow) throws WorkflowModuleException Get manual task from workflow- Parameters:
context
- the current contextworkflow
- the workflow- Returns:
- the task
- Throws:
WorkflowModuleException
- on error
-
getOneTaskInstance
public ITaskInstance getOneTaskInstance(IContext context, IWorkflowInstance instance) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets one of the task instances (any).- Specified by:
getOneTaskInstance
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.instance
- TheIWorkflowInstance
object.- Returns:
- a
ITaskInstance
object. - Throws:
WorkflowModuleException
- default module exception.
-
getTaskInstances
public Collection<? extends ITaskInstance> getTaskInstances(IContext context, IWorkflowInstance instance, String name) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves all the task instances of a specified workflow instance filtered by the name of aITask
.- Specified by:
getTaskInstances
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.instance
- TheIWorkflowInstance
object.name
- The system name of ITask to use as a filter.- Returns:
- a collection of
ITaskInstance
- Throws:
WorkflowModuleException
- default module exception.
-
getTaskInstance
public ITaskInstance getTaskInstance(IContext context, IWorkflowInstance instance, String name) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets the started task instance associated with a specified task name.- Specified by:
getTaskInstance
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.instance
- TheIWorkflowInstance
object.name
- The system name of aITask
object.- Returns:
- a
ITaskInstance
object. - Throws:
WorkflowModuleException
- default module exception.
-
getTaskInstances
public Collection<? extends ITaskInstance> getTaskInstances(IContext context, IWorkflowInstance instance) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves all the task instances of a specified workflow instance.- Specified by:
getTaskInstances
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.instance
- TheIWorkflowInstance
object.- Returns:
- a collection of
ITaskInstance
- Throws:
WorkflowModuleException
- default module exception.
-
getManualTaskInstances
public Collection<? extends ITaskInstance> getManualTaskInstances(IContext context, IWorkflowInstance instance) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves all the manual task instances of a workflow instance.- Specified by:
getManualTaskInstances
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.instance
- TheIWorkflowInstance
object.- Returns:
- a collection of
ITaskInstance
- Throws:
WorkflowModuleException
- default module exception.
-
getManualTaskInstancesByStatus
public Collection<? extends ITaskInstance> getManualTaskInstancesByStatus(IContext context, int status) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves all the manual task instances for a status.- Specified by:
getManualTaskInstancesByStatus
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.status
- TheIWorkflowInstance.IStatus
status.- Returns:
- a collection of
ITaskInstance
- Throws:
WorkflowModuleException
- default module exception.
-
getManualTaskInstancesModifiedSince
public Collection<? extends ITaskInstance> getManualTaskInstancesModifiedSince(IContext context, Date date) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves all the manual task instances modified since.- Specified by:
getManualTaskInstancesModifiedSince
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.date
- The date.- Returns:
- a collection of
ITaskInstance
- Throws:
WorkflowModuleException
- default module exception.
-
getTask
Description copied from interface:IBaseWorkflowModule
Gets the definition of a task instance.- Specified by:
getTask
in interfaceIBaseWorkflowModule
- Parameters:
instance
- TheITaskInstance
object.- Returns:
- a
ITask
object. - Throws:
WorkflowModuleException
- default module exception.
-
getOperators
public Collection<? extends IOperator> getOperators(ITaskInstance instance) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves the operators of a task instance.- Specified by:
getOperators
in interfaceIBaseWorkflowModule
- Parameters:
instance
- theITaskInstance
object.- Returns:
- a collection of
IOperator
objects. - Throws:
WorkflowModuleException
- default module exception.
-
getStartedTaskInstances
public Collection<? extends ITaskInstance> getStartedTaskInstances(IContext context, IWorkflowInstance instance) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves all the started task instances of a workflow instance.- Specified by:
getStartedTaskInstances
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.instance
- TheIWorkflowInstance
object.- Returns:
- a collection of
ITaskInstance
- Throws:
WorkflowModuleException
- default module exception.
-
getEndedTaskInstances
public Collection<? extends ITaskInstance> getEndedTaskInstances(IContext context, IWorkflowInstance instance) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves all the ended task instances of a workflow instance.- Specified by:
getEndedTaskInstances
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.instance
- TheIWorkflowInstance
object.- Returns:
- a collection of
ITaskInstance
- Throws:
WorkflowModuleException
- default module exception.
-
getAbortedTaskInstances
public Collection<? extends ITaskInstance> getAbortedTaskInstances(IContext context, IWorkflowInstance instance) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Retrieves all the aborted task instances of a workflow instance.- Specified by:
getAbortedTaskInstances
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.instance
- TheIWorkflowInstance
object.- Returns:
- a collection of
ITaskInstance
- Throws:
WorkflowModuleException
- default module exception.
-
end
public void end(IContext context, ITaskInstance instance, IAction action, String comment) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Crosses a transition.- Specified by:
end
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.instance
- TheITaskInstance
object.action
- TheIAction
to use to cross the transition.comment
- The comment which will be displayed in the history entries.- Throws:
WorkflowModuleException
- default module exception.
-
end
public void end(IContext context, IUser addressee, ITaskInstance instance, IAction action, String comment) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Allows to cross a transition for another user.- Specified by:
end
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.addressee
- TheIUser
for whom to cross the transition.instance
- TheITaskInstance
object.action
- TheIAction
object.comment
- The comment which will be displayed in the history entries.- Throws:
WorkflowModuleException
- default module exception.
-
send
public void send(IContext context, ITaskInstance instance, IMailForm form, String comment) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Sends a mail using a specified mail form.- Specified by:
send
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.instance
- TheITaskInstance
object.form
- TheIMailForm
object.comment
- The comment which will be displayed in the history entries.- Throws:
WorkflowModuleException
- default module exception.
-
send
public void send(IContext context, IUser addressee, ITaskInstance instance, IMailForm form, String comment) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Sends a mail using a specified mail form.- Specified by:
send
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.addressee
-instance
- TheITaskInstance
object.form
- TheIMailForm
object.comment
- The comment which will be displayed in the history entries.- Throws:
WorkflowModuleException
- default module exception. default module exception.
-
send
public void send(IContext context, IWorkflow workflow, IResource resource, String formName, Collection<?> entries) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Allows to send a mail.- Specified by:
send
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.workflow
- TheIWorkflow
object.resource
- TheIResource
object created fromIBaseWorkflowModule.createGenericResource()
method.formName
- The system name of the form to use.entries
- A collection ofIUser
,IGroup
,InternetAddress
orString
objects.- Throws:
WorkflowModuleException
- default module exception.
-
send
public void send(IContext context, IWorkflow workflow, String formName, Collection<?> entries) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Allows to send a mail.- Specified by:
send
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.workflow
- TheIWorkflow
object.formName
- The system name of the form to use.entries
- A collection ofIUser
,IGroup
,InternetAddress
orString
objects.- Throws:
WorkflowModuleException
- default module exception.
-
send
public void send(IContext context, IWorkflowInstance workflowInstance, String formName, Collection<?> entries) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Allows to send a mail with a specific form to a mail recipient.- Specified by:
send
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.workflowInstance
- TheIWorkflowInstance
object.formName
- The system name of the form to use.entries
- A collection ofIUser
,IGroup
,InternetAddress
orString
objects.- Throws:
WorkflowModuleException
- default module exception.
-
createLinkedResource
public ILinkedResource createLinkedResource(IResource resource, String propertyName) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Creates a linked resource into a specified property table.Code sample :
// create a linked resource ILinkedResource childResource = getWorkflowModule().createLinkedResource( getWorkflowInstance(), "Details" ); // set some values childResource.setValue( "Date", new Timestamp(System.currentTimeMillis()) ); childResource.setValue( "Type", "Parking" ); childResource.setValue( "Cost", Float.valueOf(1) ); childResource.setValue( "Customer", "VDoc" ); childResource.setValue( "Comment", "My comment" ); // add the line to a collection ArrayList arrResource = new ArrayList(); arrResource.add( childResource ); // add the linked resources to the main document getWorkflowInstance().addLinkedResources( arrResource );
- Specified by:
createLinkedResource
in interfaceIBaseWorkflowModule
- Parameters:
resource
- The parent resource.propertyName
- The system name of the property.- Returns:
- The
ILinkedResource
object. - Throws:
WorkflowModuleException
- default module exception.
-
getLinkedResources
public Collection<? extends ILinkedResource> getLinkedResources(IResource resource, String propertyName) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets all the linked resources associated with a table property.- Specified by:
getLinkedResources
in interfaceIBaseWorkflowModule
- Parameters:
resource
- The parent resource.propertyName
- The system name of the property.- Returns:
- A collection of
ILinkedResource
objects. - Throws:
WorkflowModuleException
- default module exception.
-
getAttachments
public Collection<? extends IAttachment> getAttachments(IResource resource, String propertyName) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets all the attachments associated with a property.- Specified by:
getAttachments
in interfaceIBaseWorkflowModule
- Parameters:
resource
- The main resource object.propertyName
- The system name of the property.- Returns:
- A collection of
IAttachment
objects. - Throws:
WorkflowModuleException
- default module exception.
-
getAttachment
public IAttachment getAttachment(IResource resource, String propertyName, String fileName) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets an attachment by its file name.- Specified by:
getAttachment
in interfaceIBaseWorkflowModule
- Parameters:
resource
- The main resource object.propertyName
- The system name of the property.fileName
- The file name to retrieve.- Returns:
- An
IAttachment
object. - Throws:
WorkflowModuleException
- default module exception.
-
addAttachment
public IAttachment addAttachment(IResource resource, String propertyName, IAttachment attachment) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Adds an attachment from an attachment.- Specified by:
addAttachment
in interfaceIBaseWorkflowModule
- Parameters:
resource
- The main resource object.propertyName
- The system name of the property.attachment
- TheIAttachment
to add.- Returns:
- An
IAttachment
object. - Throws:
WorkflowModuleException
- default module exception.
-
addAttachment
public IAttachment addAttachment(IResource resource, String propertyName, String fileName, String fullPath) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Adds an attachment with its full path.- Specified by:
addAttachment
in interfaceIBaseWorkflowModule
- Parameters:
resource
- The main resource object.propertyName
- The system name of the property.fileName
- The name of the filefullPath
- The full path of the file to add.- Returns:
- An
IAttachment
object. - Throws:
WorkflowModuleException
- default module exception.
-
addAttachment
public IAttachment addAttachment(IResource resource, String propertyName, File file) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Adds an attachment as a java.io.File object.- Specified by:
addAttachment
in interfaceIBaseWorkflowModule
- Parameters:
resource
- The main resource object.propertyName
- The system name of the property.file
- TheFile
object.- Returns:
- An
IAttachment
object. - Throws:
WorkflowModuleException
- default module exception.
-
addAttachment
public IAttachment addAttachment(IResource resource, String propertyName, String fileName, InputStream input) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Adds an attachment as an java.io.InputStream object.- Specified by:
addAttachment
in interfaceIBaseWorkflowModule
- Parameters:
resource
- The main resource object.propertyName
- The system name of the property.fileName
- The name of the fileinput
- TheInputStream
object.- Returns:
- An
IAttachment
object. - Throws:
WorkflowModuleException
- default module exception.
-
getCatalog
Description copied from interface:IBaseWorkflowModule
Gets a catalog object from its identifier.- Specified by:
getCatalog
in interfaceIBaseWorkflowModule
- Parameters:
key
- AIStorageKey
object.- Returns:
- A
ICatalog
object. - Throws:
WorkflowModuleException
- default module exception.
-
getRole
Deprecated.Description copied from interface:IBaseWorkflowModule
Gets a role object from its identifier.- Specified by:
getRole
in interfaceIBaseWorkflowModule
- Parameters:
key
- AIStorageKey
object.- Returns:
- A
IRole
object. - Throws:
WorkflowModuleException
- default module exception.
-
getOperatorRole
Description copied from interface:IBaseWorkflowModule
Gets a role object from its identifier.- Specified by:
getOperatorRole
in interfaceIBaseWorkflowModule
- Parameters:
key
- AIStorageKey
object.- Returns:
- A
IOperatorRole
object. - Throws:
WorkflowModuleException
- default module exception.
-
getWorkflowContainer
Description copied from interface:IBaseWorkflowModule
Gets a workflow container object from its identifier.- Specified by:
getWorkflowContainer
in interfaceIBaseWorkflowModule
- Parameters:
key
- AIStorageKey
object.- Returns:
- A
IWorkflowContainer
object. - Throws:
WorkflowModuleException
- default module exception.
-
getWorkflow
Description copied from interface:IBaseWorkflowModule
Gets a workflow object from its identifier.- Specified by:
getWorkflow
in interfaceIBaseWorkflowModule
- Parameters:
key
- AIStorageKey
object.- Returns:
- A
IWorkflow
object. - Throws:
WorkflowModuleException
- default module exception.
-
getTask
Description copied from interface:IBaseWorkflowModule
Gets a task object from its identifier.- Specified by:
getTask
in interfaceIBaseWorkflowModule
- Parameters:
key
- AIStorageKey
object.- Returns:
- A
ITask
object. - Throws:
WorkflowModuleException
- default module exception.
-
getAction
Description copied from interface:IBaseWorkflowModule
Gets an action object from its identifier.- Specified by:
getAction
in interfaceIBaseWorkflowModule
- Parameters:
key
- AIStorageKey
object.- Returns:
- A
IAction
object. - Throws:
WorkflowModuleException
- default module exception.
-
getResourceDefinition
Description copied from interface:IBaseWorkflowModule
Gets a resource definition object from its identifier.- Specified by:
getResourceDefinition
in interfaceIBaseWorkflowModule
- Parameters:
key
- AIStorageKey
object.- Returns:
- A
IResourceDefinition
object. - Throws:
WorkflowModuleException
- default module exception.
-
getProperty
Description copied from interface:IBaseWorkflowModule
Gets a property object from its identifier.- Specified by:
getProperty
in interfaceIBaseWorkflowModule
- Parameters:
key
- AIStorageKey
object.- Returns:
- A
IProperty
object. - Throws:
WorkflowModuleException
- default module exception.
-
getWorkflowInstance
Description copied from interface:IBaseWorkflowModule
Gets aIWorkflowInstance
object from an object.- Specified by:
getWorkflowInstance
in interfaceIBaseWorkflowModule
- Parameters:
document
- Any of the following values:com.axemble.vdp.treatment.interfaces.Treatment
- Returns:
- A
IWorkflowInstance
object. - Throws:
WorkflowModuleException
- default module exception.
-
getWorkflowInstance
protected IWorkflowInstance getWorkflowInstance(com.axemble.vdp.ui.core.document.CoreDocument document) throws WorkflowModuleException - Throws:
WorkflowModuleException
-
getWorkflowInstance
Description copied from interface:IBaseWorkflowModule
Gets a workflow instance object from its identifier.- Specified by:
getWorkflowInstance
in interfaceIBaseWorkflowModule
- Parameters:
key
- AIStorageKey
object.- Returns:
- A
IWorkflowInstance
object. - Throws:
WorkflowModuleException
- default module exception.
-
getResource
Description copied from interface:IBaseWorkflowModule
Gets aIResource
object from an object.- Specified by:
getResource
in interfaceIBaseWorkflowModule
- Parameters:
document
- Any of the following values:com.axemble.vdp.resource.interfaces.Resource com.axemble.vdp.ui.core.document.CoreDocument com.axemble.vdp.ui.core.document.GenericDocument
- Returns:
- A
IResource
object. - Throws:
WorkflowModuleException
- default module exception.
-
getResource
protected IResource getResource(com.axemble.vdp.ui.core.document.CoreDocument document) throws WorkflowModuleException - Throws:
WorkflowModuleException
-
findStorageResourceByReference
public IStorageResource findStorageResourceByReference(IContext context, IResourceDefinition resourceDefinition, String reference) Description copied from interface:IBaseWorkflowModule
Find a storage resource object by specifying theIResourceDefinition
object, its reference.- Specified by:
findStorageResourceByReference
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.resourceDefinition
- TheIResourceDefinition
object.reference
- The reference to set.- Returns:
- a
IStorageResource
object or null.
-
createStorageResource
public IStorageResource createStorageResource(IContext context, IResourceDefinition resourceDefinition, String reference) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Creates a storage resource object by specifying theIResourceDefinition
object, its reference.- Specified by:
createStorageResource
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.resourceDefinition
- TheIResourceDefinition
object.reference
- The reference to set.- Returns:
- a
IStorageResource
object. - Throws:
WorkflowModuleException
- default module exception.
-
createStorageResource
public IStorageResource createStorageResource(IContext context, IResourceDefinition resourceDefinition, String reference, String label) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Creates a storage resource object by specifying theIResourceDefinition
object, its reference, and its label.- Specified by:
createStorageResource
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.resourceDefinition
- TheIResourceDefinition
object.reference
- The reference to set.label
- The label to set.- Returns:
- a
IStorageResource
object. - Throws:
WorkflowModuleException
- default module exception.
-
getOperator
Description copied from interface:IBaseWorkflowModule
Gets an operator object from its identifier.- Specified by:
getOperator
in interfaceIBaseWorkflowModule
- Parameters:
key
- AIStorageKey
object.- Returns:
- A
IOperator
object. - Throws:
WorkflowModuleException
- default module exception.
-
getOperatorByLogin
Description copied from interface:IBaseWorkflowModule
Gets anIOperator
from a user login.- Specified by:
getOperatorByLogin
in interfaceIBaseWorkflowModule
- Parameters:
login
- The user login- Returns:
- A
IOperator
object. - Throws:
WorkflowModuleException
- default module exception.
-
getResource
Description copied from interface:IBaseWorkflowModule
Gets a resource object from its identifier.- Specified by:
getResource
in interfaceIBaseWorkflowModule
- Parameters:
key
- AIStorageKey
object.- Returns:
- A
IResource
object. - Throws:
WorkflowModuleException
- default module exception.
-
getTaskInstance
Description copied from interface:IBaseWorkflowModule
Gets a task instance object from its identifier.- Specified by:
getTaskInstance
in interfaceIBaseWorkflowModule
- Parameters:
key
- AIStorageKey
object.- Returns:
- A
ITaskInstance
object. - Throws:
WorkflowModuleException
- default module exception.
-
getCatalog
Description copied from interface:IBaseWorkflowModule
Gets aICatalog
object from a resource definitino.- Specified by:
getCatalog
in interfaceIBaseWorkflowModule
- Parameters:
resourceDefinition
- A resource definition.- Returns:
- A
ICatalog
object. - Throws:
WorkflowModuleException
- default module exception.
-
getGroup
Get a group from its id- Parameters:
id
- the group's id- Returns:
- the group
- Throws:
WorkflowModuleException
- on error
-
getGroupByName
Description copied from interface:IBaseWorkflowModule
Gets a group by its name- Specified by:
getGroupByName
in interfaceIBaseWorkflowModule
- Parameters:
name
- The system name of the group.- Returns:
- A
IGroup
object. - Throws:
WorkflowModuleException
- default module exception.
-
getWorkflowContainer
Get workflow container from its id- Parameters:
id
- the workflow container's id- Returns:
- the workflow container
- Throws:
WorkflowModuleException
- on error
-
getWorkflow
Get workflow from its id- Parameters:
id
- the workflow's id- Returns:
- the workflow
- Throws:
WorkflowModuleException
- on error
-
getWorkflowInstance
Description copied from interface:IBaseWorkflowModule
Gets aIWorkflowInstance
object from its string identifier.- Specified by:
getWorkflowInstance
in interfaceIBaseWorkflowModule
- Parameters:
id
- A string identifier.- Returns:
- A
IWorkflowInstance
object. - Throws:
WorkflowModuleException
- default module exception.
-
getTaskInstance
Description copied from interface:IBaseWorkflowModule
Gets aITaskInstance
object from its string identifier.- Specified by:
getTaskInstance
in interfaceIBaseWorkflowModule
- Parameters:
id
- A string identifier.- Returns:
- A
ITaskInstance
object. - Throws:
WorkflowModuleException
- default module exception.
-
getOperator
Description copied from interface:IBaseWorkflowModule
Gets aIOperator
object from its string identifier.- Specified by:
getOperator
in interfaceIBaseWorkflowModule
- Parameters:
id
- A string identifier.- Returns:
- A
IOperator
object. - Throws:
WorkflowModuleException
- default module exception.
-
getResource
Description copied from interface:IBaseWorkflowModule
Gets aIResource
object from its string identifier.- Specified by:
getResource
in interfaceIBaseWorkflowModule
- Parameters:
id
- A string identifier.- Returns:
- A
IResource
object. - Throws:
WorkflowModuleException
- default module exception.
-
getResources
public Collection<? extends IResource> getResources(IContext context, IResourceDefinition resourceDefinition) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets a collection ofIResource
objects from a resource definition.- Specified by:
getResources
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.resourceDefinition
- TheIResourceDefinition
object.- Returns:
- a Collection of
IResource
object. - Throws:
WorkflowModuleException
- default module exception.
-
getResources
public Collection<? extends IResource> getResources(IContext context, ICatalog catalog) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets a collection ofIResource
objects from a catalog- Specified by:
getResources
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.catalog
- TheICatalog
object.- Returns:
- a Collection of
IResource
object. - Throws:
WorkflowModuleException
- default module exception.
-
getParentInstance
public IWorkflowInstance getParentInstance(ILinkedResource linkedResource) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets the parent instance of a linked resource.- Specified by:
getParentInstance
in interfaceIBaseWorkflowModule
- Parameters:
linkedResource
- The linked resource.- Returns:
- The
IWorkflowInstance
object. - Throws:
WorkflowModuleException
- default module exception.
-
getExternalElements
public Collection<?> getExternalElements(IResource resource, String propertyName) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets a collection ofIElement
objects from a multiple selector property.- Specified by:
getExternalElements
in interfaceIBaseWorkflowModule
- Parameters:
resource
- The main resource object.propertyName
- The system name of the property.- Returns:
- A collection of
IElement
objects. - Throws:
WorkflowModuleException
- default module exception.
-
getExternalGroup
public IGroup getExternalGroup(IResource resource, String propertyName) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets aIGroup
object from a single group selector property.- Specified by:
getExternalGroup
in interfaceIBaseWorkflowModule
- Parameters:
resource
- The main resource object.propertyName
- The system name of the property.- Returns:
- A
IGroup
object. - Throws:
WorkflowModuleException
- default module exception.
-
getExternalLocalization
public ILocalization getExternalLocalization(IResource resource, String propertyName) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets aILocalization
object from a single localization selector property.- Specified by:
getExternalLocalization
in interfaceIBaseWorkflowModule
- Parameters:
resource
- The main resource object.propertyName
- The system name of the property.- Returns:
- A
ILocalization
object. - Throws:
WorkflowModuleException
- default module exception.
-
getExternalOrganization
public IOrganization getExternalOrganization(IResource resource, String propertyName) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets aIOrganization
object from a single organization selector property.- Specified by:
getExternalOrganization
in interfaceIBaseWorkflowModule
- Parameters:
resource
- The main resource object.propertyName
- The system name of the property.- Returns:
- A
IOrganization
object. - Throws:
WorkflowModuleException
- default module exception.
-
getExternalUser
public IUser getExternalUser(IResource resource, String propertyName) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets aIUser
object from a single user selector property.- Specified by:
getExternalUser
in interfaceIBaseWorkflowModule
- Parameters:
resource
- The main resource object.propertyName
- The system name of the property.- Returns:
- A
IUser
object. - Throws:
WorkflowModuleException
- default module exception.
-
getExternalFile
public IFile getExternalFile(IResource resource, String propertyName) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets aIFile
object from a single file selector property.- Specified by:
getExternalFile
in interfaceIBaseWorkflowModule
- Parameters:
resource
- The main resource object.propertyName
- The system name of the property.- Returns:
- A
IFile
object. - Throws:
WorkflowModuleException
- default module exception.
-
getExternalFolder
public IFolder getExternalFolder(IResource resource, String propertyName) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets aIFolder
object from a single folder selector property.- Specified by:
getExternalFolder
in interfaceIBaseWorkflowModule
- Parameters:
resource
- The main resource object.propertyName
- The system name of the property.- Returns:
- A
IFolder
object. - Throws:
WorkflowModuleException
- default module exception.
-
getExternalLibrary
public ILibrary getExternalLibrary(IResource resource, String propertyName) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets aILibrary
object from a single library selector property.- Specified by:
getExternalLibrary
in interfaceIBaseWorkflowModule
- Parameters:
resource
- The main resource object.propertyName
- The system name of the property.- Returns:
- A
ILibrary
object. - Throws:
WorkflowModuleException
- default module exception.
-
setExternalElements
public void setExternalElements(IResource resource, String propertyName, Collection<?> elements) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Sets aIElement
to a multiple selector property.- Specified by:
setExternalElements
in interfaceIBaseWorkflowModule
- Parameters:
resource
- The main resource object.propertyName
- The system name of the property.elements
- A collection ofIElement
objects.- Throws:
WorkflowModuleException
- default module exception.
-
setExternalUser
public void setExternalUser(IResource resource, String propertyName, IUser user) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Sets aIUser
to a single selector property.- Specified by:
setExternalUser
in interfaceIBaseWorkflowModule
- Parameters:
resource
- The main resource object.propertyName
- The system name of the property.user
- AIUser
object.- Throws:
WorkflowModuleException
- default module exception.
-
setExternalGroup
public void setExternalGroup(IResource resource, String propertyName, IGroup group) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Sets aIGroup
to a single selector property.- Specified by:
setExternalGroup
in interfaceIBaseWorkflowModule
- Parameters:
resource
- The main resource object.propertyName
- The system name of the property.group
- AIGroup
object.- Throws:
WorkflowModuleException
- default module exception.
-
setExternalLocalization
public void setExternalLocalization(IResource resource, String propertyName, ILocalization localization) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Sets aILocalization
to a single selector property.- Specified by:
setExternalLocalization
in interfaceIBaseWorkflowModule
- Parameters:
resource
- The main resource object.propertyName
- The system name of the property.localization
- AILocalization
object.- Throws:
WorkflowModuleException
- default module exception.
-
setExternalOrganization
public void setExternalOrganization(IResource resource, String propertyName, IOrganization organization) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Sets aIOrganization
to a single selector property.- Specified by:
setExternalOrganization
in interfaceIBaseWorkflowModule
- Parameters:
resource
- The main resource object.propertyName
- The system name of the property.organization
- AIOrganization
object.- Throws:
WorkflowModuleException
- default module exception.
-
setExternalFile
public void setExternalFile(IResource resource, String propertyName, IFile file) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Sets aIFile
to a single selector property.- Specified by:
setExternalFile
in interfaceIBaseWorkflowModule
- Parameters:
resource
- The main resource object.propertyName
- The system name of the property.file
- AIFile
object.- Throws:
WorkflowModuleException
- default module exception.
-
setExternalFolder
public void setExternalFolder(IResource resource, String propertyName, IFolder folder) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Sets aIFolder
to a single selector property.- Specified by:
setExternalFolder
in interfaceIBaseWorkflowModule
- Parameters:
resource
- The main resource object.propertyName
- The system name of the property.folder
- AIFolder
object.- Throws:
WorkflowModuleException
- default module exception.
-
setExternalLibrary
public void setExternalLibrary(IResource resource, String propertyName, ILibrary library) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Sets aILibrary
to a single selector property.- Specified by:
setExternalLibrary
in interfaceIBaseWorkflowModule
- Parameters:
resource
- The main resource object.propertyName
- The system name of the property.library
- AILibrary
object.- Throws:
WorkflowModuleException
- default module exception.
-
getSearchController
public ISearchController getSearchController(IJdbcReference reference) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets a search controller object by specifying a JDBC external reference.- Specified by:
getSearchController
in interfaceIBaseWorkflowModule
- Parameters:
reference
- TheIJdbcReference
object.- Returns:
- The
ISearchController
object. - Throws:
WorkflowModuleException
- default module exception.
-
getSearchController
public ISearchController getSearchController(IConnectionDefinition connectionDefinition) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets a search controller object by specifying a ConnectionDefinition object.- Specified by:
getSearchController
in interfaceIBaseWorkflowModule
- Parameters:
connectionDefinition
- TheIConnectionDefinition
object.- Returns:
- The
ISearchController
object. - Throws:
WorkflowModuleException
- default module exception.
-
getSearchController
public ISearchController getSearchController(IDataSourceReference reference) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets a search controller object by specifying an external data source.- Specified by:
getSearchController
in interfaceIBaseWorkflowModule
- Parameters:
reference
- TheIDataSourceReference
object.- Returns:
- The
ISearchController
object. - Throws:
WorkflowModuleException
- default module exception.
-
getSearchController
Description copied from interface:IBaseWorkflowModule
Gets the defaultISearchController
object.- Specified by:
getSearchController
in interfaceIBaseWorkflowModule
- Returns:
- The default
ISearchController
object. - Throws:
WorkflowModuleException
- default module exception.
-
getSecurityController
public ISecurityController getSecurityController(ISecuritySupport securitySupport) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets a security controller on a specified object.- Specified by:
getSecurityController
in interfaceIBaseWorkflowModule
- Parameters:
securitySupport
- Any IElement that implements ISecuritySupport interface.- Returns:
- The
ISecurityController
object. - Throws:
WorkflowModuleException
- default module exception.
-
getArchivingController
Description copied from interface:IBaseWorkflowModule
Gets a archiving controller to archiveIElement
objects.- Specified by:
getArchivingController
in interfaceIBaseWorkflowModule
- Returns:
- A
IArchivingController
object. - Throws:
WorkflowModuleException
- default module exception.
-
getDelegationController
Description copied from interface:IBaseWorkflowModule
Gets a delegation controller to delegateIDelegationSupport
objects.- Specified by:
getDelegationController
in interfaceIBaseWorkflowModule
- Returns:
- A
IDelegationController
object. - Throws:
WorkflowModuleException
- default module exception.
-
getTransformer
Description copied from interface:IBaseWorkflowModule
Gets a transformer to transformIResource
object.- Specified by:
getTransformer
in interfaceIBaseWorkflowModule
- Returns:
- A
ITransformer
object. - Throws:
WorkflowModuleException
- default module exception.
-
getViewController
Deprecated.Description copied from interface:IBaseWorkflowModule
Gets a view controller to searchIResource
objects through their properties.- Specified by:
getViewController
in interfaceIBaseWorkflowModule
- Returns:
- A
IViewController
object. - Throws:
WorkflowModuleException
- default module exception.
-
getViewController
Description copied from interface:IBaseWorkflowModule
Gets a view controller to searchIResource
objects through their properties.- Specified by:
getViewController
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.- Returns:
- A
IViewController
object. - Throws:
WorkflowModuleException
- default module exception.
-
getViewController
@Deprecated public IViewController getViewController(Class natureClass) throws WorkflowModuleException Deprecated.Description copied from interface:IBaseWorkflowModule
Gets a view controller to searchIResource
objects through their properties.- Specified by:
getViewController
in interfaceIBaseWorkflowModule
- Parameters:
natureClass
- : The class of the searched objectsIWorkflowInstance
,ITaskInstance
,IResource
}- Returns:
- A
IViewController
object. - Throws:
WorkflowModuleException
- default module exception.
-
getViewController
public IViewController getViewController(IContext context, Class natureClass) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets a view controller to searchIResource
objects through their properties.- Specified by:
getViewController
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.natureClass
- : The class of the searched objectsIWorkflowInstance
,ITaskInstance
,IResource
}- Returns:
- A
IViewController
object. - Throws:
WorkflowModuleException
- default module exception.
-
getViewController
@Deprecated public IViewController getViewController(IProject project, com.axemble.vdp.views.query.Definition definition) throws WorkflowModuleException Deprecated.Internal method- Throws:
WorkflowModuleException
-
getViewController
public IViewController getViewController(IContext context, IProject project, com.axemble.vdp.views.query.Definition definition) throws WorkflowModuleException Internal methodGet a view controller build with the given parameters
- Parameters:
context
- the current contextproject
- the projectdefinition
- the definition- Returns:
- the view controller
- Throws:
WorkflowModuleException
- on error
-
getViewController
@Deprecated public IViewController getViewController(IProject project, InputStream inputStream) throws WorkflowModuleException Deprecated.Description copied from interface:IBaseWorkflowModule
Gets a view controller to searchIResource
objects through their properties.- Specified by:
getViewController
in interfaceIBaseWorkflowModule
- Parameters:
project
- The current projectinputStream
- The java.io.InputStream XML entry.- Returns:
- A
IViewController
object. - Throws:
WorkflowModuleException
- default module exception.
-
getViewController
public IViewController getViewController(IContext context, IProject project, InputStream inputStream) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets a view controller to searchIResource
objects through their properties.- Specified by:
getViewController
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.project
- The current projectinputStream
- The java.io.InputStream XML entry.- Returns:
- A
IViewController
object. - Throws:
WorkflowModuleException
- default module exception.
-
getTaskViewTransformer
Description copied from interface:IBaseWorkflowModule
Gets a task view transformer to transformITaskInstance
objects.- Specified by:
getTaskViewTransformer
in interfaceIBaseWorkflowModule
- Returns:
- A
ITaskViewTransformer
object. - Throws:
WorkflowModuleException
- default module exception.
-
getResourceViewTransformer
Description copied from interface:IBaseWorkflowModule
Gets a resource view transformer to transformIResource
objects.- Specified by:
getResourceViewTransformer
in interfaceIBaseWorkflowModule
- Returns:
- A
IResourceViewTransformer
object. - Throws:
WorkflowModuleException
- default module exception.
-
getWorkflowViewTransformer
Description copied from interface:IBaseWorkflowModule
Gets a workflow view transformer to transformIWorkflow
objects.- Specified by:
getWorkflowViewTransformer
in interfaceIBaseWorkflowModule
- Returns:
- A
IWorkflowViewTransformer
object. - Throws:
WorkflowModuleException
- default module exception.
-
getWorkflowContainerViewTransformer
public IWorkflowContainerViewTransformer getWorkflowContainerViewTransformer() throws WorkflowModuleExceptionDescription copied from interface:IBaseWorkflowModule
Gets a workflow container view transformer to transformIWorkflowContainer
objects.- Specified by:
getWorkflowContainerViewTransformer
in interfaceIBaseWorkflowModule
- Returns:
- A
IWorkflowContainerViewTransformer
object. - Throws:
WorkflowModuleException
- default module exception.
-
getCatalogViewTransformer
Description copied from interface:IBaseWorkflowModule
Gets a catalog view transformer to transformICatalog
objects.- Specified by:
getCatalogViewTransformer
in interfaceIBaseWorkflowModule
- Returns:
- A
ICatalogViewTransformer
object. - Throws:
WorkflowModuleException
- default module exception.
-
getSearchViewTransformer
Description copied from interface:IBaseWorkflowModule
Gets a search view transformer to transformIResource
objects.- Specified by:
getSearchViewTransformer
in interfaceIBaseWorkflowModule
- Returns:
- A
ISearchViewTransformer
object. - Throws:
WorkflowModuleException
- default module exception.
-
generateReference
public String generateReference(IResourceDefinition resourceDefinition) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Evaluate the next reference based on the format specified on the Designer tool.- Specified by:
generateReference
in interfaceIBaseWorkflowModule
- Parameters:
resourceDefinition
- The resource definition object.- Returns:
- The evaluated reference.
- Throws:
WorkflowModuleException
- default module exception.
-
generateReference
public String generateReference(IResourceDefinition resourceDefinition, String format) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Evaluate the next reference based on the passed format.- Specified by:
generateReference
in interfaceIBaseWorkflowModule
- Parameters:
resourceDefinition
- TheIResourceDefinition
object.format
- The format to use to evaluate the next reference.- Returns:
- The evaluated reference.
- Throws:
WorkflowModuleException
-
generateReference
Description copied from interface:IBaseWorkflowModule
Evaluate the next reference based specified format.- Specified by:
generateReference
in interfaceIBaseWorkflowModule
- Parameters:
resource
- The resource to be created.format
- An XML format definition.- Returns:
- The evaluated reference.
- Throws:
WorkflowModuleException
- default module exception.
-
generateReference
Description copied from interface:IBaseWorkflowModule
Evaluate the next reference based on the format specified on the Designer tool.- Specified by:
generateReference
in interfaceIBaseWorkflowModule
- Parameters:
resource
- The resource to be created.- Returns:
- The evaluated reference.
- Throws:
WorkflowModuleException
- default module exception.
-
generateReference
Description copied from interface:IBaseWorkflowModule
Evaluate the next reference based on the specified format.- Specified by:
generateReference
in interfaceIBaseWorkflowModule
- Parameters:
resource
- The resource to be created.format
- The format to use to evaluate the next reference.- Returns:
- The evaluated reference.
- Throws:
WorkflowModuleException
- default module exception.
-
generateChrono
Description copied from interface:IBaseWorkflowModule
Evaluate the next chrono based on the format specified on the Designer tool.- Specified by:
generateChrono
in interfaceIBaseWorkflowModule
- Parameters:
resourceDefinition
- The resource definition object- Returns:
- The evaluated chrono.
- Throws:
WorkflowModuleException
- default module exception.
-
createGenericResource
Description copied from interface:IBaseWorkflowModule
Creates a generic resource for mail purposes.- Specified by:
createGenericResource
in interfaceIBaseWorkflowModule
- Returns:
- The
IResource
object. - Throws:
WorkflowModuleException
- default module exception.
-
execute
Description copied from interface:IBaseWorkflowModule
Allows to execute an agent.- Specified by:
execute
in interfaceIBaseWorkflowModule
- Parameters:
agent
- TheIAgent
to execute.- Throws:
WorkflowModuleException
- default module exception.
-
execute
Description copied from interface:IBaseWorkflowModule
Allows to execute an agent.- Specified by:
execute
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.agent
- TheIAgent
to execute.- Throws:
WorkflowModuleException
- default module exception.
-
getAgent
Description copied from interface:IBaseWorkflowModule
Gets an agent from its name.- Specified by:
getAgent
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.name
- The name of the agent.- Returns:
- a
IAgent
object. - Throws:
WorkflowModuleException
- default module exception.
-
addChild
Description copied from interface:IBaseWorkflowModule
Adds a group to a role.- Specified by:
addChild
in interfaceIBaseWorkflowModule
- Parameters:
group
- The group to add.role
- The role object.- Throws:
WorkflowModuleException
- default module exception.
-
addMember
Description copied from interface:IBaseWorkflowModule
Adds a user to a role.- Specified by:
addMember
in interfaceIBaseWorkflowModule
- Parameters:
user
- The user to add.role
- The role object.- Throws:
WorkflowModuleException
- default module exception.
-
evaluatedHtml
Description copied from interface:IBaseWorkflowModule
Evaluates the form and returns the HTML content as a java.lang.String object.- Specified by:
evaluatedHtml
in interfaceIBaseWorkflowModule
- Parameters:
resource
- TheIResource
object to evaluate with.mailForm
- TheIMailForm
object.- Returns:
- A java.lang.String object.
- Throws:
WorkflowModuleException
- default module exception. default module exception.
-
buildMailMessage
public String buildMailMessage(IResource resource, IMailForm mailForm, String language) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Evaluates the form and returns the HTML content as a java.lang.String object.- Specified by:
buildMailMessage
in interfaceIBaseWorkflowModule
- Parameters:
resource
- TheIResource
object to evaluate with.mailForm
- TheIMailForm
object.language
- the mail language.- Returns:
- A java.lang.String object.
- Throws:
WorkflowModuleException
- default module exception. default module exception.
-
evaluatedHtml
public String evaluatedHtml(ITaskInstance taskInstance, IMailForm mailForm) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Evaluates the form and returns the HTML content as a java.lang.String object.- Specified by:
evaluatedHtml
in interfaceIBaseWorkflowModule
- Parameters:
taskInstance
- TheITaskInstance
object to evaluate with.mailForm
- TheIMailForm
object.- Returns:
- A java.lang.String object.
- Throws:
WorkflowModuleException
- default module exception. default module exception.
-
buildMailMessage
public String buildMailMessage(ITaskInstance taskInstance, IMailForm mailForm, String language) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Evaluates the form and returns the HTML content as a java.lang.String object.- Specified by:
buildMailMessage
in interfaceIBaseWorkflowModule
- Parameters:
taskInstance
- TheITaskInstance
object to evaluate with.mailForm
- TheIMailForm
object.language
- the mail language.- Returns:
- A java.lang.String object.
- Throws:
WorkflowModuleException
- default module exception. default module exception.
-
evaluatedMailForm
public MailMessage evaluatedMailForm(IResource resource, IMailForm mailForm, String language) throws WorkflowModuleException Evaluate mail form- Parameters:
resource
- the current resourcemailForm
- TheIMailForm
object.language
- the mail language.- Returns:
- the mail message
- Throws:
WorkflowModuleException
- on error
-
evaluatedMailForm
public MailMessage evaluatedMailForm(ITaskInstance taskInstance, IMailForm mailForm, String language) throws WorkflowModuleException Evaluate mail form- Parameters:
taskInstance
- the current task instancemailForm
- TheIMailForm
object.language
- the mail language.- Returns:
- the mail message
- Throws:
WorkflowModuleException
- on error
-
send
public void send(IContext context, ITaskInstance taskInstance, IMailForm mailForm, Collection<?> entries, String subject, String content) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Sends a mail by specifying the subject and the content of the body.- Specified by:
send
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.taskInstance
- TheITaskInstance
object to evaluate with.mailForm
- TheIMailForm
object.entries
- A collection ofIUser
,IGroup
,InternetAddress
orString
objects.subject
- The subject of the mail.content
- The content of the mail.- Throws:
WorkflowModuleException
- default module exception. default module exception.
-
send
public void send(IContext context, IResource resource, IMailForm mailForm, Collection<?> entries, String subject, String content) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Sends a mail by specifying the subject and the content of the body.- Specified by:
send
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.resource
- TheIResource
object to evaluate with.mailForm
- TheIMailForm
object.entries
- A collection ofIUser
,IGroup
,InternetAddress
orString
objects.subject
- The subject of the mail.content
- The content of the mail.- Throws:
WorkflowModuleException
- default module exception. default module exception.
-
send
protected final void send(IContext context, IResource resource, ITaskInstance taskInstance, IMailForm mailForm, Collection<?> entries, String subject, String content) throws WorkflowModuleException - Throws:
WorkflowModuleException
-
getMailForms
public Collection<? extends IMailForm> getMailForms(IContext context, IWorkflow workflow) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets all the mail forms from a specifiedIWorkflow
object.- Specified by:
getMailForms
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.workflow
- TheIWorkflow
object.- Returns:
- A collection of
IMailForm
objects. - Throws:
WorkflowModuleException
- default module exception. default module exception.
-
getMailForms
public Collection<? extends IMailForm> getMailForms(IContext context, IWorkflow workflow, String startsWith) throws WorkflowModuleException - Specified by:
getMailForms
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.workflow
- TheIWorkflow
object.startsWith
- The start part of the form name.- Returns:
- A collection of
IMailForm
objects. - Throws:
WorkflowModuleException
- default module exception. default module exception.
-
getMailForm
public IMailForm getMailForm(IContext context, IWorkflow workflow, String mailFormName) throws WorkflowModuleException - Specified by:
getMailForm
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.workflow
- TheIWorkflow
object.mailFormName
- The name of the form.- Returns:
- a
IMailForm
object. - Throws:
WorkflowModuleException
- default module exception. default module exception.
-
getForm
public IForm getForm(IContext context, IWorkflow workflow, String formName) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets a workflow form by its name.- Specified by:
getForm
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.workflow
- TheIWorkflow
object.formName
- The name of the form.- Returns:
- a
IForm
object. - Throws:
WorkflowModuleException
- default module exception. default module exception.
-
getForm
public IForm getForm(IContext context, IResourceDefinition resourceDefinition, String formName) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets a resource definition form by its name.- Specified by:
getForm
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.resourceDefinition
- TheIResourceDefinition
object.formName
- The name of the form.- Returns:
- a
IForm
object. - Throws:
WorkflowModuleException
- default module exception. default module exception.
-
getForm
Description copied from interface:IBaseWorkflowModule
Gets a task form by its name.- Specified by:
getForm
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.task
- TheITask
object.formName
- The name of the form.- Returns:
- a
IForm
object. - Throws:
WorkflowModuleException
- default module exception. default module exception.
-
getForm
public IForm getForm(IContext context, IAction action, String formName) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets a action form by its name.- Specified by:
getForm
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.action
- TheIAction
object.formName
- The name of the form.- Returns:
- a
IForm
object. - Throws:
WorkflowModuleException
- default module exception. default module exception.
-
getSubForm
public IForm getSubForm(IContext context, IWorkflow workflow, String formName) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Gets a sub form by its name.- Specified by:
getSubForm
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.workflow
- TheIWorkflow
object.formName
- The name of the form.- Returns:
- a
IForm
object. - Throws:
WorkflowModuleException
- default module exception. default module exception.
-
getGenericViewTransformer
- Specified by:
getGenericViewTransformer
in interfaceIBaseWorkflowModule
- Throws:
WorkflowModuleException
-
getResourceHistory
- Specified by:
getResourceHistory
in interfacecom.axemble.vdoc.core.interfaces.InternalProcessModule
-
getResourceController
Description copied from interface:IWorkflowModule
Gets the resource controller object.- Specified by:
getResourceController
in interfaceIWorkflowModule
- Parameters:
resource
- The main resource to work on.- Returns:
- A
IResourceController
object. - Throws:
WorkflowModuleException
- default module exception.
-
getController
Description copied from interface:IWorkflowModule
Gets the resource controller object.- Specified by:
getController
in interfaceIWorkflowModule
- Parameters:
resource
- The main resource to work on.- Returns:
- A
IResourceController
object. - Throws:
WorkflowModuleException
- default module exception.
-
getTaskInstanceTransformer
Description copied from interface:IBaseWorkflowModule
Gets a task transformer to transformITaskInstance
object.- Specified by:
getTaskInstanceTransformer
in interfaceIBaseWorkflowModule
- Returns:
- A
ITaskInstanceTransformer
object. - Throws:
WorkflowModuleException
- default module exception.
-
getViewTransformer
- Throws:
WorkflowModuleException
-
send
public void send(IContext context, ITaskInstance taskInstance, IMailForm mailForm, Collection<? extends IUser> mailTo, String comment) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Sends a mail by specifying the subject and the content of the body.- Specified by:
send
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.taskInstance
- TheITaskInstance
object to evaluate with.mailForm
- TheIMailForm
object.mailTo
- A collection ofIUser
,IGroup
,InternetAddress
orString
objects.comment
- The comment which will be displayed in the history entries.- Throws:
WorkflowModuleException
-
send
public void send(IContext context, IResource resource, IMailForm mailForm, Collection<? extends IUser> mailTo, String comment) throws WorkflowModuleException Description copied from interface:IBaseWorkflowModule
Sends a mail by specifying the subject and the content of the body.- Specified by:
send
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.resource
- TheIResource
object to evaluate with.mailForm
- TheIMailForm
object.mailTo
- A collection ofIUser
,IGroup
,InternetAddress
orString
objects.comment
- The comment which will be displayed in the history entries.- Throws:
WorkflowModuleException
-
lock
public void lock(IContext context, IWorkflowInstance workflowInstance, int delay) throws WorkflowModuleException Description copied from interface:IWorkflowModule
Allows to lock workflow instance.- Specified by:
lock
in interfaceIWorkflowModule
- Parameters:
context
- TheIContext
execution context.workflowInstance
- TheIWorkflowInstance
object.delay
- lock delay in second- Throws:
WorkflowModuleException
- default module exception.
-
unlock
public void unlock(IContext context, IWorkflowInstance workflowInstance) throws WorkflowModuleException Description copied from interface:IWorkflowModule
Allows to unlock workflow instance.- Specified by:
unlock
in interfaceIWorkflowModule
- Parameters:
context
- TheIContext
execution context.workflowInstance
- TheIWorkflowInstance
object.- Throws:
WorkflowModuleException
- default module exception.
-
isLocked
public boolean isLocked(IContext context, IWorkflowInstance workflowInstance) throws WorkflowModuleException Description copied from interface:IWorkflowModule
Checks if a specified workflow instance is locked- Specified by:
isLocked
in interfaceIWorkflowModule
- Parameters:
context
- TheIContext
execution context.workflowInstance
- TheIWorkflowInstance
object.- Returns:
- true if the resource has been locked, false otherwise.
- Throws:
WorkflowModuleException
- default module exception.
-
lockedBy
public Collection<IUser> lockedBy(IContext context, IWorkflowInstance workflowInstance) throws WorkflowModuleException Description copied from interface:IWorkflowModule
Retrieve the users who locked the workflow instance.- Specified by:
lockedBy
in interfaceIWorkflowModule
- Parameters:
context
- TheIContext
execution context.workflowInstance
- TheIWorkflowInstance
object.- Returns:
- a list of
IUser
users. - Throws:
WorkflowModuleException
- default module exception.
-
isLockBySDK
public boolean isLockBySDK(IContext context, IWorkflowInstance workflowInstance) throws WorkflowModuleException Description copied from interface:IWorkflowModule
Checks if a specified workflow instance is locked by the SDK- Specified by:
isLockBySDK
in interfaceIWorkflowModule
- Parameters:
context
- TheIContext
execution context.workflowInstance
- TheIWorkflowInstance
object.- Returns:
- true if the resource has been locked by SDK, false otherwise.
- Throws:
WorkflowModuleException
- default module exception.
-
getListLabel
public String getListLabel(ICatalog catalog, String listName, String key, String language) throws WorkflowModuleException Description copied from interface:IWorkflowModule
get translated value of a list- Specified by:
getListLabel
in interfaceIWorkflowModule
- Parameters:
catalog
- TheICatalog
link to the listlistName
- list namekey
- key of the valuelanguage
- language- Returns:
- String
- Throws:
WorkflowModuleException
- when list is missing
-
setDynamicLocalizationsWrapperMessageForLanguage
public IDynamicLocalizationsWrapper setDynamicLocalizationsWrapperMessageForLanguage(IContext context, IDynamicLocalizationsWrapper dynamicLocalizationsWrapper, ICatalog catalog, String language, String message) throws ModuleException Description copied from interface:IBaseWorkflowModule
Creates a dynamicLocalizationsWrapper object by specifying the parentICatalog
object.- Specified by:
setDynamicLocalizationsWrapperMessageForLanguage
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.catalog
- TheICatalog
object.language
- The languagemessage
- The message- Returns:
- A
IDynamicLocalizationsWrapper
object. - Throws:
ModuleException
-
createDynamicLocalizationsWrapper
public IDynamicLocalizationsWrapper createDynamicLocalizationsWrapper(IContext context, ICatalog catalog) throws ModuleException Description copied from interface:IBaseWorkflowModule
Creates a dynamicLocalizationsWrapper object by specifying the parentICatalog
object.- Specified by:
createDynamicLocalizationsWrapper
in interfaceIBaseWorkflowModule
- Parameters:
context
- The execution context.catalog
- TheICatalog
object.- Returns:
- A
IDynamicLocalizationsWrapper
object. - Throws:
ModuleException
-
generateSystemName
Description copied from interface:IModule
Generate a valid system name for this module and this label.- Specified by:
generateSystemName
in interfaceIModule
- Parameters:
label
- label to normalize- Returns:
- normalized value
-
hasDiscussionThread
Description copied from interface:IBaseWorkflowModule
Allows knowing if an IWorkflowInstance has a discussion thread or not- Specified by:
hasDiscussionThread
in interfaceIBaseWorkflowModule
- Parameters:
context
- the contextiWorkflowInstance
- theIWorkflowInstance
- Returns:
- true if IWorkflowInstance has a discussion thread otherwise false
-
getDiscussionMessagesOrderByCreationDateDesc
public Collection<IWorkflowInstanceDiscussionMessage> getDiscussionMessagesOrderByCreationDateDesc(IContext context, IWorkflowInstance iWorkflowInstance) Description copied from interface:IBaseWorkflowModule
Retrieve IWorkflowInstance's message- Specified by:
getDiscussionMessagesOrderByCreationDateDesc
in interfaceIBaseWorkflowModule
- Parameters:
context
- the contextiWorkflowInstance
- the workflowInstance- Returns:
- the
IWorkflowInstanceDiscussionMessage
collection
-
canModifyDiscussionMessage
public DiscussionAccessCheckResult canModifyDiscussionMessage(IContext context, IDiscussionMessage iDiscussionMessage) Description copied from interface:IBaseWorkflowModule
Allows knowing if an IDiscussionMessage can be modified in the current IContext or not- Specified by:
canModifyDiscussionMessage
in interfaceIBaseWorkflowModule
- Parameters:
context
- the contextiDiscussionMessage
- theIDiscussionMessage
- Returns:
- the
DiscussionAccessCheckResult
enum value result
-
canDeleteDiscussionMessage
public DiscussionAccessCheckResult canDeleteDiscussionMessage(IContext context, IDiscussionMessage iDiscussionMessage) Description copied from interface:IBaseWorkflowModule
Allows knowing if an IDiscussionMessage can be deleted in the current IContext or not- Specified by:
canDeleteDiscussionMessage
in interfaceIBaseWorkflowModule
- Parameters:
context
- the contextiDiscussionMessage
- theIDiscussionMessage
- Returns:
- the
DiscussionAccessCheckResult
enum value result
-
deleteDiscussionMessage
public void deleteDiscussionMessage(IContext context, IWorkflowInstanceDiscussionMessage iWorkflowInstanceDiscussionMessage, IWorkflowInstance iWorkflowInstance) Description copied from interface:IBaseWorkflowModule
Delete an IWorkflowInstanceDiscussionMessage for an IWorkflowInstance. It is necessary to save the IWorkflowInstance after calling this method.- Specified by:
deleteDiscussionMessage
in interfaceIBaseWorkflowModule
- Parameters:
context
- the contextiWorkflowInstanceDiscussionMessage
- the iWorkflowInstanceDiscussionMessageiWorkflowInstance
- the theIWorkflowInstance
-
createDiscussionMessage
public IWorkflowInstanceDiscussionMessage createDiscussionMessage(IContext context, IWorkflowInstance iWorkflowInstance, String content, Collection<IAttachment> attachments, String visibility, Collection<IUser> recipients, IOrganization visibilityOrganization) Description copied from interface:IBaseWorkflowModule
Create and add a new message for an IWorkflowInstance.It is necessary to save the IWorkflowInstance after calling this method.
The "visibility" String parameter can have the following values: "ALL" (Everyone can see the message), "SENDER" (Only the creator of the message can see it), "SENDER_AND_ORGANIZATION" (In addition to the creator, the members of the organization to which he belongs at the time he creates the message can see the message), "SENDER_AND_RECIPIENTS" (In addition to the creator, the recipients specified during the creation of the message can see the message).
- Specified by:
createDiscussionMessage
in interfaceIBaseWorkflowModule
- Parameters:
context
- the contextiWorkflowInstance
- theIWorkflowInstance
content
- The contentattachments
- the collection ofIAttachment
visibility
- the visibility string coderecipients
- the collection ofIUser
recipients for visibility mode VisibilityMode SENDER_AND_RECIPIENTS or nullvisibilityOrganization
- theIOrganization
for visibility mode VisibilityMode SENDER_AND_ORGANIZATION or null- Returns:
- the new
IWorkflowInstanceDiscussionMessage
-
updateDiscussionMessage
public void updateDiscussionMessage(IContext context, IWorkflowInstanceDiscussionMessage iWorkflowInstanceDiscussionMessage, String content, Collection<IAttachment> attachments) Description copied from interface:IBaseWorkflowModule
Update content and/or attachments of a message.- Specified by:
updateDiscussionMessage
in interfaceIBaseWorkflowModule
- Parameters:
context
- the contextiWorkflowInstanceDiscussionMessage
- the iWorkflowInstanceDiscussionMessagecontent
- the contentattachments
- the collection ofIAttachment
-