Package com.axemble.vdoc.sdk.impl

Class WorkflowModuleImpl

java.lang.Object

com.axemble.vdoc.sdk.impl.AbstractTranslaterModule

com.axemble.vdoc.sdk.impl.CoreModule

com.axemble.vdoc.sdk.impl.WorkflowModuleImpl

All Implemented Interfaces:

com.axemble.vdoc.core.interfaces.InternalProcessModule, IBaseWorkflowModule, IModule, IWorkflowModule, Serializable, Remote

Direct Known Subclasses:

com.axemble.vdoc.sdk.impl.ProcessWorkflowModule

public class WorkflowModuleImpl
extends CoreModule
implements IWorkflowModule, com.axemble.vdoc.core.interfaces.InternalProcessModule

Implementation for Workflow module

Author:

vlygeros

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.axemble.vdoc.sdk.impl.CoreModule

LOGGER, properties

Constructor Summary

Constructors

Constructor	Description
WorkflowModuleImpl()	Deprecated. Use com.axemble.vdoc.sdk.Modules.getWorkflowModule() instead.

Method Summary

Modifier and Type	Method	Description
void	abort(IContext context, IWorkflowInstance instance, String comment)	Allows to abort workflow instance.
IAttachment	addAttachment(IResource resource, String propertyName, IAttachment attachment)	Adds an attachment from an attachment.
IAttachment	addAttachment(IResource resource, String propertyName, File file)	Adds an attachment as a java.io.File object.
IAttachment	addAttachment(IResource resource, String propertyName, String fileName, InputStream input)	Adds an attachment as an java.io.InputStream object.
IAttachment	addAttachment(IResource resource, String propertyName, String fileName, String fullPath)	Adds an attachment with its full path.
void	addChild(IGroup group, IRole role)	Adds a group to a role.
void	addMember(IUser user, IRole role)	Adds a user to a role.
String	buildMailMessage(IResource resource, IMailForm mailForm, String language)	Evaluates the form and returns the HTML content as a java.lang.String object.
String	buildMailMessage(ITaskInstance taskInstance, IMailForm mailForm, String language)	Evaluates the form and returns the HTML content as a java.lang.String object.
DiscussionAccessCheckResult	canDeleteDiscussionMessage(IContext context, IDiscussionMessage iDiscussionMessage)	Allows knowing if an IDiscussionMessage can be deleted in the current IContext or not
DiscussionAccessCheckResult	canModifyDiscussionMessage(IContext context, IDiscussionMessage iDiscussionMessage)	Allows knowing if an IDiscussionMessage can be modified in the current IContext or not
ICatalog	createCatalog(IContext context, String name, String label)	Allows to create a new catalog.
ICatalog	createCatalog(IContext context, String name, String label, IProject project)	Allows to create a new catalog.
IWorkflowInstanceDiscussionMessage	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.
IDynamicLocalizationsWrapper	createDynamicLocalizationsWrapper(IContext context, ICatalog catalog)	Creates a dynamicLocalizationsWrapper object by specifying the parent ICatalog object.
IResource	createGenericResource()	Creates a generic resource for mail purposes.
ILinkedResource	createLinkedResource(IResource resource, String propertyName)	Creates a linked resource into a specified property table.
IOptionList.IOption	createListOption(Object key, String text)
IOperatorRole	createOperatorRole(IContext context, ICatalog catalog, String name)	Creates a IOperatorRole into the catalog object.
IRole	createRole(IContext context, ICatalog catalog, String name)	Deprecated.
IStorageResource	createStorageResource(IContext context, IResourceDefinition resourceDefinition, String reference)	Creates a storage resource object by specifying the IResourceDefinition object, its reference.
IStorageResource	createStorageResource(IContext context, IResourceDefinition resourceDefinition, String reference, String label)	Creates a storage resource object by specifying the IResourceDefinition object, its reference, and its label.
IWorkflow	createWorkflow(IContext context, IWorkflowContainer container, String name, byte[] content)	Creates a workflow within a workflow container.
IWorkflowContainer	createWorkflowContainer(IContext context, ICatalog catalog, String name)	Creates a workflow container within a ICatalog object.
IWorkflowInstance	createWorkflowInstance(IContext context, IWorkflow workflow, String reference)	Creates a workflow instance object by specifying the IWorkflow object, its reference.
IWorkflowInstance	createWorkflowInstance(IContext context, IWorkflow workflow, String reference, String label)	Creates a workflow instance object by specifying the IWorkflow 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	end(IContext context, IUser addressee, ITaskInstance instance, IAction action, String comment)	Allows to cross a transition for another user.
String	evaluatedHtml(IResource resource, IMailForm mailForm)	Evaluates the form and returns the HTML content as a java.lang.String object.
String	evaluatedHtml(ITaskInstance taskInstance, IMailForm mailForm)	Evaluates the form and returns the HTML content as a java.lang.String object.
MailMessage	evaluatedMailForm(IResource resource, IMailForm mailForm, String language)	Evaluate mail form
MailMessage	evaluatedMailForm(ITaskInstance taskInstance, IMailForm mailForm, String language)	Evaluate mail form
void	execute(IAgent agent)	Allows to execute an agent.
void	execute(IContext context, IAgent agent)	Allows to execute an agent.
IStorageResource	findStorageResourceByReference(IContext context, IResourceDefinition resourceDefinition, String reference)	Find a storage resource object by specifying the IResourceDefinition object, its reference.
int	generateChrono(IResourceDefinition resourceDefinition)	Evaluate the next chrono based on the format specified on the Designer tool.
String	generateReference(IResource resource)	Evaluate the next reference based on the format specified on the Designer tool.
String	generateReference(IResourceDefinition resourceDefinition)	Evaluate the next reference based on the format specified on the Designer tool.
String	generateReference(IResourceDefinition resourceDefinition, String format)	Evaluate the next reference based on the passed format.
String	generateReference(IResource resource, String format)	Evaluate the next reference based on the specified format.
String	generateReference(IResource resource, Document format)	Evaluate the next reference based specified format.
String	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.
IAction	getAction(IContext context, ITask task, String name)	Retrieve a specific IAction object from its system name.
IAction	getAction(IStorageKey key)	Gets an action object from its identifier.
Collection<? extends IAction>	getActions(IContext context, ITask task)	Retrieves a collection of IAction objects within a ITask.
IAgent	getAgent(IContext context, String name)	Gets an agent from its name.
Collection<? extends ICatalog>	getAllCatalogs(IContext context)	Retrieves a collection of ICatalog object.
IArchivingController	getArchivingController()	Gets a archiving controller to archive IElement objects.
IAttachment	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.
ICatalog	getCatalog(IContext context, String name)	Retrieves a catalog form its name.
ICatalog	getCatalog(IContext context, String name, int catalogType)	Retrieves a catalog form its name.
ICatalog	getCatalog(IContext context, String name, int catalogType, IProject project)	Retrieves a catalog form its name.
ICatalog	getCatalog(IContext context, String name, IProject project)	Retrieves a catalog form its name.
ICatalog	getCatalog(IResourceDefinition resourceDefinition)	Gets a ICatalog object from a resource definitino.
ICatalog	getCatalog(IStorageKey key)	Gets a catalog object from its identifier.
ICatalog	getCatalog(IWorkflow workflow)	Retrieves the catalog of a IWorkflow object.
Collection<? extends ICatalog>	getCatalogs(IContext context)	Retrieves a collection of ICatalog object.
Collection<? extends ICatalog>	getCatalogs(IContext context, int catalogType)	Retrieves a collection of ICatalog object.
Collection<? extends ICatalog>	getCatalogs(IContext context, int catalogType, IProject project)	Retrieves a collection of ICatalog object.
Collection<? extends ICatalog>	getCatalogs(IContext context, IProject project)	Retrieves a collection of ICatalog object.
ICatalogViewTransformer	getCatalogViewTransformer()	Gets a catalog view transformer to transform ICatalog objects.
IDataSourceReference	getDataSourceReference(String name)	Gets a data source reference from its JNDI name.
IDataSourceReference	getDefaultDataSourceReference()	Gets the default data source reference.
IDelegationController	getDelegationController()	Gets a delegation controller to delegate IDelegationSupport objects.
Collection<IWorkflowInstanceDiscussionMessage>	getDiscussionMessagesOrderByCreationDateDesc(IContext context, IWorkflowInstance iWorkflowInstance)	Retrieve IWorkflowInstance's message
Collection<? 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 of IElement objects from a multiple selector property.
IFile	getExternalFile(IResource resource, String propertyName)	Gets a IFile object from a single file selector property.
IFolder	getExternalFolder(IResource resource, String propertyName)	Gets a IFolder object from a single folder selector property.
IGroup	getExternalGroup(IResource resource, String propertyName)	Gets a IGroup object from a single group selector property.
ILibrary	getExternalLibrary(IResource resource, String propertyName)	Gets a ILibrary object from a single library selector property.
ILocalization	getExternalLocalization(IResource resource, String propertyName)	Gets a ILocalization object from a single localization selector property.
IOrganization	getExternalOrganization(IResource resource, String propertyName)	Gets a IOrganization object from a single organization selector property.
IUser	getExternalUser(IResource resource, String propertyName)	Gets a IUser object from a single user selector property.
IFieldController	getFieldController(ICatalog catalog)	Gets the resource controller object.
IFieldController	getFieldController(IResourceDefinition resourceDefinition)	Gets the resource controller object.
IFieldController	getFieldController(IWorkflow workflow)	Gets the resource controller object.
IForm	getForm(IContext context, IAction action, String formName)	Gets a action form by its name.
IForm	getForm(IContext context, IResourceDefinition resourceDefinition, String formName)	Gets a resource definition form by its name.
IForm	getForm(IContext context, ITask task, String formName)	Gets a task form by its name.
IForm	getForm(IContext context, IWorkflow workflow, String formName)	Gets a workflow form by its name.
IGenericViewTransformer	getGenericViewTransformer()
IGroup	getGroup(String id)	Get a group from its id
IGroup	getGroupByName(String name)	Gets a group by its name
IJdbcReference	getJdbcReference(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.
IList	getList(IContext context, ICatalog catalog, String name)	Gets a list object from a catalog by its name.
Collection<? extends IOptionList.IOption>	getList(IResource resource, String propertyName)	Gets the available values of a list property.
String	getListLabel(ICatalog catalog, String listName, String key, String language)	get translated value of a list
Collection<? extends IList>	getLists(IContext context, ICatalog catalog)	Gets a collection of a the lists available on a specified ICatalog object.
IMailForm	getMailForm(IContext context, IWorkflow workflow, String mailFormName)
Collection<? extends IMailForm>	getMailForms(IContext context, IWorkflow workflow)	Gets all the mail forms from a specified IWorkflow 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 workflow
ITaskInstance	getOneTaskInstance(IContext context, IWorkflowInstance instance)	Gets one of the task instances (any).
IOperator	getOperator(IStorageKey key)	Gets an operator object from its identifier.
IOperator	getOperator(String id)	Gets a IOperator object from its string identifier.
IOperator	getOperatorByLogin(String login)	Gets an IOperator from a user login.
IOperatorRole	getOperatorRole(IContext context, ICatalog catalog, String name)	Retrieves a IOperatorRole object by its system name.
IOperatorRole	getOperatorRole(IStorageKey key)	Gets a role object from its identifier.
Collection<? extends IOperatorRole>	getOperatorRoles(IContext context, ICatalog catalog)	Retrieves a collection of IOperatorRole objects within a specified catalog.
Collection<? extends IOperator>	getOperators(ITaskInstance instance)	Retrieves the operators of a task instance.
IWorkflowInstance	getParentInstance(ILinkedResource linkedResource)	Gets the parent instance of a linked resource.
IWorkflowInstance	getParentInstance(IWorkflowInstance instance)	Gets the parent instance of a specified IWorkflowInstanceobject.
Collection<? extends IProperty>	getProperties(IContext context, IResourceDefinition resourceDefinition)	Gets all the properties of a specified definition.
IProperty	getProperty(IContext context, IResourceDefinition resourceDefinition, String name)	Gets a property definition by specifying the IResourceDefinition and its system name.
IProperty	getProperty(IStorageKey key)	Gets a property object from its identifier.
IResource	getResource(IStorageKey key)	Gets a resource object from its identifier.
protected IResource	getResource(com.axemble.vdp.ui.core.document.CoreDocument document)
IResource	getResource(Object document)	Gets a IResource object from an object.
IResource	getResource(String id)	Gets a IResource object from its string identifier.
IResourceController	getResourceController(IResource resource)	Gets the resource controller object.
IResourceDefinition	getResourceDefinition(IContext context, ICatalog catalog, String name)	Retrieves a resource definition by specifying the ICatalog and its system name.
IResourceDefinition	getResourceDefinition(IStorageKey key)	Gets a resource definition object from its identifier.
Collection<? extends IResourceDefinition>	getResourceDefinitions(IContext context, ICatalog catalog)	Retrieves all resource definitions by specifying the ICatalog
IResourceHistory	getResourceHistory(IWorkflowInstance workflowInstance)
Collection<? extends IResource>	getResources(IContext context, ICatalog catalog)	Gets a collection of IResource objects from a catalog
Collection<? extends IResource>	getResources(IContext context, IResourceDefinition resourceDefinition)	Gets a collection of IResource objects from a resource definition.
IResourceViewTransformer	getResourceViewTransformer()	Gets a resource view transformer to transform IResource objects.
IRole	getRole(IContext context, ICatalog catalog, String name)	Deprecated.
IRole	getRole(IStorageKey key)	Deprecated.
Collection<? extends IRole>	getRoles(IContext context, ICatalog catalog)	Deprecated.
ISearchController	getSearchController()	Gets the default ISearchController object.
ISearchController	getSearchController(IConnectionDefinition connectionDefinition)	Gets a search controller object by specifying a ConnectionDefinition object.
ISearchController	getSearchController(IDataSourceReference reference)	Gets a search controller object by specifying an external data source.
ISearchController	getSearchController(IJdbcReference reference)	Gets a search controller object by specifying a JDBC external reference.
ISearchViewTransformer	getSearchViewTransformer()	Gets a search view transformer to transform IResource objects.
ISecurityController	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.
IForm	getSubForm(IContext context, IWorkflow workflow, String formName)	Gets a sub form by its name.
ITask	getTask(IContext context, IWorkflow workflow, String name)	Retrieves a specific task of a IWorkflow object by its name.
ITask	getTask(IStorageKey key)	Gets a task object from its identifier.
ITask	getTask(ITaskInstance instance)	Gets the definition of a task instance.
ITaskInstance	getTaskInstance(IContext context, IWorkflowInstance instance, String name)	Gets the started task instance associated with a specified task name.
ITaskInstance	getTaskInstance(IStorageKey key)	Gets a task instance object from its identifier.
ITaskInstance	getTaskInstance(String id)	Gets a ITaskInstance 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 a ITask.
ITaskInstanceTransformer	getTaskInstanceTransformer()	Gets a task transformer to transform ITaskInstance object.
Collection<? extends ITask>	getTasks(IContext context, IWorkflow workflow)	Get task from workflow
ITaskViewTransformer	getTaskViewTransformer()	Gets a task view transformer to transform ITaskInstance objects.
ITransformer	getTransformer()	Gets a transformer to transform IResource object.
Object	getValue(IResource resource, String propertyName)	Gets the value of a property.
IView	getView(IContext context, ICatalog catalog, String viewName)	Retrieves a view by its name.
IView	getView(IContext context, IResourceDefinition resourceDefinition, String viewName)	Retrieves a view by its name.
IView	getView(IContext context, IWorkflowContainer workflowContainer, String viewName)	Retrieves a view by its name.
IViewController	getViewController()	Deprecated.
IViewController	getViewController(IContext context)	Gets a view controller to search IResource objects through their properties.
IViewController	getViewController(IContext context, IProject project, com.axemble.vdp.views.query.Definition definition)	Internal method
IViewController	getViewController(IContext context, IProject project, InputStream inputStream)	Gets a view controller to search IResource objects through their properties.
IViewController	getViewController(IContext context, Class natureClass)	Gets a view controller to search IResource objects through their properties.
IViewController	getViewController(IProject project, com.axemble.vdp.views.query.Definition definition)	Deprecated.
IViewController	getViewController(IProject project, InputStream inputStream)	Deprecated.
IViewController	getViewController(Class natureClass)	Deprecated.
Collection<? extends IView>	getViews(IContext context, ICatalog catalog)	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.
ITaskViewTransformer	getViewTransformer()
IWorkflow	getWorkflow(IContext context, ICatalog catalog, String name)	Retrieves a workflow within a IWorkflow object and from its system name.
IWorkflow	getWorkflow(IContext context, String name)	Deprecated.
IWorkflow	getWorkflow(IStorageKey key)	Gets a workflow object from its identifier.
IWorkflow	getWorkflow(ITask task)	Gets the associated workflow of a task.
IWorkflow	getWorkflow(String id)	Get workflow from its id
IWorkflowContainer	getWorkflowContainer(IContext context, ICatalog catalog, String name)	Retrieves a IWorkflowContainer within a ICatalog by its system name
IWorkflowContainer	getWorkflowContainer(IStorageKey key)	Gets a workflow container object from its identifier.
IWorkflowContainer	getWorkflowContainer(IWorkflow workflow)	Retrieves the workflow container of a IWorkflow object.
IWorkflowContainer	getWorkflowContainer(String id)	Get workflow container from its id
Collection<? extends IWorkflowContainer>	getWorkflowContainers(IContext context, ICatalog catalog)	Retrieves a collection of IWorkflowContainer objects within a ICatalog object.
IWorkflowContainerViewTransformer	getWorkflowContainerViewTransformer()	Gets a workflow container view transformer to transform IWorkflowContainer objects.
IWorkflowInstance	getWorkflowInstance(IStorageKey key)	Gets a workflow instance object from its identifier.
protected IWorkflowInstance	getWorkflowInstance(com.axemble.vdp.ui.core.document.CoreDocument document)
IWorkflowInstance	getWorkflowInstance(Object document)	Gets a IWorkflowInstance object from an object.
IWorkflowInstance	getWorkflowInstance(String id)	Gets a IWorkflowInstance object from its string identifier.
Collection<? extends IWorkflowInstance>	getWorkflowInstances(IContext context, ICatalog catalog)	Gets all the workflow instances of a specified ICatalog object.
Collection<? extends IWorkflowInstance>	getWorkflowInstances(IContext context, ICatalog catalog, String reference)	Gets all the workflow instances with the same reference within a specified ICatalog object.
Collection<? extends IWorkflowInstance>	getWorkflowInstances(IContext context, ITask task)	Gets all the workflow instances of a specified ITask object.
Collection<? extends IWorkflowInstance>	getWorkflowInstances(IContext context, IWorkflow workflow)	Gets all the workflow instances of a specified IWorkflow object.
Collection<? extends IWorkflowInstance>	getWorkflowInstances(IContext context, IWorkflow workflow, String reference)	Gets all the workflow instances with the same reference within a specified IWorkflow object.
Collection<? extends IWorkflow>	getWorkflows(IContext context, ICatalog catalog)	Retrieves a collection of IWorkflow objects within a ICatalog object.
Collection<? extends IWorkflow>	getWorkflows(IContext context, IWorkflowContainer container)	Retrieves a collection of IWorkflow objects within a IWorkflowContainer object.
IWorkflowViewTransformer	getWorkflowViewTransformer()	Gets a workflow view transformer to transform IWorkflow objects.
boolean	hasDiscussionThread(IContext context, IWorkflowInstance iWorkflowInstance)	Allows knowing if an IWorkflowInstance has a discussion thread or not
boolean	isLockBySDK(IContext context, IWorkflowInstance workflowInstance)	Checks if a specified workflow instance is locked by the SDK
boolean	isLocked(IContext context, IWorkflowInstance workflowInstance)	Checks if a specified workflow instance is locked
boolean	isMemberOf(IUser user, IRole role)	Checks if a specified user is member of a IRole object.
boolean	isMemberOf(IUser user, IRole role, boolean recursive)	Checks if a specified user is member of a IRole object.
void	lock(IContext context, IWorkflowInstance workflowInstance, int delay)	Allows to lock workflow instance.
Collection<IUser>	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	send(IContext context, IUser addressee, ITaskInstance instance, IMailForm form, String comment)	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.
IDynamicLocalizationsWrapper	setDynamicLocalizationsWrapperMessageForLanguage(IContext context, IDynamicLocalizationsWrapper dynamicLocalizationsWrapper, ICatalog catalog, String language, String message)	Creates a dynamicLocalizationsWrapper object by specifying the parent ICatalog object.
void	setExternalElements(IResource resource, String propertyName, Collection<?> elements)	Sets a IElement to a multiple selector property.
void	setExternalFile(IResource resource, String propertyName, IFile file)	Sets a IFile to a single selector property.
void	setExternalFolder(IResource resource, String propertyName, IFolder folder)	Sets a IFolder to a single selector property.
void	setExternalGroup(IResource resource, String propertyName, IGroup group)	Sets a IGroup to a single selector property.
void	setExternalLibrary(IResource resource, String propertyName, ILibrary library)	Sets a ILibrary to a single selector property.
void	setExternalLocalization(IResource resource, String propertyName, ILocalization localization)	Sets a ILocalization to a single selector property.
void	setExternalOrganization(IResource resource, String propertyName, IOrganization organization)	Sets a IOrganization to a single selector property.
void	setExternalUser(IResource resource, String propertyName, IUser user)	Sets a IUser 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	setValue(IResource resource, String propertyName, Object value)	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.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

createProfile, getConfiguration, getDefinitionsFactory, getElementByProtocolURI, getProfile, getProfile, getProfiles, getUser, getUser, getUserByLogin

Constructor Details

WorkflowModuleImpl

@Deprecated
public 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: IWorkflowModule

Allows to create a new catalog. This method allows to specify the system name and the label of the catalog.

Specified by:

createCatalog in interface IBaseWorkflowModule

Specified by:

createCatalog in interface IWorkflowModule

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

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

Specified by:

createCatalog in interface IWorkflowModule

Parameters:

context - The execution context.

name - The system name of the catalog.

label - The label of the catalog.

project - The IProject representing the project.

Returns:

a ICatalog object.

Throws:

WorkflowModuleException - default module exception.

getCatalog

public ICatalog getCatalog(IContext context,
 String name)
                    throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Retrieves a catalog form its name.

Specified by:

getCatalog in interface IBaseWorkflowModule

Specified by:

getCatalog in interface IWorkflowModule

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

Retrieves a catalog form its name.

Specified by:

getCatalog in interface IBaseWorkflowModule

Specified by:

getCatalog in interface IWorkflowModule

Parameters:

context - The execution context.

name - The system name of the catalog.

project - The IProject 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: IWorkflowModule

Retrieves a catalog form its name.

Specified by:

getCatalog in interface IBaseWorkflowModule

Specified by:

getCatalog in interface IWorkflowModule

Parameters:

context - The execution context.

name - The system name of the catalog.

catalogType - The ICatalog.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: IWorkflowModule

Retrieves a catalog form its name.

Specified by:

getCatalog in interface IBaseWorkflowModule

Specified by:

getCatalog in interface IWorkflowModule

Parameters:

context - The execution context.

name - The system name of the catalog.

catalogType - The ICatalog.IType of the catalog.

project - The IProject representing the project.

Returns:

a ICatalog object.

Throws:

WorkflowModuleException - default module exception.

getCatalogs

public Collection<? extends ICatalog> getCatalogs(IContext context)
                                           throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Retrieves a collection of ICatalog object.

Specified by:

getCatalogs in interface IBaseWorkflowModule

Specified by:

getCatalogs in interface IWorkflowModule

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

Retrieves a collection of ICatalog object.

Specified by:

getCatalogs in interface IBaseWorkflowModule

Specified by:

getCatalogs in interface IWorkflowModule

Parameters:

context - The execution context.

project - The IProject 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: IWorkflowModule

Retrieves a collection of ICatalog object.

Specified by:

getCatalogs in interface IBaseWorkflowModule

Specified by:

getCatalogs in interface IWorkflowModule

Parameters:

context - The execution context.

catalogType - The ICatalog.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: IWorkflowModule

Retrieves a collection of ICatalog object.

Specified by:

getCatalogs in interface IBaseWorkflowModule

Specified by:

getCatalogs in interface IWorkflowModule

Parameters:

context - The execution context.

catalogType - The ICatalog.IType of the catalogs.

project - The IProject 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: IWorkflowModule

Retrieves a collection of ICatalog object.

Specified by:

getAllCatalogs in interface IBaseWorkflowModule

Specified by:

getAllCatalogs in interface IWorkflowModule

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

Creates a IRole into the catalog object.

Specified by:

createRole in interface IBaseWorkflowModule

Specified by:

createRole in interface IWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog object.

name - The system name of the IRole 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: IWorkflowModule

Retrieves a IRole object by its system name.

Specified by:

getRole in interface IBaseWorkflowModule

Specified by:

getRole in interface IWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog 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: IWorkflowModule

Retrieves a collection of IRole objects within a specified catalog.

Specified by:

getRoles in interface IBaseWorkflowModule

Specified by:

getRoles in interface IWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog 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: IWorkflowModule

Creates a IOperatorRole into the catalog object.

Specified by:

createOperatorRole in interface IBaseWorkflowModule

Specified by:

createOperatorRole in interface IWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog object.

name - The system name of the IOperatorRole to be created.

Returns:

a IOperatorRole object.

Throws:

WorkflowModuleException - default module exception.

getOperatorRole

public IOperatorRole getOperatorRole(IContext context,
 ICatalog catalog,
 String name)
                              throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Retrieves a IOperatorRole object by its system name.

Specified by:

getOperatorRole in interface IBaseWorkflowModule

Specified by:

getOperatorRole in interface IWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog scope object.

name - The system name of the role.

Returns:

a IOperatorRole object.

Throws:

WorkflowModuleException - default module exception.

getOperatorRoles

public Collection<? extends IOperatorRole> getOperatorRoles(IContext context,
 ICatalog catalog)
                                                     throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Retrieves a collection of IOperatorRole objects within a specified catalog.

Specified by:

getOperatorRoles in interface IBaseWorkflowModule

Specified by:

getOperatorRoles in interface IWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog object.

Returns:

a collection of IOperatorRole objects.

Throws:

WorkflowModuleException - default module exception.

getDefaultDataSourceReference

public IDataSourceReference getDefaultDataSourceReference()
                                                   throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets the default data source reference.

Specified by:

getDefaultDataSourceReference in interface IBaseWorkflowModule

Specified by:

getDefaultDataSourceReference in interface IWorkflowModule

Returns:

a IDataSourceReference object.

Throws:

WorkflowModuleException - default module exception.

getDataSourceReference

public IDataSourceReference getDataSourceReference(String name)
                                            throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a data source reference from its JNDI name.

Specified by:

getDataSourceReference in interface IBaseWorkflowModule

Specified by:

getDataSourceReference in interface IWorkflowModule

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

Gets a JDBC reference from its name.

Specified by:

getJdbcReference in interface IBaseWorkflowModule

Specified by:

getJdbcReference in interface IWorkflowModule

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

Gets a collection of JDBC references.

Specified by:

getJdbcReferences in interface IBaseWorkflowModule

Specified by:

getJdbcReferences in interface IWorkflowModule

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

Gets a list object from a catalog by its name.

Specified by:

getList in interface IBaseWorkflowModule

Specified by:

getList in interface IWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog 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: IWorkflowModule

Gets a collection of a the lists available on a specified ICatalog object.

Specified by:

getLists in interface IBaseWorkflowModule

Specified by:

getLists in interface IWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog representing the application.

Returns:

a collection of IList object

Throws:

WorkflowModuleException - default module exception.

isMemberOf

public boolean isMemberOf(IUser user,
 IRole role)
                   throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Checks if a specified user is member of a IRole object.

Specified by:

isMemberOf in interface IBaseWorkflowModule

Specified by:

isMemberOf in interface IWorkflowModule

Parameters:

user - The IUser object to check.

role - The IRole object.

Returns:

return true if the user is member of the IRole object.

Throws:

WorkflowModuleException - default module exception.

isMemberOf

public boolean isMemberOf(IUser user,
 IRole role,
 boolean recursive)
                   throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Checks if a specified user is member of a IRole object.

Specified by:

isMemberOf in interface IBaseWorkflowModule

Specified by:

isMemberOf in interface IWorkflowModule

Parameters:

user - The IUser object to check.

role - The IRole 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: IWorkflowModule

Creates a workflow container within a ICatalog object.

Specified by:

createWorkflowContainer in interface IBaseWorkflowModule

Specified by:

createWorkflowContainer in interface IWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog object.

name - The system name of the IWorkflowContainer 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: IWorkflowModule

Retrieves a IWorkflowContainer within a ICatalog by its system name

Specified by:

getWorkflowContainer in interface IBaseWorkflowModule

Specified by:

getWorkflowContainer in interface IWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog object.

name - The system name of the IWorkflowContainer 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: IWorkflowModule

Retrieves a collection of IWorkflowContainer objects within a ICatalog object.

Specified by:

getWorkflowContainers in interface IBaseWorkflowModule

Specified by:

getWorkflowContainers in interface IWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog 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: IWorkflowModule

Creates a workflow within a workflow container.

Specified by:

createWorkflow in interface IBaseWorkflowModule

Specified by:

createWorkflow in interface IWorkflowModule

Parameters:

context - The execution context.

container - The IWorkflowContainer 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: IWorkflowModule

Retrieves a workflow form its system name.

Specified by:

getWorkflow in interface IBaseWorkflowModule

Specified by:

getWorkflow in interface IWorkflowModule

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

Retrieves a workflow within a IWorkflow object and from its system name.

Specified by:

getWorkflow in interface IBaseWorkflowModule

Specified by:

getWorkflow in interface IWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog 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: IWorkflowModule

Retrieves a collection of IWorkflow objects within a ICatalog object.

Specified by:

getWorkflows in interface IBaseWorkflowModule

Specified by:

getWorkflows in interface IWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog 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: IWorkflowModule

Retrieves a collection of IWorkflow objects within a IWorkflowContainer object.

Specified by:

getWorkflows in interface IBaseWorkflowModule

Specified by:

getWorkflows in interface IWorkflowModule

Parameters:

context - The execution context.

container - The IWorkflowContainer object.

Returns:

a collection of IWorkflow objects.

Throws:

WorkflowModuleException - default module exception.

getCatalog

public ICatalog getCatalog(IWorkflow workflow)
                    throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Retrieves the catalog of a IWorkflow object.

Specified by:

getCatalog in interface IBaseWorkflowModule

Specified by:

getCatalog in interface IWorkflowModule

Parameters:

workflow - The workflow object.

Returns:

a ICatalog object

Throws:

WorkflowModuleException - default module exception.

getWorkflowContainer

public IWorkflowContainer getWorkflowContainer(IWorkflow workflow)
                                        throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Retrieves the workflow container of a IWorkflow object.

Specified by:

getWorkflowContainer in interface IBaseWorkflowModule

Specified by:

getWorkflowContainer in interface IWorkflowModule

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

Creates a workflow instance object by specifying the IWorkflow object, its reference, and its label. The permission to create workflow instance is not checked

Specified by:

createWorkflowInstance in interface IBaseWorkflowModule

Specified by:

createWorkflowInstance in interface IWorkflowModule

Parameters:

context - The execution context.

workflow - The IWorkflow 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: IWorkflowModule

Creates a workflow instance object by specifying the IWorkflow object, its reference. The permission to create workflow instance is not checked

Specified by:

createWorkflowInstance in interface IBaseWorkflowModule

Specified by:

createWorkflowInstance in interface IWorkflowModule

Parameters:

context - The execution context.

workflow - The IWorkflow 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: IWorkflowModule

Gets all the workflow instances with the same reference within a specified ICatalog object.

Specified by:

getWorkflowInstances in interface IBaseWorkflowModule

Specified by:

getWorkflowInstances in interface IWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog 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: IWorkflowModule

Gets all the workflow instances with the same reference within a specified IWorkflow object.

Specified by:

getWorkflowInstances in interface IBaseWorkflowModule

Specified by:

getWorkflowInstances in interface IWorkflowModule

Parameters:

context - The execution context.

workflow - The IWorkflow 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: IWorkflowModule

Gets all the workflow instances of a specified ICatalog object.

Specified by:

getWorkflowInstances in interface IBaseWorkflowModule

Specified by:

getWorkflowInstances in interface IWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog 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: IWorkflowModule

Gets all the workflow instances of a specified IWorkflow object.

Specified by:

getWorkflowInstances in interface IBaseWorkflowModule

Specified by:

getWorkflowInstances in interface IWorkflowModule

Parameters:

context - The execution context.

workflow - The IWorkflow 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: IWorkflowModule

Gets all the workflow instances of a specified ITask object.

Specified by:

getWorkflowInstances in interface IBaseWorkflowModule

Specified by:

getWorkflowInstances in interface IWorkflowModule

Parameters:

context - The execution context.

task - The ITask object.

Returns:

a collection of IWorkflowInstance objects.

Throws:

WorkflowModuleException - default module exception.

getParentInstance

public IWorkflowInstance getParentInstance(IWorkflowInstance instance)
                                    throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets the parent instance of a specified IWorkflowInstanceobject.

Specified by:

getParentInstance in interface IBaseWorkflowModule

Specified by:

getParentInstance in interface IWorkflowModule

Parameters:

instance - the IWorkflowInstance 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: IWorkflowModule

Allows to abort workflow instance.

Specified by:

abort in interface IBaseWorkflowModule

Specified by:

abort in interface IWorkflowModule

Parameters:

context - The execution context.

instance - The IWorkflowInstance 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: IWorkflowModule

Allows to remind current operators of a workflow instance.

Specified by:

remind in interface IBaseWorkflowModule

Specified by:

remind in interface IWorkflowModule

Parameters:

context - The execution context.

instance - The IWorkflowInstance 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: IWorkflowModule

Allows to remind current operators of a specified task instance.

Specified by:

remind in interface IBaseWorkflowModule

Specified by:

remind in interface IWorkflowModule

Parameters:

context - The execution context.

instance - The ITaskInstance 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: IWorkflowModule

Sets a value to a property.

Specified by:

setValue in interface IBaseWorkflowModule

Specified by:

setValue in interface IWorkflowModule

Parameters:

resource - The IWorkflowInstance object.

propertyName - The system name of the property.

value - The value object to set.

Throws:

WorkflowModuleException - default module exception.

getValue

public Object getValue(IResource resource,
 String propertyName)
                throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets the value of a property.

Specified by:

getValue in interface IBaseWorkflowModule

Specified by:

getValue in interface IWorkflowModule

Parameters:

resource - The IWorkflowInstance 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: IWorkflowModule

Sets the list of available values to a list property.

Specified by:

setList in interface IBaseWorkflowModule

Specified by:

setList in interface IWorkflowModule

Parameters:

resource - The IWorkflowInstance object.

propertyName - The system name of the property.

values - a collection of IOptionList.IOption.

Throws:

WorkflowModuleException - default module exception.

getList

public Collection<? extends IOptionList.IOption> getList(IResource resource,
 String propertyName)
                                                  throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets the available values of a list property.

Specified by:

getList in interface IBaseWorkflowModule

Specified by:

getList in interface IWorkflowModule

Parameters:

resource - The IWorkflowInstance object.

propertyName - The system name of the property.

Returns:

a collection of IOptionList.IOption.

Throws:

WorkflowModuleException - default module exception.

createListOption

public IOptionList.IOption createListOption(Object key,
 String text)

Specified by:

createListOption in interface IBaseWorkflowModule

Specified by:

createListOption in interface IWorkflowModule

Parameters:

key - the key of the option.

text - the text of the option.

Returns:

a new IOptionList.IOption

getWorkflow

public IWorkflow getWorkflow(ITask task)
                      throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets the associated workflow of a task.

Specified by:

getWorkflow in interface IBaseWorkflowModule

Specified by:

getWorkflow in interface IWorkflowModule

Parameters:

task - the ITask 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: IWorkflowModule

Retrieves a specific task of a IWorkflow object by its name.

Specified by:

getTask in interface IBaseWorkflowModule

Specified by:

getTask in interface IWorkflowModule

Parameters:

context - The execution context.

workflow - The IWorkflow object.

name - The system name of the ITask 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: IWorkflowModule

Retrieves a collection of IAction objects within a ITask.

Specified by:

getActions in interface IBaseWorkflowModule

Specified by:

getActions in interface IWorkflowModule

Parameters:

context - The execution context.

task - The ITask object.

Returns:

a collection of IAction objects.

Throws:

WorkflowModuleException - default module exception.

getAction

public IAction getAction(IContext context,
 ITask task,
 String name)
                  throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Retrieve a specific IAction object from its system name.

Specified by:

getAction in interface IBaseWorkflowModule

Specified by:

getAction in interface IWorkflowModule

Parameters:

context - The execution context.

task - The ITask object.

name - The system name of the IAction 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: IWorkflowModule

Retrieves a resource definition by specifying the ICatalog and its system name.

Specified by:

getResourceDefinition in interface IBaseWorkflowModule

Specified by:

getResourceDefinition in interface IWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog 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: IWorkflowModule

Retrieves all resource definitions by specifying the ICatalog

Specified by:

getResourceDefinitions in interface IBaseWorkflowModule

Specified by:

getResourceDefinitions in interface IWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog 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: IWorkflowModule

Retrieves a view by its name.

Specified by:

getView in interface IBaseWorkflowModule

Specified by:

getView in interface IWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog 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: IWorkflowModule

Retrieves all the views associated with the catalog.

Specified by:

getViews in interface IBaseWorkflowModule

Specified by:

getViews in interface IWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog 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: IWorkflowModule

Retrieves a view by its name.

Specified by:

getView in interface IBaseWorkflowModule

Specified by:

getView in interface IWorkflowModule

Parameters:

context - The execution context.

workflowContainer - The IWorkflowContainer 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: IWorkflowModule

Retrieves all the views associated with the workflow container.

Specified by:

getViews in interface IBaseWorkflowModule

Specified by:

getViews in interface IWorkflowModule

Parameters:

context - The execution context.

workflowContainer - The IWorkflowContainer 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: IWorkflowModule

Retrieves a view by its name.

Specified by:

getView in interface IBaseWorkflowModule

Specified by:

getView in interface IWorkflowModule

Parameters:

context - The execution context.

resourceDefinition - The IResourceDefinition 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: IWorkflowModule

Retrieves all the views associated with the resource definition.

Specified by:

getViews in interface IBaseWorkflowModule

Specified by:

getViews in interface IWorkflowModule

Parameters:

context - The execution context.

resourceDefinition - The IResourceDefinition object.

Returns:

a IView object.

Throws:

WorkflowModuleException - default module exception.

getProperties

public Collection<? extends IProperty> getProperties(IContext context,
 IResourceDefinition resourceDefinition)

Description copied from interface: IWorkflowModule

Gets all the properties of a specified definition.

Specified by:

getProperties in interface IBaseWorkflowModule

Specified by:

getProperties in interface IWorkflowModule

Parameters:

context - The execution context.

resourceDefinition - a IResourceDefinition object.

Returns:

a collection of IProperty objects.

getProperty

public IProperty getProperty(IContext context,
 IResourceDefinition resourceDefinition,
 String name)

Description copied from interface: IWorkflowModule

Gets a property definition by specifying the IResourceDefinition and its system name.

Specified by:

getProperty in interface IBaseWorkflowModule

Specified by:

getProperty in interface IWorkflowModule

Parameters:

context - The execution context.

resourceDefinition - The IResourceDefinition 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 context

workflow - 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 context

workflow - the workflow

Returns:

the task

Throws:

WorkflowModuleException - on error

getOneTaskInstance

public ITaskInstance getOneTaskInstance(IContext context,
 IWorkflowInstance instance)
                                 throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets one of the task instances (any).

Specified by:

getOneTaskInstance in interface IBaseWorkflowModule

Specified by:

getOneTaskInstance in interface IWorkflowModule

Parameters:

context - The execution context.

instance - The IWorkflowInstance 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: IWorkflowModule

Retrieves all the task instances of a specified workflow instance filtered by the name of a ITask.

Specified by:

getTaskInstances in interface IBaseWorkflowModule

Specified by:

getTaskInstances in interface IWorkflowModule

Parameters:

context - The execution context.

instance - The IWorkflowInstance 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: IWorkflowModule

Gets the started task instance associated with a specified task name.

Specified by:

getTaskInstance in interface IBaseWorkflowModule

Specified by:

getTaskInstance in interface IWorkflowModule

Parameters:

context - The execution context.

instance - The IWorkflowInstance object.

name - The system name of a ITask 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: IWorkflowModule

Retrieves all the task instances of a specified workflow instance.

Specified by:

getTaskInstances in interface IBaseWorkflowModule

Specified by:

getTaskInstances in interface IWorkflowModule

Parameters:

context - The execution context.

instance - The IWorkflowInstance 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: IWorkflowModule

Retrieves all the manual task instances of a workflow instance.

Specified by:

getManualTaskInstances in interface IBaseWorkflowModule

Specified by:

getManualTaskInstances in interface IWorkflowModule

Parameters:

context - The execution context.

instance - The IWorkflowInstance 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: IWorkflowModule

Retrieves all the manual task instances for a status.

Specified by:

getManualTaskInstancesByStatus in interface IBaseWorkflowModule

Specified by:

getManualTaskInstancesByStatus in interface IWorkflowModule

Parameters:

context - The execution context.

status - The IWorkflowInstance.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: IWorkflowModule

Retrieves all the manual task instances modified since.

Specified by:

getManualTaskInstancesModifiedSince in interface IBaseWorkflowModule

Specified by:

getManualTaskInstancesModifiedSince in interface IWorkflowModule

Parameters:

context - The execution context.

date - The date.

Returns:

a collection of ITaskInstance

Throws:

WorkflowModuleException - default module exception.

getTask

public ITask getTask(ITaskInstance instance)
              throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets the definition of a task instance.

Specified by:

getTask in interface IBaseWorkflowModule

Specified by:

getTask in interface IWorkflowModule

Parameters:

instance - The ITaskInstance object.

Returns:

a ITask object.

Throws:

WorkflowModuleException - default module exception.

getOperators

public Collection<? extends IOperator> getOperators(ITaskInstance instance)
                                             throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Retrieves the operators of a task instance.

Specified by:

getOperators in interface IBaseWorkflowModule

Specified by:

getOperators in interface IWorkflowModule

Parameters:

instance - the ITaskInstance 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: IWorkflowModule

Retrieves all the started task instances of a workflow instance.

Specified by:

getStartedTaskInstances in interface IBaseWorkflowModule

Specified by:

getStartedTaskInstances in interface IWorkflowModule

Parameters:

context - The execution context.

instance - The IWorkflowInstance 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: IWorkflowModule

Retrieves all the ended task instances of a workflow instance.

Specified by:

getEndedTaskInstances in interface IBaseWorkflowModule

Specified by:

getEndedTaskInstances in interface IWorkflowModule

Parameters:

context - The execution context.

instance - The IWorkflowInstance 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: IWorkflowModule

Retrieves all the aborted task instances of a workflow instance.

Specified by:

getAbortedTaskInstances in interface IBaseWorkflowModule

Specified by:

getAbortedTaskInstances in interface IWorkflowModule

Parameters:

context - The execution context.

instance - The IWorkflowInstance 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: IWorkflowModule

Crosses a transition.

Specified by:

end in interface IBaseWorkflowModule

Specified by:

end in interface IWorkflowModule

Parameters:

context - The execution context.

instance - The ITaskInstance object.

action - The IAction 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: IWorkflowModule

Allows to cross a transition for another user.

Specified by:

end in interface IBaseWorkflowModule

Specified by:

end in interface IWorkflowModule

Parameters:

context - The execution context.

addressee - The IUser for whom to cross the transition.

instance - The ITaskInstance object.

action - The IAction 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: IWorkflowModule

Sends a mail using a specified mail form.

Specified by:

send in interface IBaseWorkflowModule

Specified by:

send in interface IWorkflowModule

Parameters:

context - The execution context.

instance - The ITaskInstance object.

form - The IMailForm 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: IWorkflowModule

Sends a mail using a specified mail form.

Specified by:

send in interface IBaseWorkflowModule

Specified by:

send in interface IWorkflowModule

Parameters:

context - The execution context.

addressee -

instance - The ITaskInstance object.

form - The IMailForm 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: IWorkflowModule

Allows to send a mail.

Specified by:

send in interface IBaseWorkflowModule

Specified by:

send in interface IWorkflowModule

Parameters:

context - The execution context.

workflow - The IWorkflow object.

resource - The IResource object created from IWorkflowModule.createGenericResource() method.

formName - The system name of the form to use.

entries - A collection of IUser, IGroup, InternetAddress or String objects.

Throws:

WorkflowModuleException - default module exception.

send

public void send(IContext context,
 IWorkflow workflow,
 String formName,
 Collection<?> entries)
          throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Allows to send a mail.

Specified by:

send in interface IBaseWorkflowModule

Specified by:

send in interface IWorkflowModule

Parameters:

context - The execution context.

workflow - The IWorkflow object.

formName - The system name of the form to use.

entries - A collection of IUser, IGroup, InternetAddress or String objects.

Throws:

WorkflowModuleException - default module exception.

send

public void send(IContext context,
 IWorkflowInstance workflowInstance,
 String formName,
 Collection<?> entries)
          throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Allows to send a mail with a specific form to a mail recipient.

Specified by:

send in interface IBaseWorkflowModule

Specified by:

send in interface IWorkflowModule

Parameters:

context - The execution context.

workflowInstance - The IWorkflowInstance object.

formName - The system name of the form to use.

entries - A collection of IUser, IGroup, InternetAddress or String objects.

Throws:

WorkflowModuleException - default module exception.

createLinkedResource

public ILinkedResource createLinkedResource(IResource resource,
 String propertyName)
                                     throws WorkflowModuleException

Description copied from interface: IWorkflowModule

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

Specified by:

createLinkedResource in interface IWorkflowModule

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

Gets all the linked resources associated with a table property.

Specified by:

getLinkedResources in interface IBaseWorkflowModule

Specified by:

getLinkedResources in interface IWorkflowModule

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

Gets all the attachments associated with a property.

Specified by:

getAttachments in interface IBaseWorkflowModule

Specified by:

getAttachments in interface IWorkflowModule

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

Gets an attachment by its file name.

Specified by:

getAttachment in interface IBaseWorkflowModule

Specified by:

getAttachment in interface IWorkflowModule

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

Adds an attachment from an attachment.

Specified by:

addAttachment in interface IBaseWorkflowModule

Specified by:

addAttachment in interface IWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

attachment - The IAttachment 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: IWorkflowModule

Adds an attachment with its full path.

Specified by:

addAttachment in interface IBaseWorkflowModule

Specified by:

addAttachment in interface IWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

fileName - The name of the file

fullPath - 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: IWorkflowModule

Adds an attachment as a java.io.File object.

Specified by:

addAttachment in interface IBaseWorkflowModule

Specified by:

addAttachment in interface IWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

file - The File 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: IWorkflowModule

Adds an attachment as an java.io.InputStream object.

Specified by:

addAttachment in interface IBaseWorkflowModule

Specified by:

addAttachment in interface IWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

fileName - The name of the file

input - The InputStream object.

Returns:

An IAttachment object.

Throws:

WorkflowModuleException - default module exception.

getCatalog

public ICatalog getCatalog(IStorageKey key)
                    throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a catalog object from its identifier.

Specified by:

getCatalog in interface IBaseWorkflowModule

Specified by:

getCatalog in interface IWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A ICatalog object.

Throws:

WorkflowModuleException - default module exception.

getRole

@Deprecated
public IRole getRole(IStorageKey key)
              throws WorkflowModuleException

Deprecated.

Description copied from interface: IWorkflowModule

Gets a role object from its identifier.

Specified by:

getRole in interface IBaseWorkflowModule

Specified by:

getRole in interface IWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A IRole object.

Throws:

WorkflowModuleException - default module exception.

getOperatorRole

public IOperatorRole getOperatorRole(IStorageKey key)
                              throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a role object from its identifier.

Specified by:

getOperatorRole in interface IBaseWorkflowModule

Specified by:

getOperatorRole in interface IWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A IOperatorRole object.

Throws:

WorkflowModuleException - default module exception.

getWorkflowContainer

public IWorkflowContainer getWorkflowContainer(IStorageKey key)
                                        throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a workflow container object from its identifier.

Specified by:

getWorkflowContainer in interface IBaseWorkflowModule

Specified by:

getWorkflowContainer in interface IWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A IWorkflowContainer object.

Throws:

WorkflowModuleException - default module exception.

getWorkflow

public IWorkflow getWorkflow(IStorageKey key)
                      throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a workflow object from its identifier.

Specified by:

getWorkflow in interface IBaseWorkflowModule

Specified by:

getWorkflow in interface IWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A IWorkflow object.

Throws:

WorkflowModuleException - default module exception.

getTask

public ITask getTask(IStorageKey key)
              throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a task object from its identifier.

Specified by:

getTask in interface IBaseWorkflowModule

Specified by:

getTask in interface IWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A ITask object.

Throws:

WorkflowModuleException - default module exception.

getAction

public IAction getAction(IStorageKey key)
                  throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets an action object from its identifier.

Specified by:

getAction in interface IBaseWorkflowModule

Specified by:

getAction in interface IWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A IAction object.

Throws:

WorkflowModuleException - default module exception.

getResourceDefinition

public IResourceDefinition getResourceDefinition(IStorageKey key)
                                          throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a resource definition object from its identifier.

Specified by:

getResourceDefinition in interface IBaseWorkflowModule

Specified by:

getResourceDefinition in interface IWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A IResourceDefinition object.

Throws:

WorkflowModuleException - default module exception.

getProperty

public IProperty getProperty(IStorageKey key)
                      throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a property object from its identifier.

Specified by:

getProperty in interface IBaseWorkflowModule

Specified by:

getProperty in interface IWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A IProperty object.

Throws:

WorkflowModuleException - default module exception.

getWorkflowInstance

public IWorkflowInstance getWorkflowInstance(Object document)
                                      throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a IWorkflowInstance object from an object.

Specified by:

getWorkflowInstance in interface IBaseWorkflowModule

Specified by:

getWorkflowInstance in interface IWorkflowModule

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

public IWorkflowInstance getWorkflowInstance(IStorageKey key)
                                      throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a workflow instance object from its identifier.

Specified by:

getWorkflowInstance in interface IBaseWorkflowModule

Specified by:

getWorkflowInstance in interface IWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A IWorkflowInstance object.

Throws:

WorkflowModuleException - default module exception.

getResource

public IResource getResource(Object document)
                      throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a IResource object from an object.

Specified by:

getResource in interface IBaseWorkflowModule

Specified by:

getResource in interface IWorkflowModule

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

Find a storage resource object by specifying the IResourceDefinition object, its reference.

Specified by:

findStorageResourceByReference in interface IBaseWorkflowModule

Specified by:

findStorageResourceByReference in interface IWorkflowModule

Parameters:

context - The execution context.

resourceDefinition - The IResourceDefinition 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: IWorkflowModule

Creates a storage resource object by specifying the IResourceDefinition object, its reference.

Specified by:

createStorageResource in interface IBaseWorkflowModule

Specified by:

createStorageResource in interface IWorkflowModule

Parameters:

context - The execution context.

resourceDefinition - The IResourceDefinition 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: IWorkflowModule

Creates a storage resource object by specifying the IResourceDefinition object, its reference, and its label.

Specified by:

createStorageResource in interface IBaseWorkflowModule

Specified by:

createStorageResource in interface IWorkflowModule

Parameters:

context - The execution context.

resourceDefinition - The IResourceDefinition object.

reference - The reference to set.

label - The label to set.

Returns:

a IStorageResource object.

Throws:

WorkflowModuleException - default module exception.

getOperator

public IOperator getOperator(IStorageKey key)
                      throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets an operator object from its identifier.

Specified by:

getOperator in interface IBaseWorkflowModule

Specified by:

getOperator in interface IWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A IOperator object.

Throws:

WorkflowModuleException - default module exception.

getOperatorByLogin

public IOperator getOperatorByLogin(String login)
                             throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets an IOperator from a user login.

Specified by:

getOperatorByLogin in interface IBaseWorkflowModule

Specified by:

getOperatorByLogin in interface IWorkflowModule

Parameters:

login - The user login

Returns:

A IOperator object.

Throws:

WorkflowModuleException - default module exception.

getResource

public IResource getResource(IStorageKey key)
                      throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a resource object from its identifier.

Specified by:

getResource in interface IBaseWorkflowModule

Specified by:

getResource in interface IWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A IResource object.

Throws:

WorkflowModuleException - default module exception.

getTaskInstance

public ITaskInstance getTaskInstance(IStorageKey key)
                              throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a task instance object from its identifier.

Specified by:

getTaskInstance in interface IBaseWorkflowModule

Specified by:

getTaskInstance in interface IWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A ITaskInstance object.

Throws:

WorkflowModuleException - default module exception.

getCatalog

public ICatalog getCatalog(IResourceDefinition resourceDefinition)
                    throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a ICatalog object from a resource definitino.

Specified by:

getCatalog in interface IBaseWorkflowModule

Specified by:

getCatalog in interface IWorkflowModule

Parameters:

resourceDefinition - A resource definition.

Returns:

A ICatalog object.

Throws:

WorkflowModuleException - default module exception.

getGroup

public IGroup getGroup(String id)
                throws WorkflowModuleException

Get a group from its id

Parameters:

id - the group's id

Returns:

the group

Throws:

WorkflowModuleException - on error

getGroupByName

public IGroup getGroupByName(String name)
                      throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a group by its name

Specified by:

getGroupByName in interface IBaseWorkflowModule

Specified by:

getGroupByName in interface IWorkflowModule

Parameters:

name - The system name of the group.

Returns:

A IGroup object.

Throws:

WorkflowModuleException - default module exception.

getWorkflowContainer

public IWorkflowContainer getWorkflowContainer(String id)
                                        throws WorkflowModuleException

Get workflow container from its id

Parameters:

id - the workflow container's id

Returns:

the workflow container

Throws:

WorkflowModuleException - on error

getWorkflow

public IWorkflow getWorkflow(String id)
                      throws WorkflowModuleException

Get workflow from its id

Parameters:

id - the workflow's id

Returns:

the workflow

Throws:

WorkflowModuleException - on error

getWorkflowInstance

public IWorkflowInstance getWorkflowInstance(String id)
                                      throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a IWorkflowInstance object from its string identifier.

Specified by:

getWorkflowInstance in interface IBaseWorkflowModule

Specified by:

getWorkflowInstance in interface IWorkflowModule

Parameters:

id - A string identifier.

Returns:

A IWorkflowInstance object.

Throws:

WorkflowModuleException - default module exception.

getTaskInstance

public ITaskInstance getTaskInstance(String id)
                              throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a ITaskInstance object from its string identifier.

Specified by:

getTaskInstance in interface IBaseWorkflowModule

Specified by:

getTaskInstance in interface IWorkflowModule

Parameters:

id - A string identifier.

Returns:

A ITaskInstance object.

Throws:

WorkflowModuleException - default module exception.

getOperator

public IOperator getOperator(String id)
                      throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a IOperator object from its string identifier.

Specified by:

getOperator in interface IBaseWorkflowModule

Specified by:

getOperator in interface IWorkflowModule

Parameters:

id - A string identifier.

Returns:

A IOperator object.

Throws:

WorkflowModuleException - default module exception.

getResource

public IResource getResource(String id)
                      throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a IResource object from its string identifier.

Specified by:

getResource in interface IBaseWorkflowModule

Specified by:

getResource in interface IWorkflowModule

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

Gets a collection of IResource objects from a resource definition.

Specified by:

getResources in interface IBaseWorkflowModule

Specified by:

getResources in interface IWorkflowModule

Parameters:

context - The execution context.

resourceDefinition - The IResourceDefinition 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: IWorkflowModule

Gets a collection of IResource objects from a catalog

Specified by:

getResources in interface IBaseWorkflowModule

Specified by:

getResources in interface IWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog object.

Returns:

a Collection of IResource object.

Throws:

WorkflowModuleException - default module exception.

getParentInstance

public IWorkflowInstance getParentInstance(ILinkedResource linkedResource)
                                    throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets the parent instance of a linked resource.

Specified by:

getParentInstance in interface IBaseWorkflowModule

Specified by:

getParentInstance in interface IWorkflowModule

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

Gets a collection of IElement objects from a multiple selector property.

Specified by:

getExternalElements in interface IBaseWorkflowModule

Specified by:

getExternalElements in interface IWorkflowModule

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

Gets a IGroup object from a single group selector property.

Specified by:

getExternalGroup in interface IBaseWorkflowModule

Specified by:

getExternalGroup in interface IWorkflowModule

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

Gets a ILocalization object from a single localization selector property.

Specified by:

getExternalLocalization in interface IBaseWorkflowModule

Specified by:

getExternalLocalization in interface IWorkflowModule

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

Gets a IOrganization object from a single organization selector property.

Specified by:

getExternalOrganization in interface IBaseWorkflowModule

Specified by:

getExternalOrganization in interface IWorkflowModule

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

Gets a IUser object from a single user selector property.

Specified by:

getExternalUser in interface IBaseWorkflowModule

Specified by:

getExternalUser in interface IWorkflowModule

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

Gets a IFile object from a single file selector property.

Specified by:

getExternalFile in interface IBaseWorkflowModule

Specified by:

getExternalFile in interface IWorkflowModule

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

Gets a IFolder object from a single folder selector property.

Specified by:

getExternalFolder in interface IBaseWorkflowModule

Specified by:

getExternalFolder in interface IWorkflowModule

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

Gets a ILibrary object from a single library selector property.

Specified by:

getExternalLibrary in interface IBaseWorkflowModule

Specified by:

getExternalLibrary in interface IWorkflowModule

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

Sets a IElement to a multiple selector property.

Specified by:

setExternalElements in interface IBaseWorkflowModule

Specified by:

setExternalElements in interface IWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

elements - A collection of IElement objects.

Throws:

WorkflowModuleException - default module exception.

setExternalUser

public void setExternalUser(IResource resource,
 String propertyName,
 IUser user)
                     throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Sets a IUser to a single selector property.

Specified by:

setExternalUser in interface IBaseWorkflowModule

Specified by:

setExternalUser in interface IWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

user - A IUser object.

Throws:

WorkflowModuleException - default module exception.

setExternalGroup

public void setExternalGroup(IResource resource,
 String propertyName,
 IGroup group)
                      throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Sets a IGroup to a single selector property.

Specified by:

setExternalGroup in interface IBaseWorkflowModule

Specified by:

setExternalGroup in interface IWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

group - A IGroup object.

Throws:

WorkflowModuleException - default module exception.

setExternalLocalization

public void setExternalLocalization(IResource resource,
 String propertyName,
 ILocalization localization)
                             throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Sets a ILocalization to a single selector property.

Specified by:

setExternalLocalization in interface IBaseWorkflowModule

Specified by:

setExternalLocalization in interface IWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

localization - A ILocalization object.

Throws:

WorkflowModuleException - default module exception.

setExternalOrganization

public void setExternalOrganization(IResource resource,
 String propertyName,
 IOrganization organization)
                             throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Sets a IOrganization to a single selector property.

Specified by:

setExternalOrganization in interface IBaseWorkflowModule

Specified by:

setExternalOrganization in interface IWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

organization - A IOrganization object.

Throws:

WorkflowModuleException - default module exception.

setExternalFile

public void setExternalFile(IResource resource,
 String propertyName,
 IFile file)
                     throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Sets a IFile to a single selector property.

Specified by:

setExternalFile in interface IBaseWorkflowModule

Specified by:

setExternalFile in interface IWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

file - A IFile object.

Throws:

WorkflowModuleException - default module exception.

setExternalFolder

public void setExternalFolder(IResource resource,
 String propertyName,
 IFolder folder)
                       throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Sets a IFolder to a single selector property.

Specified by:

setExternalFolder in interface IBaseWorkflowModule

Specified by:

setExternalFolder in interface IWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

folder - A IFolder object.

Throws:

WorkflowModuleException - default module exception.

setExternalLibrary

public void setExternalLibrary(IResource resource,
 String propertyName,
 ILibrary library)
                        throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Sets a ILibrary to a single selector property.

Specified by:

setExternalLibrary in interface IBaseWorkflowModule

Specified by:

setExternalLibrary in interface IWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

library - A ILibrary object.

Throws:

WorkflowModuleException - default module exception.

getSearchController

public ISearchController getSearchController(IJdbcReference reference)
                                      throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a search controller object by specifying a JDBC external reference.

Specified by:

getSearchController in interface IBaseWorkflowModule

Specified by:

getSearchController in interface IWorkflowModule

Parameters:

reference - The IJdbcReference object.

Returns:

The ISearchController object.

Throws:

WorkflowModuleException - default module exception.

getSearchController

public ISearchController getSearchController(IConnectionDefinition connectionDefinition)
                                      throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a search controller object by specifying a ConnectionDefinition object.

Specified by:

getSearchController in interface IBaseWorkflowModule

Specified by:

getSearchController in interface IWorkflowModule

Parameters:

connectionDefinition - The IConnectionDefinition object.

Returns:

The ISearchController object.

Throws:

WorkflowModuleException - default module exception.

getSearchController

public ISearchController getSearchController(IDataSourceReference reference)
                                      throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a search controller object by specifying an external data source.

Specified by:

getSearchController in interface IBaseWorkflowModule

Specified by:

getSearchController in interface IWorkflowModule

Parameters:

reference - The IDataSourceReference object.

Returns:

The ISearchController object.

Throws:

WorkflowModuleException - default module exception.

getSearchController

public ISearchController getSearchController()
                                      throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets the default ISearchController object.

Specified by:

getSearchController in interface IBaseWorkflowModule

Specified by:

getSearchController in interface IWorkflowModule

Returns:

The default ISearchController object.

Throws:

WorkflowModuleException - default module exception.

getSecurityController

public ISecurityController getSecurityController(ISecuritySupport securitySupport)
                                          throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a security controller on a specified object.

Specified by:

getSecurityController in interface IBaseWorkflowModule

Specified by:

getSecurityController in interface IWorkflowModule

Parameters:

securitySupport - Any IElement that implements ISecuritySupport interface.

Returns:

The ISecurityController object.

Throws:

WorkflowModuleException - default module exception.

getArchivingController

public IArchivingController getArchivingController()
                                            throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a archiving controller to archive IElement objects.

Specified by:

getArchivingController in interface IBaseWorkflowModule

Specified by:

getArchivingController in interface IWorkflowModule

Returns:

A IArchivingController object.

Throws:

WorkflowModuleException - default module exception.

getDelegationController

public IDelegationController getDelegationController()
                                              throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a delegation controller to delegate IDelegationSupport objects.

Specified by:

getDelegationController in interface IBaseWorkflowModule

Specified by:

getDelegationController in interface IWorkflowModule

Returns:

A IDelegationController object.

Throws:

WorkflowModuleException - default module exception.

getTransformer

public ITransformer getTransformer()
                            throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a transformer to transform IResource object.

Specified by:

getTransformer in interface IBaseWorkflowModule

Specified by:

getTransformer in interface IWorkflowModule

Returns:

A ITransformer object.

Throws:

WorkflowModuleException - default module exception.

getViewController

@Deprecated
public IViewController getViewController()
                                  throws WorkflowModuleException

Deprecated.

Description copied from interface: IWorkflowModule

Gets a view controller to search IResource objects through their properties.

Specified by:

getViewController in interface IBaseWorkflowModule

Specified by:

getViewController in interface IWorkflowModule

Returns:

A IViewController object.

Throws:

WorkflowModuleException - default module exception.

getViewController

public IViewController getViewController(IContext context)
                                  throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a view controller to search IResource objects through their properties.

Specified by:

getViewController in interface IBaseWorkflowModule

Specified by:

getViewController in interface IWorkflowModule

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

Gets a view controller to search IResource objects through their properties.

Specified by:

getViewController in interface IBaseWorkflowModule

Specified by:

getViewController in interface IWorkflowModule

Parameters:

natureClass - : The class of the searched objects IWorkflowInstance, 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: IWorkflowModule

Gets a view controller to search IResource objects through their properties.

Specified by:

getViewController in interface IBaseWorkflowModule

Specified by:

getViewController in interface IWorkflowModule

Parameters:

context - The execution context.

natureClass - : The class of the searched objects IWorkflowInstance, 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

Use getViewController(IContext, IProject, Definition)

Throws:

WorkflowModuleException

getViewController

public IViewController getViewController(IContext context,
 IProject project,
 com.axemble.vdp.views.query.Definition definition)
                                  throws WorkflowModuleException

Internal method

Get a view controller build with the given parameters

Parameters:

context - the current context

project - the project

definition - 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: IWorkflowModule

Gets a view controller to search IResource objects through their properties.

Specified by:

getViewController in interface IBaseWorkflowModule

Specified by:

getViewController in interface IWorkflowModule

Parameters:

project - The current project

inputStream - 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: IWorkflowModule

Gets a view controller to search IResource objects through their properties.

Specified by:

getViewController in interface IBaseWorkflowModule

Specified by:

getViewController in interface IWorkflowModule

Parameters:

context - The execution context.

project - The current project

inputStream - The java.io.InputStream XML entry.

Returns:

A IViewController object.

Throws:

WorkflowModuleException - default module exception.

getTaskViewTransformer

public ITaskViewTransformer getTaskViewTransformer()
                                            throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a task view transformer to transform ITaskInstance objects.

Specified by:

getTaskViewTransformer in interface IBaseWorkflowModule

Specified by:

getTaskViewTransformer in interface IWorkflowModule

Returns:

A ITaskViewTransformer object.

Throws:

WorkflowModuleException - default module exception.

getResourceViewTransformer

public IResourceViewTransformer getResourceViewTransformer()
                                                    throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a resource view transformer to transform IResource objects.

Specified by:

getResourceViewTransformer in interface IBaseWorkflowModule

Specified by:

getResourceViewTransformer in interface IWorkflowModule

Returns:

A IResourceViewTransformer object.

Throws:

WorkflowModuleException - default module exception.

getWorkflowViewTransformer

public IWorkflowViewTransformer getWorkflowViewTransformer()
                                                    throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a workflow view transformer to transform IWorkflow objects.

Specified by:

getWorkflowViewTransformer in interface IBaseWorkflowModule

Specified by:

getWorkflowViewTransformer in interface IWorkflowModule

Returns:

A IWorkflowViewTransformer object.

Throws:

WorkflowModuleException - default module exception.

getWorkflowContainerViewTransformer

public IWorkflowContainerViewTransformer getWorkflowContainerViewTransformer()
                                                                      throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a workflow container view transformer to transform IWorkflowContainer objects.

Specified by:

getWorkflowContainerViewTransformer in interface IBaseWorkflowModule

Specified by:

getWorkflowContainerViewTransformer in interface IWorkflowModule

Returns:

A IWorkflowContainerViewTransformer object.

Throws:

WorkflowModuleException - default module exception.

getCatalogViewTransformer

public ICatalogViewTransformer getCatalogViewTransformer()
                                                  throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a catalog view transformer to transform ICatalog objects.

Specified by:

getCatalogViewTransformer in interface IBaseWorkflowModule

Specified by:

getCatalogViewTransformer in interface IWorkflowModule

Returns:

A ICatalogViewTransformer object.

Throws:

WorkflowModuleException - default module exception.

getSearchViewTransformer

public ISearchViewTransformer getSearchViewTransformer()
                                                throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a search view transformer to transform IResource objects.

Specified by:

getSearchViewTransformer in interface IBaseWorkflowModule

Specified by:

getSearchViewTransformer in interface IWorkflowModule

Returns:

A ISearchViewTransformer object.

Throws:

WorkflowModuleException - default module exception.

generateReference

public String generateReference(IResourceDefinition resourceDefinition)
                         throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Evaluate the next reference based on the format specified on the Designer tool.

Specified by:

generateReference in interface IBaseWorkflowModule

Specified by:

generateReference in interface IWorkflowModule

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

Evaluate the next reference based on the passed format.

Specified by:

generateReference in interface IBaseWorkflowModule

Specified by:

generateReference in interface IWorkflowModule

Parameters:

resourceDefinition - The IResourceDefinition object.

format - The format to use to evaluate the next reference.

Returns:

The evaluated reference.

Throws:

WorkflowModuleException - default module exception.

generateReference

public String generateReference(IResource resource,
 Document format)
                         throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Evaluate the next reference based specified format.

Specified by:

generateReference in interface IBaseWorkflowModule

Specified by:

generateReference in interface IWorkflowModule

Parameters:

resource - The resource to be created.

format - An XML format definition.

Returns:

The evaluated reference.

Throws:

WorkflowModuleException - default module exception.

generateReference

public String generateReference(IResource resource)
                         throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Evaluate the next reference based on the format specified on the Designer tool.

Specified by:

generateReference in interface IBaseWorkflowModule

Specified by:

generateReference in interface IWorkflowModule

Parameters:

resource - The resource to be created.

Returns:

The evaluated reference.

Throws:

WorkflowModuleException - default module exception.

generateReference

public String generateReference(IResource resource,
 String format)
                         throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Evaluate the next reference based on the specified format.

Specified by:

generateReference in interface IBaseWorkflowModule

Specified by:

generateReference in interface IWorkflowModule

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

public int generateChrono(IResourceDefinition resourceDefinition)
                   throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Evaluate the next chrono based on the format specified on the Designer tool.

Specified by:

generateChrono in interface IBaseWorkflowModule

Specified by:

generateChrono in interface IWorkflowModule

Parameters:

resourceDefinition - The resource definition object

Returns:

The evaluated chrono.

Throws:

WorkflowModuleException - default module exception.

createGenericResource

public IResource createGenericResource()
                                throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Creates a generic resource for mail purposes.

Specified by:

createGenericResource in interface IBaseWorkflowModule

Specified by:

createGenericResource in interface IWorkflowModule

Returns:

The IResource object.

Throws:

WorkflowModuleException - default module exception.

execute

public void execute(IAgent agent)
             throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Allows to execute an agent.

Specified by:

execute in interface IBaseWorkflowModule

Specified by:

execute in interface IWorkflowModule

Parameters:

agent - The IAgent to execute.

Throws:

WorkflowModuleException - default module exception.

execute

public void execute(IContext context,
 IAgent agent)
             throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Allows to execute an agent.

Specified by:

execute in interface IBaseWorkflowModule

Specified by:

execute in interface IWorkflowModule

Parameters:

context - The execution context.

agent - The IAgent to execute.

Throws:

WorkflowModuleException - default module exception.

getAgent

public IAgent getAgent(IContext context,
 String name)
                throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets an agent from its name.

Specified by:

getAgent in interface IBaseWorkflowModule

Specified by:

getAgent in interface IWorkflowModule

Parameters:

context - The execution context.

name - The name of the agent.

Returns:

a IAgent object.

Throws:

WorkflowModuleException - default module exception.

addChild

public void addChild(IGroup group,
 IRole role)
              throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Adds a group to a role.

Specified by:

addChild in interface IBaseWorkflowModule

Specified by:

addChild in interface IWorkflowModule

Parameters:

group - The group to add.

role - The role object.

Throws:

WorkflowModuleException - default module exception.

addMember

public void addMember(IUser user,
 IRole role)
               throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Adds a user to a role.

Specified by:

addMember in interface IBaseWorkflowModule

Specified by:

addMember in interface IWorkflowModule

Parameters:

user - The user to add.

role - The role object.

Throws:

WorkflowModuleException - default module exception.

evaluatedHtml

public String evaluatedHtml(IResource resource,
 IMailForm mailForm)
                     throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Evaluates the form and returns the HTML content as a java.lang.String object.

Specified by:

evaluatedHtml in interface IBaseWorkflowModule

Specified by:

evaluatedHtml in interface IWorkflowModule

Parameters:

resource - The IResource object to evaluate with.

mailForm - The IMailForm 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: IWorkflowModule

Evaluates the form and returns the HTML content as a java.lang.String object.

Specified by:

buildMailMessage in interface IBaseWorkflowModule

Specified by:

buildMailMessage in interface IWorkflowModule

Parameters:

resource - The IResource object to evaluate with.

mailForm - The IMailForm 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: IWorkflowModule

Evaluates the form and returns the HTML content as a java.lang.String object.

Specified by:

evaluatedHtml in interface IBaseWorkflowModule

Specified by:

evaluatedHtml in interface IWorkflowModule

Parameters:

taskInstance - The ITaskInstance object to evaluate with.

mailForm - The IMailForm 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: IWorkflowModule

Evaluates the form and returns the HTML content as a java.lang.String object.

Specified by:

buildMailMessage in interface IBaseWorkflowModule

Specified by:

buildMailMessage in interface IWorkflowModule

Parameters:

taskInstance - The ITaskInstance object to evaluate with.

mailForm - The IMailForm 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 resource

mailForm - The IMailForm 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 instance

mailForm - The IMailForm 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: IWorkflowModule

Sends a mail by specifying the subject and the content of the body.

Specified by:

send in interface IBaseWorkflowModule

Specified by:

send in interface IWorkflowModule

Parameters:

context - The execution context.

taskInstance - The ITaskInstance object to evaluate with.

mailForm - The IMailForm object.

entries - A collection of IUser, IGroup, InternetAddress or String 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: IWorkflowModule

Sends a mail by specifying the subject and the content of the body.

Specified by:

send in interface IBaseWorkflowModule

Specified by:

send in interface IWorkflowModule

Parameters:

context - The execution context.

resource - The IResource object to evaluate with.

mailForm - The IMailForm object.

entries - A collection of IUser, IGroup, InternetAddress or String 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: IWorkflowModule

Gets all the mail forms from a specified IWorkflow object.

Specified by:

getMailForms in interface IBaseWorkflowModule

Specified by:

getMailForms in interface IWorkflowModule

Parameters:

context - The execution context.

workflow - The IWorkflow 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 interface IBaseWorkflowModule

Specified by:

getMailForms in interface IWorkflowModule

Parameters:

context - The execution context.

workflow - The IWorkflow 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 interface IBaseWorkflowModule

Specified by:

getMailForm in interface IWorkflowModule

Parameters:

context - The execution context.

workflow - The IWorkflow 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: IWorkflowModule

Gets a workflow form by its name.

Specified by:

getForm in interface IBaseWorkflowModule

Specified by:

getForm in interface IWorkflowModule

Parameters:

context - The execution context.

workflow - The IWorkflow 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: IWorkflowModule

Gets a resource definition form by its name.

Specified by:

getForm in interface IBaseWorkflowModule

Specified by:

getForm in interface IWorkflowModule

Parameters:

context - The execution context.

resourceDefinition - The IResourceDefinition 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,
 ITask task,
 String formName)
              throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a task form by its name.

Specified by:

getForm in interface IBaseWorkflowModule

Specified by:

getForm in interface IWorkflowModule

Parameters:

context - The execution context.

task - The ITask 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: IWorkflowModule

Gets a action form by its name.

Specified by:

getForm in interface IBaseWorkflowModule

Specified by:

getForm in interface IWorkflowModule

Parameters:

context - The execution context.

action - The IAction 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: IWorkflowModule

Gets a sub form by its name.

Specified by:

getSubForm in interface IBaseWorkflowModule

Specified by:

getSubForm in interface IWorkflowModule

Parameters:

context - The execution context.

workflow - The IWorkflow object.

formName - The name of the form.

Returns:

a IForm object.

Throws:

WorkflowModuleException - default module exception. default module exception.

getGenericViewTransformer

public IGenericViewTransformer getGenericViewTransformer()
                                                  throws WorkflowModuleException

Specified by:

getGenericViewTransformer in interface IBaseWorkflowModule

Specified by:

getGenericViewTransformer in interface IWorkflowModule

Throws:

WorkflowModuleException

getResourceHistory

public IResourceHistory getResourceHistory(IWorkflowInstance workflowInstance)

Specified by:

getResourceHistory in interface com.axemble.vdoc.core.interfaces.InternalProcessModule

getResourceController

public IResourceController getResourceController(IResource resource)
                                          throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets the resource controller object.

Specified by:

getResourceController in interface IWorkflowModule

Parameters:

resource - The main resource to work on.

Returns:

A IResourceController object.

Throws:

WorkflowModuleException - default module exception.

getFieldController

public IFieldController getFieldController(ICatalog catalog)

Description copied from interface: IWorkflowModule

Gets the resource controller object.

Specified by:

getFieldController in interface IWorkflowModule

Parameters:

catalog - the catalog containing the fields

Returns:

A IFieldController object.

getFieldController

public IFieldController getFieldController(IWorkflow workflow)

Description copied from interface: IWorkflowModule

Gets the resource controller object.

Specified by:

getFieldController in interface IWorkflowModule

Parameters:

workflow - the workflow containing the fields

Returns:

A IFieldController object.

getFieldController

public IFieldController getFieldController(IResourceDefinition resourceDefinition)

Description copied from interface: IWorkflowModule

Gets the resource controller object.

Specified by:

getFieldController in interface IWorkflowModule

Parameters:

resourceDefinition - the resourceDefinition containing the fields

Returns:

A IFieldController object.

getTaskInstanceTransformer

public ITaskInstanceTransformer getTaskInstanceTransformer()
                                                    throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Gets a task transformer to transform ITaskInstance object.

Specified by:

getTaskInstanceTransformer in interface IBaseWorkflowModule

Specified by:

getTaskInstanceTransformer in interface IWorkflowModule

Returns:

A ITaskInstanceTransformer object.

Throws:

WorkflowModuleException - default module exception.

getViewTransformer

public ITaskViewTransformer getViewTransformer()
                                        throws WorkflowModuleException

Throws:

WorkflowModuleException

send

public void send(IContext context,
 ITaskInstance taskInstance,
 IMailForm mailForm,
 Collection<? extends IUser> mailTo,
 String comment)
          throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Sends a mail by specifying the subject and the content of the body.

Specified by:

send in interface IBaseWorkflowModule

Specified by:

send in interface IWorkflowModule

Parameters:

context - The execution context.

taskInstance - The ITaskInstance object to evaluate with.

mailForm - The IMailForm object.

mailTo - A collection of IUser, IGroup, InternetAddress or String objects.

comment - The comment which will be displayed in the history entries.

Throws:

WorkflowModuleException - default module exception.

send

public void send(IContext context,
 IResource resource,
 IMailForm mailForm,
 Collection<? extends IUser> mailTo,
 String comment)
          throws WorkflowModuleException

Description copied from interface: IWorkflowModule

Sends a mail by specifying the subject and the content of the body.

Specified by:

send in interface IBaseWorkflowModule

Specified by:

send in interface IWorkflowModule

Parameters:

context - The execution context.

resource - The IResource object to evaluate with.

mailForm - The IMailForm object.

mailTo - A collection of IUser, IGroup, InternetAddress or String 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 interface IWorkflowModule

Parameters:

context - The IContext execution context.

workflowInstance - The IWorkflowInstance 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 interface IWorkflowModule

Parameters:

context - The IContext execution context.

workflowInstance - The IWorkflowInstance 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 interface IWorkflowModule

Parameters:

context - The IContext execution context.

workflowInstance - The IWorkflowInstance 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 interface IWorkflowModule

Parameters:

context - The IContext execution context.

workflowInstance - The IWorkflowInstance 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 interface IWorkflowModule

Parameters:

context - The IContext execution context.

workflowInstance - The IWorkflowInstance 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 interface IWorkflowModule

Parameters:

catalog - The ICatalog link to the list

listName - list name

key - key of the value

language - 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: IWorkflowModule

Creates a dynamicLocalizationsWrapper object by specifying the parent ICatalog object.

Specified by:

setDynamicLocalizationsWrapperMessageForLanguage in interface IBaseWorkflowModule

Specified by:

setDynamicLocalizationsWrapperMessageForLanguage in interface IWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog object.

language - The language

message - The message

Returns:

A IDynamicLocalizationsWrapper object.

Throws:

ModuleException - default module exception.

createDynamicLocalizationsWrapper

public IDynamicLocalizationsWrapper createDynamicLocalizationsWrapper(IContext context,
 ICatalog catalog)
                                                               throws ModuleException

Description copied from interface: IWorkflowModule

Creates a dynamicLocalizationsWrapper object by specifying the parent ICatalog object.

Specified by:

createDynamicLocalizationsWrapper in interface IBaseWorkflowModule

Specified by:

createDynamicLocalizationsWrapper in interface IWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog object.

Returns:

A IDynamicLocalizationsWrapper object.

Throws:

ModuleException - default module exception.

generateSystemName

public String generateSystemName(String label)

Description copied from interface: IModule

Generate a valid system name for this module and this label.

Specified by:

generateSystemName in interface IModule

Parameters:

label - label to normalize

Returns:

normalized value

hasDiscussionThread

public boolean hasDiscussionThread(IContext context,
 IWorkflowInstance iWorkflowInstance)

Description copied from interface: IWorkflowModule

Allows knowing if an IWorkflowInstance has a discussion thread or not

Specified by:

hasDiscussionThread in interface IBaseWorkflowModule

Specified by:

hasDiscussionThread in interface IWorkflowModule

Parameters:

context - the context

iWorkflowInstance - the IWorkflowInstance

Returns:

true if IWorkflowInstance has a discussion thread otherwise false

getDiscussionMessagesOrderByCreationDateDesc

public Collection<IWorkflowInstanceDiscussionMessage> getDiscussionMessagesOrderByCreationDateDesc(IContext context,
 IWorkflowInstance iWorkflowInstance)

Description copied from interface: IWorkflowModule

Retrieve IWorkflowInstance's message

Specified by:

getDiscussionMessagesOrderByCreationDateDesc in interface IBaseWorkflowModule

Specified by:

getDiscussionMessagesOrderByCreationDateDesc in interface IWorkflowModule

Parameters:

context - the context

iWorkflowInstance - the workflowInstance

Returns:

the IWorkflowInstanceDiscussionMessage collection

canModifyDiscussionMessage

public DiscussionAccessCheckResult canModifyDiscussionMessage(IContext context,
 IDiscussionMessage iDiscussionMessage)

Description copied from interface: IWorkflowModule

Allows knowing if an IDiscussionMessage can be modified in the current IContext or not

Specified by:

canModifyDiscussionMessage in interface IBaseWorkflowModule

Specified by:

canModifyDiscussionMessage in interface IWorkflowModule

Parameters:

context - the context

iDiscussionMessage - the IDiscussionMessage

Returns:

the DiscussionAccessCheckResult enum value result

canDeleteDiscussionMessage

public DiscussionAccessCheckResult canDeleteDiscussionMessage(IContext context,
 IDiscussionMessage iDiscussionMessage)

Description copied from interface: IWorkflowModule

Allows knowing if an IDiscussionMessage can be deleted in the current IContext or not

Specified by:

canDeleteDiscussionMessage in interface IBaseWorkflowModule

Specified by:

canDeleteDiscussionMessage in interface IWorkflowModule

Parameters:

context - the context

iDiscussionMessage - the IDiscussionMessage

Returns:

the DiscussionAccessCheckResult enum value result

deleteDiscussionMessage

public void deleteDiscussionMessage(IContext context,
 IWorkflowInstanceDiscussionMessage iWorkflowInstanceDiscussionMessage,
 IWorkflowInstance iWorkflowInstance)

Description copied from interface: IWorkflowModule

Delete an IWorkflowInstanceDiscussionMessage for an IWorkflowInstance. It is necessary to save the IWorkflowInstance after calling this method.

Specified by:

deleteDiscussionMessage in interface IBaseWorkflowModule

Specified by:

deleteDiscussionMessage in interface IWorkflowModule

Parameters:

context - the context

iWorkflowInstanceDiscussionMessage - the iWorkflowInstanceDiscussionMessage

iWorkflowInstance - the the IWorkflowInstance

createDiscussionMessage

public IWorkflowInstanceDiscussionMessage createDiscussionMessage(IContext context,
 IWorkflowInstance iWorkflowInstance,
 String content,
 Collection<IAttachment> attachments,
 String visibility,
 Collection<IUser> recipients,
 IOrganization visibilityOrganization)

Description copied from interface: IWorkflowModule

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

Specified by:

createDiscussionMessage in interface IWorkflowModule

Parameters:

context - the context

iWorkflowInstance - the IWorkflowInstance

content - The content

attachments - the collection of IAttachment

visibility - the visibility string code

recipients - the collection of IUser recipients for visibility mode VisibilityMode SENDER_AND_RECIPIENTS or null

visibilityOrganization - the IOrganization 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: IWorkflowModule

Update content and/or attachments of a message.

Specified by:

updateDiscussionMessage in interface IBaseWorkflowModule

Specified by:

updateDiscussionMessage in interface IWorkflowModule

Parameters:

context - the context

iWorkflowInstanceDiscussionMessage - the iWorkflowInstanceDiscussionMessage

content - the content

attachments - the collection of IAttachment