Package com.axemble.vdoc.sdk.modules

Interface IWorkflowModule

All Superinterfaces:

IBaseWorkflowModule, IModule, Remote

All Known Implementing Classes:

com.axemble.vdoc.sdk.impl.ProcessWorkflowModule, ReportProcessWorkflowModule, WorkflowModuleImpl

public interface IWorkflowModule
extends IBaseWorkflowModule

The IWorkflowModule interface is the main entry point from where most of the methods to manipulate the full set of work-flow document objects are made available.

Code sample :

 // creation of a workflow module object
 IWorkflowModule workflowModule = SDKFactory.MODULES.getWorkflowModule();
 try
 {
 }
 finally
 {
  // uninitialize the module
        SDKFactory.MODULES.releaseModule(workflowModule);
 }
 

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 inputStream)	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)	Deprecated. : use createCatalog( IContext context, String name, String label, IProject project )
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.
IProfile	createProfile(IContext context, IProtocolSupport link, String name)	Creates a IProfile.
IRole	createRole(IContext context, ICatalog catalog, String name)	Deprecated. : use createOperatorRole or createProfile
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)	Deprecated. : use buildMailMessage( IResource resource, IMailForm mailForm, String language )
String	evaluatedHtml(ITaskInstance taskInstance, IMailForm mailForm)	Deprecated. : use buildMailMessage( ITaskInstance taskInstance, IMailForm mailForm, String language )
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)	Deprecated. : should not use this method anymore.
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)	Deprecated. : should not use this method anymore.
String	generateReference(IResource resource, String format)	Deprecated. : should not use this method anymore.
String	generateReference(IResource resource, Document format)	Evaluate the next reference based specified format.
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)	Deprecated. : use getCatalog( IContext context, String name, IProject project )
ICatalog	getCatalog(IContext context, String name, int catalogType)	Deprecated. : use getCatalog( IContext context, String name, int catalogType, IProject project )
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)	Deprecated. : use getCatalogs( IContext context, IProject project )
Collection<? extends ICatalog>	getCatalogs(IContext context, int catalogType)	Deprecated. : use getCatalogs( IContext context, int catalogType, IProject project )
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.
IConfiguration	getConfiguration()	Gets the global configuration.
IDataSourceReference	getDataSourceReference(String name)	Gets a data source reference from its JNDI name.
IDataSourceReference	getDefaultDataSourceReference()	Gets the default data source reference.
com.axemble.vdoc.sdk.interfaces.ui.definitions.IDefinitionsFactory	getDefinitionsFactory()	Gets access to all available definitions.
IDelegationController	getDelegationController()	Gets a delegation controller to delegate IDelegationSupport objects.
Collection<IWorkflowInstanceDiscussionMessage>	getDiscussionMessagesOrderByCreationDateDesc(IContext context, IWorkflowInstance workflowInstance)	Retrieve IWorkflowInstance's message
IProtocolSupport	getElementByProtocolURI(String protocolURI)	Gets an IElement object which implements IProtocolSupport interface.
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	getGroupByName(String name)	Deprecated. use the IDirectoryModule instead.
IJdbcReference	getJdbcReference(IContext context, String name)	Deprecated. : use getConnectionDefinition( IContext context, String name ) method instead.
Collection<? extends IJdbcReference>	getJdbcReferences(IContext context)	Deprecated. : use getConnectionDefinitions( IContext context ) method instead.
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.
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)	Deprecated. Use getOperator( IStorageKey key ) method instead.
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.
IProfile	getProfile(IContext context, IProtocolSupport link, String name)	Retrieves a IProfile object by its system name.
IProfile	getProfile(IStorageKey key)	Gets a role object from its identifier.
Collection<? extends IProfile>	getProfiles(IContext context, IProtocolSupport link)	Retrieves a collection of IProfile objects within a specified link.
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.
IResource	getResource(Object object)	Gets a IResource object from an object.
IResource	getResource(String id)	Deprecated. Use getResource( IStorageKey key ) method instead.
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
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. : use getRole or getProfile
IRole	getRole(IStorageKey key)	Deprecated. use getOperatorRole or getProfile
Collection<? extends IRole>	getRoles(IContext context, ICatalog catalog)	Deprecated. : use getRoles or getProfiles
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)	Deprecated. use getSearchController( IConnectionDefinition connectionDefinition ) method instead.
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)	Deprecated. Use getTaskInstance( IStorageKey key ) method instead.
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.
ITaskViewTransformer	getTaskViewTransformer()	Gets a task view transformer to transform ITaskInstance objects.
ITransformer	getTransformer()	Gets a transformer to transform IResource object.
IUser	getUser(IStorageKey key)	Gets a user object from its identifier.
IUser	getUser(String id)	Deprecated. Use getUser( IStorageKey key ) method instead.
IUser	getUserByLogin(String login)	Gets a user by its login
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, 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, 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.
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. : use getWorkflow( IContext context, ICatalog catalog, String name )
IWorkflow	getWorkflow(IStorageKey key)	Gets a workflow object from its identifier.
IWorkflow	getWorkflow(ITask task)	Gets the associated workflow of a task.
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.
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.
IWorkflowInstance	getWorkflowInstance(Object object)	Gets a IWorkflowInstance object from an object.
IWorkflowInstance	getWorkflowInstance(String id)	Deprecated. Use getWorkflowInstance( IStorageKey key ) method instead.
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 taskInstance, 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)	Deprecated. use send( IContext context, IResource resource, IMailForm mailForm, Collectioninvalid input: '<'? extends IUser> mail_to, String comment )
void	send(IContext context, IResource resource, IMailForm mailForm, Collection<? extends IUser> mail_to, String comment)	Sends a mail by specifying the subject and the content of the body.
void	send(IContext context, ITaskInstance instance, IMailForm form, String comment)	Deprecated. use send( IContext context, ITaskInstance taskInstance, IMailForm mailForm, Collectioninvalid input: '<'? extends IUser> mail_to, String comment )
void	send(IContext context, ITaskInstance taskInstance, IMailForm mailForm, Collection<?> entries, String subject, String content)	Deprecated. use send( IContext context, ITaskInstance taskInstance, IMailForm mailForm, Collectioninvalid input: '<'? extends IUser> mail_to, String comment )
void	send(IContext context, ITaskInstance taskInstance, IMailForm mailForm, Collection<? extends IUser> mail_to, 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)	Deprecated. use send( IContext context, ITaskInstance taskInstance, IMailForm mailForm, Collectioninvalid input: '<'? extends IUser> mail_to, String comment )
void	send(IContext context, IWorkflowInstance workflowInstance, String formName, Collection<?> entries)	Deprecated. use send( IContext context, IResource resource, IMailForm mailForm, Collectioninvalid input: '<'? extends IUser> mail_to, String comment )
void	send(IContext context, IWorkflow workflow, IResource resource, String formName, Collection<?> entries)	Deprecated. use send( IContext context, IResource resource, IMailForm mailForm, Collectioninvalid input: '<'? extends IUser> mail_to, String comment )
void	send(IContext context, IWorkflow workflow, String formName, Collection<?> entries)	Deprecated. use send( IContext context, IResource resource, IMailForm mailForm, Collectioninvalid input: '<'? extends IUser> mail_to, String comment )
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 interface com.axemble.vdoc.sdk.modules.IModule

beginTransaction, beginTransaction, commitTransaction, commitTransaction, convertId, findNativeClass, generateSystemName, 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

Method Details

getConfiguration

IConfiguration getConfiguration()

Gets the global configuration.

Specified by:

getConfiguration in interface IBaseWorkflowModule

Returns:

a IConfiguration object.

getAgent

IAgent getAgent(IContext context,
 String name)
         throws WorkflowModuleException

Gets an agent from its name.

Specified by:

getAgent in interface IBaseWorkflowModule

Parameters:

context - The execution context.

name - The name of the agent.

Returns:

a IAgent object.

Throws:

WorkflowModuleException - default module exception.

execute

void execute(IAgent agent)
      throws WorkflowModuleException

Allows to execute an agent.

Specified by:

execute in interface IBaseWorkflowModule

Parameters:

agent - The IAgent to execute.

Throws:

WorkflowModuleException - default module exception.

execute

void execute(IContext context,
 IAgent agent)
      throws WorkflowModuleException

Allows to execute an agent.

Specified by:

execute in interface IBaseWorkflowModule

Parameters:

context - The execution context.

agent - The IAgent to execute.

Throws:

WorkflowModuleException - default module exception.

getDefaultDataSourceReference

IDataSourceReference getDefaultDataSourceReference()
                                            throws WorkflowModuleException

Gets the default data source reference.

Specified by:

getDefaultDataSourceReference in interface IBaseWorkflowModule

Returns:

a IDataSourceReference object.

Throws:

WorkflowModuleException - default module exception.

getDataSourceReference

IDataSourceReference getDataSourceReference(String name)
                                     throws WorkflowModuleException

Gets a data source reference from its JNDI name.

Specified by:

getDataSourceReference in interface IBaseWorkflowModule

Parameters:

name - The JNDI name.

Returns:

a IDataSourceReference object.

Throws:

WorkflowModuleException - default module exception.

getJdbcReference

@Deprecated
IJdbcReference getJdbcReference(IContext context,
 String name)
                         throws WorkflowModuleException

Deprecated.

: use getConnectionDefinition( IContext context, String name ) method instead.

Gets a JDBC reference from its name.

Specified by:

getJdbcReference in interface IBaseWorkflowModule

Parameters:

context - The execution context.

name - The name of the external reference.

Returns:

a IJdbcReference object.

Throws:

WorkflowModuleException - default module exception.

getJdbcReferences

@Deprecated
Collection<? extends IJdbcReference> getJdbcReferences(IContext context)
                                                throws WorkflowModuleException

Deprecated.

: use getConnectionDefinitions( IContext context ) method instead.

Gets a collection of JDBC references.

Specified by:

getJdbcReferences in interface IBaseWorkflowModule

Parameters:

context - The execution context.

Returns:

a Collection of IJdbcReference object.

Throws:

WorkflowModuleException - default module exception.

getList

IList getList(IContext context,
 ICatalog catalog,
 String name)
       throws WorkflowModuleException

Gets a list object from a catalog by its name.

Specified by:

getList in interface IBaseWorkflowModule

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

Collection<? extends IList> getLists(IContext context,
 ICatalog catalog)
                              throws WorkflowModuleException

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

Specified by:

getLists in interface IBaseWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog representing the application.

Returns:

a collection of IList object

Throws:

WorkflowModuleException - default module exception.

createCatalog

@Deprecated
ICatalog createCatalog(IContext context,
 String name,
 String label)
                throws WorkflowModuleException

Deprecated.

: use createCatalog( IContext context, String name, String label, IProject project )

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

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

ICatalog createCatalog(IContext context,
 String name,
 String label,
 IProject project)
                throws WorkflowModuleException

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

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

@Deprecated
ICatalog getCatalog(IContext context,
 String name)
             throws WorkflowModuleException

Deprecated.

: use getCatalog( IContext context, String name, IProject project )

Retrieves a catalog form its name.

Specified by:

getCatalog in interface IBaseWorkflowModule

Parameters:

context - The execution context.

name - The system name of the catalog.

Returns:

a ICatalog object.

Throws:

WorkflowModuleException - default module exception.

getCatalog

ICatalog getCatalog(IContext context,
 String name,
 IProject project)
             throws WorkflowModuleException

Retrieves a catalog form its name.

Specified by:

getCatalog in interface IBaseWorkflowModule

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

@Deprecated
ICatalog getCatalog(IContext context,
 String name,
 int catalogType)
             throws WorkflowModuleException

Deprecated.

: use getCatalog( IContext context, String name, int catalogType, IProject project )

Retrieves a catalog form its name.

Specified by:

getCatalog in interface IBaseWorkflowModule

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

ICatalog getCatalog(IContext context,
 String name,
 int catalogType,
 IProject project)
             throws WorkflowModuleException

Retrieves a catalog form its name.

Specified by:

getCatalog in interface IBaseWorkflowModule

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

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

Deprecated.

: use getCatalogs( IContext context, IProject project )

Retrieves a collection of ICatalog object.

Specified by:

getCatalogs in interface IBaseWorkflowModule

Parameters:

context - The execution context.

Returns:

a collection of ICatalog objects.

Throws:

WorkflowModuleException - default module exception.

getCatalogs

Collection<? extends ICatalog> getCatalogs(IContext context,
 IProject project)
                                    throws WorkflowModuleException

Retrieves a collection of ICatalog object.

Specified by:

getCatalogs in interface IBaseWorkflowModule

Parameters:

context - The execution context.

project - The IProject representing the project.

Returns:

a collection of ICatalog objects.

Throws:

WorkflowModuleException - default module exception.

getCatalogs

@Deprecated
Collection<? extends ICatalog> getCatalogs(IContext context,
 int catalogType)
                                    throws WorkflowModuleException

Deprecated.

: use getCatalogs( IContext context, int catalogType, IProject project )

Retrieves a collection of ICatalog object.

Specified by:

getCatalogs in interface IBaseWorkflowModule

Parameters:

context - The execution context.

catalogType - The ICatalog.IType of the catalogs.

Returns:

a collection of ICatalog objects.

Throws:

WorkflowModuleException - default module exception.

getCatalogs

Collection<? extends ICatalog> getCatalogs(IContext context,
 int catalogType,
 IProject project)
                                    throws WorkflowModuleException

Retrieves a collection of ICatalog object.

Specified by:

getCatalogs in interface IBaseWorkflowModule

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

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

Retrieves a collection of ICatalog object.

Specified by:

getAllCatalogs in interface IBaseWorkflowModule

Parameters:

context - The execution context.

Returns:

a collection of ICatalog objects.

Throws:

WorkflowModuleException - default module exception.

createRole

@Deprecated
IRole createRole(IContext context,
 ICatalog catalog,
 String name)
          throws WorkflowModuleException

Deprecated.

: use createOperatorRole or createProfile

Creates a IRole into the catalog object.

Specified by:

createRole in interface IBaseWorkflowModule

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
IRole getRole(IContext context,
 ICatalog catalog,
 String name)
       throws WorkflowModuleException

Deprecated.

: use getRole or getProfile

Retrieves a IRole object by its system name.

Specified by:

getRole in interface IBaseWorkflowModule

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
Collection<? extends IRole> getRoles(IContext context,
 ICatalog catalog)
                              throws WorkflowModuleException

Deprecated.

: use getRoles or getProfiles

Retrieves a collection of IRole objects within a specified catalog.

Specified by:

getRoles in interface IBaseWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog object.

Returns:

a collection of IRole objects.

Throws:

WorkflowModuleException - default module exception.

createOperatorRole

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

Creates a IOperatorRole into the catalog object.

Specified by:

createOperatorRole in interface IBaseWorkflowModule

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

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

Retrieves a IOperatorRole object by its system name.

Specified by:

getOperatorRole in interface IBaseWorkflowModule

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

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

Retrieves a collection of IOperatorRole objects within a specified catalog.

Specified by:

getOperatorRoles in interface IBaseWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog object.

Returns:

a collection of IOperatorRole objects.

Throws:

WorkflowModuleException - default module exception.

createProfile

IProfile createProfile(IContext context,
 IProtocolSupport link,
 String name)
                throws ModuleException

Creates a IProfile.

Specified by:

createProfile in interface IBaseWorkflowModule

Parameters:

context - The execution context.

link - The IProtocolSupport object.

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

Returns:

a IProfile object.

Throws:

ModuleException - default module exception.

getProfile

IProfile getProfile(IContext context,
 IProtocolSupport link,
 String name)
             throws ModuleException

Retrieves a IProfile object by its system name.

Specified by:

getProfile in interface IBaseWorkflowModule

Parameters:

context - The execution context.

link - The IProtocolSupport scope object.

name - The system name of the role.

Returns:

a IProfile object.

Throws:

ModuleException - default module exception.

getProfiles

Collection<? extends IProfile> getProfiles(IContext context,
 IProtocolSupport link)
                                    throws ModuleException

Retrieves a collection of IProfile objects within a specified link.

Specified by:

getProfiles in interface IBaseWorkflowModule

Parameters:

context - The execution context.

link - The IProtocolSupport object.

Returns:

a collection of IProfile objects.

Throws:

ModuleException - default module exception.

isMemberOf

boolean isMemberOf(IUser user,
 IRole role)
            throws WorkflowModuleException

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

Specified by:

isMemberOf in interface IBaseWorkflowModule

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

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

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

Specified by:

isMemberOf in interface IBaseWorkflowModule

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.

addChild

void addChild(IGroup group,
 IRole role)
       throws WorkflowModuleException

Adds a group to a role.

Specified by:

addChild in interface IBaseWorkflowModule

Parameters:

group - The group to add.

role - The role object.

Throws:

WorkflowModuleException - default module exception.

addMember

void addMember(IUser user,
 IRole role)
        throws WorkflowModuleException

Adds a user to a role.

Specified by:

addMember in interface IBaseWorkflowModule

Parameters:

user - The user to add.

role - The role object.

Throws:

WorkflowModuleException - default module exception.

createWorkflowContainer

IWorkflowContainer createWorkflowContainer(IContext context,
 ICatalog catalog,
 String name)
                                    throws WorkflowModuleException

Creates a workflow container within a ICatalog object.

Specified by:

createWorkflowContainer in interface IBaseWorkflowModule

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

IWorkflowContainer getWorkflowContainer(IContext context,
 ICatalog catalog,
 String name)
                                 throws WorkflowModuleException

Retrieves a IWorkflowContainer within a ICatalog by its system name

Specified by:

getWorkflowContainer in interface IBaseWorkflowModule

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

Collection<? extends IWorkflowContainer> getWorkflowContainers(IContext context,
 ICatalog catalog)
                                                        throws WorkflowModuleException

Retrieves a collection of IWorkflowContainer objects within a ICatalog object.

Specified by:

getWorkflowContainers in interface IBaseWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog object.

Returns:

a collection of IWorkflowContainer objects.

Throws:

WorkflowModuleException - default module exception.

createWorkflow

IWorkflow createWorkflow(IContext context,
 IWorkflowContainer container,
 String name,
 byte[] content)
                  throws WorkflowModuleException

Creates a workflow within a workflow container.

Specified by:

createWorkflow in interface IBaseWorkflowModule

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

IWorkflow getWorkflow(IContext context,
 ICatalog catalog,
 String name)
               throws WorkflowModuleException

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

Specified by:

getWorkflow in interface IBaseWorkflowModule

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

Collection<? extends IWorkflow> getWorkflows(IContext context,
 ICatalog catalog)
                                      throws WorkflowModuleException

Retrieves a collection of IWorkflow objects within a ICatalog object.

Specified by:

getWorkflows in interface IBaseWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog object.

Returns:

a collection of IWorkflow objects.

Throws:

WorkflowModuleException - default module exception.

getWorkflows

Collection<? extends IWorkflow> getWorkflows(IContext context,
 IWorkflowContainer container)
                                      throws WorkflowModuleException

Retrieves a collection of IWorkflow objects within a IWorkflowContainer object.

Specified by:

getWorkflows in interface IBaseWorkflowModule

Parameters:

context - The execution context.

container - The IWorkflowContainer object.

Returns:

a collection of IWorkflow objects.

Throws:

WorkflowModuleException - default module exception.

getWorkflow

@Deprecated
IWorkflow getWorkflow(IContext context,
 String name)
               throws WorkflowModuleException

Deprecated.

: use getWorkflow( IContext context, ICatalog catalog, String name )

Retrieves a workflow form its system name.

Specified by:

getWorkflow in interface IBaseWorkflowModule

Parameters:

context - The execution context.

name - The system name of the workflow to retrieve.

Returns:

a IWorkflow object.

Throws:

WorkflowModuleException - default module exception.

getCatalog

ICatalog getCatalog(IWorkflow workflow)
             throws WorkflowModuleException

Retrieves the catalog of a IWorkflow object.

Specified by:

getCatalog in interface IBaseWorkflowModule

Parameters:

workflow - The workflow object.

Returns:

a ICatalog object

Throws:

WorkflowModuleException - default module exception.

getWorkflowContainer

IWorkflowContainer getWorkflowContainer(IWorkflow workflow)
                                 throws WorkflowModuleException

Retrieves the workflow container of a IWorkflow object.

Specified by:

getWorkflowContainer in interface IBaseWorkflowModule

Parameters:

workflow - The workflow object.

Returns:

a IWorkflowContainer object

Throws:

WorkflowModuleException - default module exception.

getTask

ITask getTask(IContext context,
 IWorkflow workflow,
 String name)
       throws WorkflowModuleException

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

Specified by:

getTask in interface IBaseWorkflowModule

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

Collection<? extends IAction> getActions(IContext context,
 ITask task)
                                  throws WorkflowModuleException

Retrieves a collection of IAction objects within a ITask.

Specified by:

getActions in interface IBaseWorkflowModule

Parameters:

context - The execution context.

task - The ITask object.

Returns:

a collection of IAction objects.

Throws:

WorkflowModuleException - default module exception.

getAction

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

Retrieve a specific IAction object from its system name.

Specified by:

getAction in interface IBaseWorkflowModule

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.

getWorkflow

IWorkflow getWorkflow(ITask task)
               throws WorkflowModuleException

Gets the associated workflow of a task.

Specified by:

getWorkflow in interface IBaseWorkflowModule

Parameters:

task - the ITask object.

Returns:

a IWorkflow object.

Throws:

WorkflowModuleException - default module exception.

getResourceDefinition

IResourceDefinition getResourceDefinition(IContext context,
 ICatalog catalog,
 String name)
                                   throws WorkflowModuleException

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

Specified by:

getResourceDefinition in interface IBaseWorkflowModule

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

Collection<? extends IResourceDefinition> getResourceDefinitions(IContext context,
 ICatalog catalog)
                                                          throws WorkflowModuleException

Retrieves all resource definitions by specifying the ICatalog

Specified by:

getResourceDefinitions in interface IBaseWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog object.

Returns:

a collection of IResourceDefinition objects.

Throws:

WorkflowModuleException - default module exception.

getView

IView getView(IContext context,
 ICatalog catalog,
 String viewName)
       throws WorkflowModuleException

Retrieves a view by its name.

Specified by:

getView in interface IBaseWorkflowModule

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

Collection<? extends IView> getViews(IContext context,
 ICatalog catalog)
                              throws WorkflowModuleException

Retrieves all the views associated with the catalog.

Specified by:

getViews in interface IBaseWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog object.

Returns:

a IView object.

Throws:

WorkflowModuleException - default module exception.

getView

IView getView(IContext context,
 IWorkflowContainer workflowContainer,
 String viewName)
       throws WorkflowModuleException

Retrieves a view by its name.

Specified by:

getView in interface IBaseWorkflowModule

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

Collection<? extends IView> getViews(IContext context,
 IWorkflowContainer workflowContainer)
                              throws WorkflowModuleException

Retrieves all the views associated with the workflow container.

Specified by:

getViews in interface IBaseWorkflowModule

Parameters:

context - The execution context.

workflowContainer - The IWorkflowContainer object.

Returns:

a IView object.

Throws:

WorkflowModuleException - default module exception.

getView

IView getView(IContext context,
 IResourceDefinition resourceDefinition,
 String viewName)
       throws WorkflowModuleException

Retrieves a view by its name.

Specified by:

getView in interface IBaseWorkflowModule

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

Collection<? extends IView> getViews(IContext context,
 IResourceDefinition resourceDefinition)
                              throws WorkflowModuleException

Retrieves all the views associated with the resource definition.

Specified by:

getViews in interface IBaseWorkflowModule

Parameters:

context - The execution context.

resourceDefinition - The IResourceDefinition object.

Returns:

a IView object.

Throws:

WorkflowModuleException - default module exception.

getProperties

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

Gets all the properties of a specified definition.

Specified by:

getProperties in interface IBaseWorkflowModule

Parameters:

context - The execution context.

resourceDefinition - a IResourceDefinition object.

Returns:

a collection of IProperty objects.

Throws:

WorkflowModuleException - default module exception.

getProperty

IProperty getProperty(IContext context,
 IResourceDefinition resourceDefinition,
 String name)
               throws WorkflowModuleException

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

Specified by:

getProperty in interface IBaseWorkflowModule

Parameters:

context - The execution context.

resourceDefinition - The IResourceDefinition object.

name - The system name of the property.

Returns:

a IProperty object.

Throws:

WorkflowModuleException - default module exception.

generateReference

String generateReference(IResourceDefinition resourceDefinition)
                  throws WorkflowModuleException

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

Specified by:

generateReference in interface IBaseWorkflowModule

Parameters:

resourceDefinition - The resource definition object.

Returns:

The evaluated reference.

Throws:

WorkflowModuleException - default module exception.

generateReference

@Deprecated
String generateReference(IResourceDefinition resourceDefinition,
 String format)
                  throws WorkflowModuleException

Deprecated.

: should not use this method anymore. The format argument is not supported.

Evaluate the next reference based on the passed format.

Specified by:

generateReference in interface IBaseWorkflowModule

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

String generateReference(IResource resource)
                  throws WorkflowModuleException

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

Specified by:

generateReference in interface IBaseWorkflowModule

Parameters:

resource - The resource to be created.

Returns:

The evaluated reference.

Throws:

WorkflowModuleException - default module exception.

generateReference

String generateReference(IResource resource,
 Document format)
                  throws WorkflowModuleException

Evaluate the next reference based specified format.

Specified by:

generateReference in interface IBaseWorkflowModule

Parameters:

resource - The resource to be created.

format - An XML format definition.

Returns:

The evaluated reference.

Throws:

WorkflowModuleException - default module exception.

generateReference

@Deprecated
String generateReference(IResource resource,
 String format)
                  throws WorkflowModuleException

Deprecated.

: should not use this method anymore. The format argument is not supported.

Evaluate the next reference based on the specified format.

Specified by:

generateReference in interface IBaseWorkflowModule

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

@Deprecated
int generateChrono(IResourceDefinition resourceDefinition)
            throws WorkflowModuleException

Deprecated.

: should not use this method anymore.

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

Specified by:

generateChrono in interface IBaseWorkflowModule

Parameters:

resourceDefinition - The resource definition object

Returns:

The evaluated chrono.

Throws:

WorkflowModuleException - default module exception.

createWorkflowInstance

IWorkflowInstance createWorkflowInstance(IContext context,
 IWorkflow workflow,
 String reference,
 String label)
                                  throws WorkflowModuleException

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

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

IWorkflowInstance createWorkflowInstance(IContext context,
 IWorkflow workflow,
 String reference)
                                  throws WorkflowModuleException

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

Parameters:

context - The execution context.

workflow - The IWorkflow object.

reference - The reference to set.

Returns:

a IWorkflowInstance object.

Throws:

WorkflowModuleException - default module exception.

getWorkflowInstances

Collection<? extends IWorkflowInstance> getWorkflowInstances(IContext context,
 ICatalog catalog,
 String reference)
                                                      throws WorkflowModuleException

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

Specified by:

getWorkflowInstances in interface IBaseWorkflowModule

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

Collection<? extends IWorkflowInstance> getWorkflowInstances(IContext context,
 IWorkflow workflow,
 String reference)
                                                      throws WorkflowModuleException

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

Specified by:

getWorkflowInstances in interface IBaseWorkflowModule

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

Collection<? extends IWorkflowInstance> getWorkflowInstances(IContext context,
 ICatalog catalog)
                                                      throws WorkflowModuleException

Gets all the workflow instances of a specified ICatalog object.

Specified by:

getWorkflowInstances in interface IBaseWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog object.

Returns:

a collection of IWorkflowInstance objects.

Throws:

WorkflowModuleException - default module exception.

getWorkflowInstances

Collection<? extends IWorkflowInstance> getWorkflowInstances(IContext context,
 IWorkflow workflow)
                                                      throws WorkflowModuleException

Gets all the workflow instances of a specified IWorkflow object.

Specified by:

getWorkflowInstances in interface IBaseWorkflowModule

Parameters:

context - The execution context.

workflow - The IWorkflow object.

Returns:

a collection of IWorkflowInstance objects.

Throws:

WorkflowModuleException - default module exception.

getWorkflowInstances

Collection<? extends IWorkflowInstance> getWorkflowInstances(IContext context,
 ITask task)
                                                      throws WorkflowModuleException

Gets all the workflow instances of a specified ITask object.

Specified by:

getWorkflowInstances in interface IBaseWorkflowModule

Parameters:

context - The execution context.

task - The ITask object.

Returns:

a collection of IWorkflowInstance objects.

Throws:

WorkflowModuleException - default module exception.

getParentInstance

IWorkflowInstance getParentInstance(IWorkflowInstance instance)
                             throws WorkflowModuleException

Gets the parent instance of a specified IWorkflowInstanceobject.

Specified by:

getParentInstance in interface IBaseWorkflowModule

Parameters:

instance - the IWorkflowInstance object.

Returns:

a IWorkflowInstance object.

Throws:

WorkflowModuleException - default module exception.

setValue

void setValue(IResource resource,
 String propertyName,
 Object value)
       throws WorkflowModuleException

Sets a value to a property.

Specified by:

setValue in interface IBaseWorkflowModule

Parameters:

resource - The IWorkflowInstance object.

propertyName - The system name of the property.

value - The value object to set.

Throws:

WorkflowModuleException - default module exception.

getValue

Object getValue(IResource resource,
 String propertyName)
         throws WorkflowModuleException

Gets the value of a property.

Specified by:

getValue in interface IBaseWorkflowModule

Parameters:

resource - The IWorkflowInstance object.

propertyName - The system name of the property.

Returns:

a Object object.

Throws:

WorkflowModuleException - default module exception.

setList

void setList(IResource resource,
 String propertyName,
 Collection<? extends IOptionList.IOption> values)
      throws WorkflowModuleException

Sets the list of available values to a list property.

Specified by:

setList in interface IBaseWorkflowModule

Parameters:

resource - The IWorkflowInstance object.

propertyName - The system name of the property.

values - a collection of IOptionList.IOption.

Throws:

WorkflowModuleException - default module exception.

getList

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

Gets the available values of a list property.

Specified by:

getList in interface IBaseWorkflowModule

Parameters:

resource - The IWorkflowInstance object.

propertyName - The system name of the property.

Returns:

a collection of IOptionList.IOption.

Throws:

WorkflowModuleException - default module exception.

createListOption

IOptionList.IOption createListOption(Object key,
 String text)

Specified by:

createListOption in interface IBaseWorkflowModule

Parameters:

key - the key of the option.

text - the text of the option.

Returns:

a new IOptionList.IOption

abort

void abort(IContext context,
 IWorkflowInstance instance,
 String comment)
    throws WorkflowModuleException

Allows to abort workflow instance.

Specified by:

abort in interface IBaseWorkflowModule

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

void remind(IContext context,
 IWorkflowInstance instance,
 String comment)
     throws WorkflowModuleException

Allows to remind current operators of a workflow instance.

Specified by:

remind in interface IBaseWorkflowModule

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

void remind(IContext context,
 ITaskInstance taskInstance,
 String comment)
     throws WorkflowModuleException

Allows to remind current operators of a specified task instance.

Specified by:

remind in interface IBaseWorkflowModule

Parameters:

context - The execution context.

taskInstance - The ITaskInstance object.

comment - The reason of the reminder. This comment will appear in the history entries.

Throws:

WorkflowModuleException - default module exception.

send

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

Deprecated.

use send( IContext context, IResource resource, IMailForm mailForm, Collectioninvalid input: '<'? extends IUser> mail_to, String comment )

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

Specified by:

send in interface IBaseWorkflowModule

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.

send

@Deprecated
void send(IContext context,
 IWorkflow workflow,
 IResource resource,
 String formName,
 Collection<?> entries)
   throws WorkflowModuleException

Deprecated.

use send( IContext context, IResource resource, IMailForm mailForm, Collectioninvalid input: '<'? extends IUser> mail_to, String comment )

Allows to send a mail.

Specified by:

send in interface IBaseWorkflowModule

Parameters:

context - The execution context.

workflow - The IWorkflow object.

resource - The IResource object created from 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

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

Deprecated.

use send( IContext context, IResource resource, IMailForm mailForm, Collectioninvalid input: '<'? extends IUser> mail_to, String comment )

Allows to send a mail.

Specified by:

send in interface IBaseWorkflowModule

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.

getTaskInstances

Collection<? extends ITaskInstance> getTaskInstances(IContext context,
 IWorkflowInstance instance)
                                              throws WorkflowModuleException

Retrieves all the task instances of a specified workflow instance.

Specified by:

getTaskInstances in interface IBaseWorkflowModule

Parameters:

context - The execution context.

instance - The IWorkflowInstance object.

Returns:

a collection of ITaskInstance

Throws:

WorkflowModuleException - default module exception.

getTaskInstances

Collection<? extends ITaskInstance> getTaskInstances(IContext context,
 IWorkflowInstance instance,
 String name)
                                              throws WorkflowModuleException

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

Specified by:

getTaskInstances in interface IBaseWorkflowModule

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.

getManualTaskInstances

Collection<? extends ITaskInstance> getManualTaskInstances(IContext context,
 IWorkflowInstance instance)
                                                    throws WorkflowModuleException

Retrieves all the manual task instances of a workflow instance.

Specified by:

getManualTaskInstances in interface IBaseWorkflowModule

Parameters:

context - The execution context.

instance - The IWorkflowInstance object.

Returns:

a collection of ITaskInstance

Throws:

WorkflowModuleException - default module exception.

getManualTaskInstancesByStatus

Collection<? extends ITaskInstance> getManualTaskInstancesByStatus(IContext context,
 int status)
                                                            throws WorkflowModuleException

Retrieves all the manual task instances for a status.

Specified by:

getManualTaskInstancesByStatus in interface IBaseWorkflowModule

Parameters:

context - The execution context.

status - The IWorkflowInstance.IStatus status.

Returns:

a collection of ITaskInstance

Throws:

WorkflowModuleException - default module exception.

getManualTaskInstancesModifiedSince

Collection<? extends ITaskInstance> getManualTaskInstancesModifiedSince(IContext context,
 Date date)
                                                                 throws WorkflowModuleException

Retrieves all the manual task instances modified since.

Specified by:

getManualTaskInstancesModifiedSince in interface IBaseWorkflowModule

Parameters:

context - The execution context.

date - The date.

Returns:

a collection of ITaskInstance

Throws:

WorkflowModuleException - default module exception.

getStartedTaskInstances

Collection<? extends ITaskInstance> getStartedTaskInstances(IContext context,
 IWorkflowInstance instance)
                                                     throws WorkflowModuleException

Retrieves all the started task instances of a workflow instance.

Specified by:

getStartedTaskInstances in interface IBaseWorkflowModule

Parameters:

context - The execution context.

instance - The IWorkflowInstance object.

Returns:

a collection of ITaskInstance

Throws:

WorkflowModuleException - default module exception.

getEndedTaskInstances

Collection<? extends ITaskInstance> getEndedTaskInstances(IContext context,
 IWorkflowInstance instance)
                                                   throws WorkflowModuleException

Retrieves all the ended task instances of a workflow instance.

Specified by:

getEndedTaskInstances in interface IBaseWorkflowModule

Parameters:

context - The execution context.

instance - The IWorkflowInstance object.

Returns:

a collection of ITaskInstance

Throws:

WorkflowModuleException - default module exception.

getAbortedTaskInstances

Collection<? extends ITaskInstance> getAbortedTaskInstances(IContext context,
 IWorkflowInstance instance)
                                                     throws WorkflowModuleException

Retrieves all the aborted task instances of a workflow instance.

Specified by:

getAbortedTaskInstances in interface IBaseWorkflowModule

Parameters:

context - The execution context.

instance - The IWorkflowInstance object.

Returns:

a collection of ITaskInstance

Throws:

WorkflowModuleException - default module exception.

getTaskInstance

ITaskInstance getTaskInstance(IContext context,
 IWorkflowInstance instance,
 String name)
                       throws WorkflowModuleException

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

Specified by:

getTaskInstance in interface IBaseWorkflowModule

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.

getOneTaskInstance

ITaskInstance getOneTaskInstance(IContext context,
 IWorkflowInstance instance)
                          throws WorkflowModuleException

Gets one of the task instances (any).

Specified by:

getOneTaskInstance in interface IBaseWorkflowModule

Parameters:

context - The execution context.

instance - The IWorkflowInstance object.

Returns:

a ITaskInstance object.

Throws:

WorkflowModuleException - default module exception.

getTask

ITask getTask(ITaskInstance instance)
       throws WorkflowModuleException

Gets the definition of a task instance.

Specified by:

getTask in interface IBaseWorkflowModule

Parameters:

instance - The ITaskInstance object.

Returns:

a ITask object.

Throws:

WorkflowModuleException - default module exception.

getOperators

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

Retrieves the operators of a task instance.

Specified by:

getOperators in interface IBaseWorkflowModule

Parameters:

instance - the ITaskInstance object.

Returns:

a collection of IOperator objects.

Throws:

WorkflowModuleException - default module exception.

end

void end(IContext context,
 ITaskInstance instance,
 IAction action,
 String comment)
  throws WorkflowModuleException

Crosses a transition.

Specified by:

end in interface IBaseWorkflowModule

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

void end(IContext context,
 IUser addressee,
 ITaskInstance instance,
 IAction action,
 String comment)
  throws WorkflowModuleException

Allows to cross a transition for another user.

Specified by:

end in interface IBaseWorkflowModule

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

@Deprecated
void send(IContext context,
 ITaskInstance instance,
 IMailForm form,
 String comment)
   throws WorkflowModuleException

Deprecated.

use send( IContext context, ITaskInstance taskInstance, IMailForm mailForm, Collectioninvalid input: '<'? extends IUser> mail_to, String comment )

Sends a mail using a specified mail form.

Specified by:

send in interface IBaseWorkflowModule

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

@Deprecated
void send(IContext context,
 IUser addressee,
 ITaskInstance instance,
 IMailForm form,
 String comment)
   throws WorkflowModuleException

Deprecated.

use send( IContext context, ITaskInstance taskInstance, IMailForm mailForm, Collectioninvalid input: '<'? extends IUser> mail_to, String comment )

Sends a mail using a specified mail form.

Specified by:

send in interface IBaseWorkflowModule

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.

evaluatedHtml

@Deprecated
String evaluatedHtml(IResource resource,
 IMailForm mailForm)
              throws WorkflowModuleException

Deprecated.

: use buildMailMessage( IResource resource, IMailForm mailForm, String language )

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

Specified by:

evaluatedHtml in interface IBaseWorkflowModule

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

String buildMailMessage(IResource resource,
 IMailForm mailForm,
 String language)
                 throws WorkflowModuleException

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

Specified by:

buildMailMessage in interface IBaseWorkflowModule

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

@Deprecated
String evaluatedHtml(ITaskInstance taskInstance,
 IMailForm mailForm)
              throws WorkflowModuleException

Deprecated.

: use buildMailMessage( ITaskInstance taskInstance, IMailForm mailForm, String language )

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

Specified by:

evaluatedHtml in interface IBaseWorkflowModule

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

String buildMailMessage(ITaskInstance taskInstance,
 IMailForm mailForm,
 String language)
                 throws WorkflowModuleException

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

Specified by:

buildMailMessage in interface IBaseWorkflowModule

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.

send

@Deprecated
void send(IContext context,
 IResource resource,
 IMailForm mailForm,
 Collection<?> entries,
 String subject,
 String content)
   throws WorkflowModuleException

Deprecated.

use send( IContext context, IResource resource, IMailForm mailForm, Collectioninvalid input: '<'? extends IUser> mail_to, String comment )

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

Specified by:

send in interface IBaseWorkflowModule

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

@Deprecated
void send(IContext context,
 ITaskInstance taskInstance,
 IMailForm mailForm,
 Collection<?> entries,
 String subject,
 String content)
   throws WorkflowModuleException

Deprecated.

use send( IContext context, ITaskInstance taskInstance, IMailForm mailForm, Collectioninvalid input: '<'? extends IUser> mail_to, String comment )

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

Specified by:

send in interface IBaseWorkflowModule

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

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

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

Specified by:

send in interface IBaseWorkflowModule

Parameters:

context - The execution context.

taskInstance - The ITaskInstance object to evaluate with.

mailForm - The IMailForm object.

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

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

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

Specified by:

send in interface IBaseWorkflowModule

Parameters:

context - The execution context.

resource - The IResource object to evaluate with.

mailForm - The IMailForm object.

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

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

Throws:

WorkflowModuleException

getForm

IForm getForm(IContext context,
 IWorkflow workflow,
 String formName)
       throws WorkflowModuleException

Gets a workflow form by its name.

Specified by:

getForm in interface IBaseWorkflowModule

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

IForm getForm(IContext context,
 IResourceDefinition resourceDefinition,
 String formName)
       throws WorkflowModuleException

Gets a resource definition form by its name.

Specified by:

getForm in interface IBaseWorkflowModule

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

IForm getForm(IContext context,
 ITask task,
 String formName)
       throws WorkflowModuleException

Gets a task form by its name.

Specified by:

getForm in interface IBaseWorkflowModule

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

IForm getForm(IContext context,
 IAction action,
 String formName)
       throws WorkflowModuleException

Gets a action form by its name.

Specified by:

getForm in interface IBaseWorkflowModule

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

IForm getSubForm(IContext context,
 IWorkflow workflow,
 String formName)
          throws WorkflowModuleException

Gets a sub form by its name.

Specified by:

getSubForm in interface IBaseWorkflowModule

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.

getMailForms

Collection<? extends IMailForm> getMailForms(IContext context,
 IWorkflow workflow)
                                      throws WorkflowModuleException

Gets all the mail forms from a specified IWorkflow object.

Specified by:

getMailForms in interface IBaseWorkflowModule

Parameters:

context - The execution context.

workflow - The IWorkflow object.

Returns:

A collection of IMailForm objects.

Throws:

WorkflowModuleException - default module exception. default module exception.

getMailForm

IMailForm getMailForm(IContext context,
 IWorkflow workflow,
 String mailFormName)
               throws WorkflowModuleException

Specified by:

getMailForm in interface IBaseWorkflowModule

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.

getMailForms

Collection<? extends IMailForm> getMailForms(IContext context,
 IWorkflow workflow,
 String startsWith)
                                      throws WorkflowModuleException

Specified by:

getMailForms in interface IBaseWorkflowModule

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.

createGenericResource

IResource createGenericResource()
                         throws WorkflowModuleException

Creates a generic resource for mail purposes.

Specified by:

createGenericResource in interface IBaseWorkflowModule

Returns:

The IResource object.

Throws:

WorkflowModuleException - default module exception.

createLinkedResource

ILinkedResource createLinkedResource(IResource resource,
 String propertyName)
                              throws WorkflowModuleException

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

Parameters:

resource - The parent resource.

propertyName - The system name of the property.

Returns:

The ILinkedResource object.

Throws:

WorkflowModuleException - default module exception.

getLinkedResources

Collection<? extends ILinkedResource> getLinkedResources(IResource resource,
 String propertyName)
                                                  throws WorkflowModuleException

Gets all the linked resources associated with a table property.

Specified by:

getLinkedResources in interface IBaseWorkflowModule

Parameters:

resource - The parent resource.

propertyName - The system name of the property.

Returns:

A collection of ILinkedResource objects.

Throws:

WorkflowModuleException - default module exception.

getParentInstance

IWorkflowInstance getParentInstance(ILinkedResource linkedResource)
                             throws WorkflowModuleException

Gets the parent instance of a linked resource.

Specified by:

getParentInstance in interface IBaseWorkflowModule

Parameters:

linkedResource - The linked resource.

Returns:

The IWorkflowInstance object.

Throws:

WorkflowModuleException - default module exception.

getAttachments

Collection<? extends IAttachment> getAttachments(IResource resource,
 String propertyName)
                                          throws WorkflowModuleException

Gets all the attachments associated with a property.

Specified by:

getAttachments in interface IBaseWorkflowModule

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

IAttachment getAttachment(IResource resource,
 String propertyName,
 String fileName)
                   throws WorkflowModuleException

Gets an attachment by its file name.

Specified by:

getAttachment in interface IBaseWorkflowModule

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

IAttachment addAttachment(IResource resource,
 String propertyName,
 File file)
                   throws WorkflowModuleException

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

Specified by:

addAttachment in interface IBaseWorkflowModule

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

IAttachment addAttachment(IResource resource,
 String propertyName,
 String fileName,
 InputStream inputStream)
                   throws WorkflowModuleException

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

Specified by:

addAttachment in interface IBaseWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

fileName - The name of the file

inputStream - The InputStream object.

Returns:

An IAttachment object.

Throws:

WorkflowModuleException - default module exception.

addAttachment

IAttachment addAttachment(IResource resource,
 String propertyName,
 String fileName,
 String fullPath)
                   throws WorkflowModuleException

Adds an attachment with its full path.

Specified by:

addAttachment in interface IBaseWorkflowModule

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

IAttachment addAttachment(IResource resource,
 String propertyName,
 IAttachment attachment)
                   throws WorkflowModuleException

Adds an attachment from an attachment.

Specified by:

addAttachment in interface IBaseWorkflowModule

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.

getExternalUser

IUser getExternalUser(IResource resource,
 String propertyName)
               throws WorkflowModuleException

Gets a IUser object from a single user selector property.

Specified by:

getExternalUser in interface IBaseWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

Returns:

A IUser object.

Throws:

WorkflowModuleException - default module exception.

getExternalGroup

IGroup getExternalGroup(IResource resource,
 String propertyName)
                 throws WorkflowModuleException

Gets a IGroup object from a single group selector property.

Specified by:

getExternalGroup in interface IBaseWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

Returns:

A IGroup object.

Throws:

WorkflowModuleException - default module exception.

getExternalLocalization

ILocalization getExternalLocalization(IResource resource,
 String propertyName)
                               throws WorkflowModuleException

Gets a ILocalization object from a single localization selector property.

Specified by:

getExternalLocalization in interface IBaseWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

Returns:

A ILocalization object.

Throws:

WorkflowModuleException - default module exception.

getExternalOrganization

IOrganization getExternalOrganization(IResource resource,
 String propertyName)
                               throws WorkflowModuleException

Gets a IOrganization object from a single organization selector property.

Specified by:

getExternalOrganization in interface IBaseWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

Returns:

A IOrganization object.

Throws:

WorkflowModuleException - default module exception.

getExternalFile

IFile getExternalFile(IResource resource,
 String propertyName)
               throws WorkflowModuleException

Gets a IFile object from a single file selector property.

Specified by:

getExternalFile in interface IBaseWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

Returns:

A IFile object.

Throws:

WorkflowModuleException - default module exception.

getExternalFolder

IFolder getExternalFolder(IResource resource,
 String propertyName)
                   throws WorkflowModuleException

Gets a IFolder object from a single folder selector property.

Specified by:

getExternalFolder in interface IBaseWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

Returns:

A IFolder object.

Throws:

WorkflowModuleException - default module exception.

getExternalLibrary

ILibrary getExternalLibrary(IResource resource,
 String propertyName)
                     throws WorkflowModuleException

Gets a ILibrary object from a single library selector property.

Specified by:

getExternalLibrary in interface IBaseWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

Returns:

A ILibrary object.

Throws:

WorkflowModuleException - default module exception.

getExternalElements

Collection<?> getExternalElements(IResource resource,
 String propertyName)
                           throws WorkflowModuleException

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

Specified by:

getExternalElements in interface IBaseWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

Returns:

A collection of IElement objects.

Throws:

WorkflowModuleException - default module exception.

setExternalUser

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

Sets a IUser to a single selector property.

Specified by:

setExternalUser in interface IBaseWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

user - A IUser object.

Throws:

WorkflowModuleException - default module exception.

setExternalGroup

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

Sets a IGroup to a single selector property.

Specified by:

setExternalGroup in interface IBaseWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

group - A IGroup object.

Throws:

WorkflowModuleException - default module exception.

setExternalLocalization

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

Sets a ILocalization to a single selector property.

Specified by:

setExternalLocalization in interface IBaseWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

localization - A ILocalization object.

Throws:

WorkflowModuleException - default module exception.

setExternalOrganization

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

Sets a IOrganization to a single selector property.

Specified by:

setExternalOrganization in interface IBaseWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

organization - A IOrganization object.

Throws:

WorkflowModuleException - default module exception.

setExternalFile

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

Sets a IFile to a single selector property.

Specified by:

setExternalFile in interface IBaseWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

file - A IFile object.

Throws:

WorkflowModuleException - default module exception.

setExternalFolder

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

Sets a IFolder to a single selector property.

Specified by:

setExternalFolder in interface IBaseWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

folder - A IFolder object.

Throws:

WorkflowModuleException - default module exception.

setExternalLibrary

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

Sets a ILibrary to a single selector property.

Specified by:

setExternalLibrary in interface IBaseWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

library - A ILibrary object.

Throws:

WorkflowModuleException - default module exception.

setExternalElements

void setExternalElements(IResource resource,
 String propertyName,
 Collection<?> elements)
                  throws WorkflowModuleException

Sets a IElement to a multiple selector property.

Specified by:

setExternalElements in interface IBaseWorkflowModule

Parameters:

resource - The main resource object.

propertyName - The system name of the property.

elements - A collection of IElement objects.

Throws:

WorkflowModuleException - default module exception.

getSearchController

ISearchController getSearchController()
                               throws WorkflowModuleException

Gets the default ISearchController object.

Specified by:

getSearchController in interface IBaseWorkflowModule

Returns:

The default ISearchController object.

Throws:

WorkflowModuleException - default module exception.

getSearchController

@Deprecated
ISearchController getSearchController(IJdbcReference reference)
                               throws WorkflowModuleException

Deprecated.

use getSearchController( IConnectionDefinition connectionDefinition ) method instead.

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

Specified by:

getSearchController in interface IBaseWorkflowModule

Parameters:

reference - The IJdbcReference object.

Returns:

The ISearchController object.

Throws:

WorkflowModuleException - default module exception.

getSearchController

ISearchController getSearchController(IConnectionDefinition connectionDefinition)
                               throws WorkflowModuleException

Gets a search controller object by specifying a ConnectionDefinition object.

Specified by:

getSearchController in interface IBaseWorkflowModule

Parameters:

connectionDefinition - The IConnectionDefinition object.

Returns:

The ISearchController object.

Throws:

WorkflowModuleException - default module exception.

getSearchController

ISearchController getSearchController(IDataSourceReference reference)
                               throws WorkflowModuleException

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

Specified by:

getSearchController in interface IBaseWorkflowModule

Parameters:

reference - The IDataSourceReference object.

Returns:

The ISearchController object.

Throws:

WorkflowModuleException - default module exception.

getSecurityController

ISecurityController getSecurityController(ISecuritySupport securitySupport)
                                   throws WorkflowModuleException

Gets a security controller on a specified object.

Specified by:

getSecurityController in interface IBaseWorkflowModule

Parameters:

securitySupport - Any IElement that implements ISecuritySupport interface.

Returns:

The ISecurityController object.

Throws:

WorkflowModuleException - default module exception.

getTransformer

ITransformer getTransformer()
                     throws WorkflowModuleException

Gets a transformer to transform IResource object.

Specified by:

getTransformer in interface IBaseWorkflowModule

Returns:

A ITransformer object.

Throws:

WorkflowModuleException - default module exception.

getTaskInstanceTransformer

ITaskInstanceTransformer getTaskInstanceTransformer()
                                             throws WorkflowModuleException

Gets a task transformer to transform ITaskInstance object.

Specified by:

getTaskInstanceTransformer in interface IBaseWorkflowModule

Returns:

A ITaskInstanceTransformer object.

Throws:

WorkflowModuleException - default module exception.

getTaskViewTransformer

ITaskViewTransformer getTaskViewTransformer()
                                     throws WorkflowModuleException

Gets a task view transformer to transform ITaskInstance objects.

Specified by:

getTaskViewTransformer in interface IBaseWorkflowModule

Returns:

A ITaskViewTransformer object.

Throws:

WorkflowModuleException - default module exception.

getResourceViewTransformer

IResourceViewTransformer getResourceViewTransformer()
                                             throws WorkflowModuleException

Gets a resource view transformer to transform IResource objects.

Specified by:

getResourceViewTransformer in interface IBaseWorkflowModule

Returns:

A IResourceViewTransformer object.

Throws:

WorkflowModuleException - default module exception.

getWorkflowViewTransformer

IWorkflowViewTransformer getWorkflowViewTransformer()
                                             throws WorkflowModuleException

Gets a workflow view transformer to transform IWorkflow objects.

Specified by:

getWorkflowViewTransformer in interface IBaseWorkflowModule

Returns:

A IWorkflowViewTransformer object.

Throws:

WorkflowModuleException - default module exception.

getWorkflowContainerViewTransformer

IWorkflowContainerViewTransformer getWorkflowContainerViewTransformer()
                                                               throws WorkflowModuleException

Gets a workflow container view transformer to transform IWorkflowContainer objects.

Specified by:

getWorkflowContainerViewTransformer in interface IBaseWorkflowModule

Returns:

A IWorkflowContainerViewTransformer object.

Throws:

WorkflowModuleException - default module exception.

getCatalogViewTransformer

ICatalogViewTransformer getCatalogViewTransformer()
                                           throws WorkflowModuleException

Gets a catalog view transformer to transform ICatalog objects.

Specified by:

getCatalogViewTransformer in interface IBaseWorkflowModule

Returns:

A ICatalogViewTransformer object.

Throws:

WorkflowModuleException - default module exception.

getSearchViewTransformer

ISearchViewTransformer getSearchViewTransformer()
                                         throws WorkflowModuleException

Gets a search view transformer to transform IResource objects.

Specified by:

getSearchViewTransformer in interface IBaseWorkflowModule

Returns:

A ISearchViewTransformer object.

Throws:

WorkflowModuleException - default module exception.

getGenericViewTransformer

IGenericViewTransformer getGenericViewTransformer()
                                           throws WorkflowModuleException

Specified by:

getGenericViewTransformer in interface IBaseWorkflowModule

Throws:

WorkflowModuleException

getViewController

@Deprecated
IViewController getViewController()
                           throws WorkflowModuleException

Deprecated.

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

Specified by:

getViewController in interface IBaseWorkflowModule

Returns:

A IViewController object.

Throws:

WorkflowModuleException - default module exception.

getViewController

IViewController getViewController(IContext context)
                           throws WorkflowModuleException

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

Specified by:

getViewController in interface IBaseWorkflowModule

Parameters:

context - The execution context.

Returns:

A IViewController object.

Throws:

WorkflowModuleException - default module exception.

getViewController

@Deprecated
IViewController getViewController(Class natureClass)
                           throws WorkflowModuleException

Deprecated.

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

Specified by:

getViewController in interface IBaseWorkflowModule

Parameters:

natureClass - : The class of the searched objects IWorkflowInstance, ITaskInstance, IResource}

Returns:

A IViewController object.

Throws:

WorkflowModuleException - default module exception.

getViewController

IViewController getViewController(IContext context,
 Class natureClass)
                           throws WorkflowModuleException

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

Specified by:

getViewController in interface IBaseWorkflowModule

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
IViewController getViewController(IProject project,
 InputStream inputStream)
                           throws WorkflowModuleException

Deprecated.

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

Specified by:

getViewController in interface IBaseWorkflowModule

Parameters:

project - The current project

inputStream - The java.io.InputStream XML entry.

Returns:

A IViewController object.

Throws:

WorkflowModuleException - default module exception.

getViewController

IViewController getViewController(IContext context,
 IProject project,
 InputStream inputStream)
                           throws WorkflowModuleException

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

Specified by:

getViewController in interface IBaseWorkflowModule

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.

getDelegationController

IDelegationController getDelegationController()
                                       throws WorkflowModuleException

Gets a delegation controller to delegate IDelegationSupport objects.

Specified by:

getDelegationController in interface IBaseWorkflowModule

Returns:

A IDelegationController object.

Throws:

WorkflowModuleException - default module exception.

getArchivingController

IArchivingController getArchivingController()
                                     throws WorkflowModuleException

Gets a archiving controller to archive IElement objects.

Specified by:

getArchivingController in interface IBaseWorkflowModule

Returns:

A IArchivingController object.

Throws:

WorkflowModuleException - default module exception.

getUserByLogin

IUser getUserByLogin(String login)
              throws WorkflowModuleException

Gets a user by its login

Specified by:

getUserByLogin in interface IBaseWorkflowModule

Parameters:

login - The login of the user

Returns:

A IUser object.

Throws:

WorkflowModuleException - default module exception.

getGroupByName

@Deprecated
IGroup getGroupByName(String name)
               throws WorkflowModuleException

Deprecated.

use the IDirectoryModule instead.

Gets a group by its name

Specified by:

getGroupByName in interface IBaseWorkflowModule

Parameters:

name - The system name of the group.

Returns:

A IGroup object.

Throws:

WorkflowModuleException - default module exception.

getWorkflowInstance

IWorkflowInstance getWorkflowInstance(Object object)
                               throws WorkflowModuleException

Gets a IWorkflowInstance object from an object.

Specified by:

getWorkflowInstance in interface IBaseWorkflowModule

Parameters:

object - Any of the following values:

 com.axemble.vdp.treatment.interfaces.Treatment
 

Returns:

A IWorkflowInstance object.

Throws:

WorkflowModuleException - default module exception.

getResource

IResource getResource(Object object)
               throws WorkflowModuleException

Gets a IResource object from an object.

Specified by:

getResource in interface IBaseWorkflowModule

Parameters:

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

getCatalog

ICatalog getCatalog(IStorageKey key)
             throws WorkflowModuleException

Gets a catalog object from its identifier.

Specified by:

getCatalog in interface IBaseWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A ICatalog object.

Throws:

WorkflowModuleException - default module exception.

getUser

IUser getUser(IStorageKey key)
       throws WorkflowModuleException

Gets a user object from its identifier.

Specified by:

getUser in interface IBaseWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A IUser object.

Throws:

WorkflowModuleException - default module exception.

getRole

@Deprecated
IRole getRole(IStorageKey key)
       throws WorkflowModuleException

Deprecated.

use getOperatorRole or getProfile

Gets a role object from its identifier.

Specified by:

getRole in interface IBaseWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A IRole object.

Throws:

WorkflowModuleException - default module exception.

getOperatorRole

IOperatorRole getOperatorRole(IStorageKey key)
                       throws WorkflowModuleException

Gets a role object from its identifier.

Specified by:

getOperatorRole in interface IBaseWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A IOperatorRole object.

Throws:

WorkflowModuleException - default module exception.

getProfile

IProfile getProfile(IStorageKey key)
             throws ModuleException

Gets a role object from its identifier.

Specified by:

getProfile in interface IBaseWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A IProfile object.

Throws:

ModuleException - default module exception.

getWorkflowContainer

IWorkflowContainer getWorkflowContainer(IStorageKey key)
                                 throws WorkflowModuleException

Gets a workflow container object from its identifier.

Specified by:

getWorkflowContainer in interface IBaseWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A IWorkflowContainer object.

Throws:

WorkflowModuleException - default module exception.

getWorkflow

IWorkflow getWorkflow(IStorageKey key)
               throws WorkflowModuleException

Gets a workflow object from its identifier.

Specified by:

getWorkflow in interface IBaseWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A IWorkflow object.

Throws:

WorkflowModuleException - default module exception.

getTask

ITask getTask(IStorageKey key)
       throws WorkflowModuleException

Gets a task object from its identifier.

Specified by:

getTask in interface IBaseWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A ITask object.

Throws:

WorkflowModuleException - default module exception.

getAction

IAction getAction(IStorageKey key)
           throws WorkflowModuleException

Gets an action object from its identifier.

Specified by:

getAction in interface IBaseWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A IAction object.

Throws:

WorkflowModuleException - default module exception.

getResourceDefinition

IResourceDefinition getResourceDefinition(IStorageKey key)
                                   throws WorkflowModuleException

Gets a resource definition object from its identifier.

Specified by:

getResourceDefinition in interface IBaseWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A IResourceDefinition object.

Throws:

WorkflowModuleException - default module exception.

getProperty

IProperty getProperty(IStorageKey key)
               throws WorkflowModuleException

Gets a property object from its identifier.

Specified by:

getProperty in interface IBaseWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A IProperty object.

Throws:

WorkflowModuleException - default module exception.

getWorkflowInstance

IWorkflowInstance getWorkflowInstance(IStorageKey key)
                               throws WorkflowModuleException

Gets a workflow instance object from its identifier.

Specified by:

getWorkflowInstance in interface IBaseWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A IWorkflowInstance object.

Throws:

WorkflowModuleException - default module exception.

getTaskInstance

ITaskInstance getTaskInstance(IStorageKey key)
                       throws WorkflowModuleException

Gets a task instance object from its identifier.

Specified by:

getTaskInstance in interface IBaseWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A ITaskInstance object.

Throws:

WorkflowModuleException - default module exception.

getOperator

IOperator getOperator(IStorageKey key)
               throws WorkflowModuleException

Gets an operator object from its identifier.

Specified by:

getOperator in interface IBaseWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A IOperator object.

Throws:

WorkflowModuleException - default module exception.

getOperatorByLogin

IOperator getOperatorByLogin(String login)
                      throws WorkflowModuleException

Gets an IOperator from a user login.

Specified by:

getOperatorByLogin in interface IBaseWorkflowModule

Parameters:

login - The user login

Returns:

A IOperator object.

Throws:

WorkflowModuleException - default module exception.

getResource

IResource getResource(IStorageKey key)
               throws WorkflowModuleException

Gets a resource object from its identifier.

Specified by:

getResource in interface IBaseWorkflowModule

Parameters:

key - A IStorageKey object.

Returns:

A IResource object.

Throws:

WorkflowModuleException - default module exception.

getCatalog

ICatalog getCatalog(IResourceDefinition resourceDefinition)
             throws WorkflowModuleException

Gets a ICatalog object from a resource definitino.

Specified by:

getCatalog in interface IBaseWorkflowModule

Parameters:

resourceDefinition - A resource definition.

Returns:

A ICatalog object.

Throws:

WorkflowModuleException - default module exception.

getUser

@Deprecated
IUser getUser(String id)
       throws WorkflowModuleException

Deprecated.

Use getUser( IStorageKey key ) method instead.

Gets a IUser object from its string identifier.

Specified by:

getUser in interface IBaseWorkflowModule

Parameters:

id - A string identifier.

Returns:

A IUser object.

Throws:

WorkflowModuleException - default module exception.

getWorkflowInstance

@Deprecated
IWorkflowInstance getWorkflowInstance(String id)
                               throws WorkflowModuleException

Deprecated.

Use getWorkflowInstance( IStorageKey key ) method instead.

Gets a IWorkflowInstance object from its string identifier.

Specified by:

getWorkflowInstance in interface IBaseWorkflowModule

Parameters:

id - A string identifier.

Returns:

A IWorkflowInstance object.

Throws:

WorkflowModuleException - default module exception.

getTaskInstance

@Deprecated
ITaskInstance getTaskInstance(String id)
                       throws WorkflowModuleException

Deprecated.

Use getTaskInstance( IStorageKey key ) method instead.

Gets a ITaskInstance object from its string identifier.

Specified by:

getTaskInstance in interface IBaseWorkflowModule

Parameters:

id - A string identifier.

Returns:

A ITaskInstance object.

Throws:

WorkflowModuleException - default module exception.

getOperator

@Deprecated
IOperator getOperator(String id)
               throws WorkflowModuleException

Deprecated.

Use getOperator( IStorageKey key ) method instead.

Gets a IOperator object from its string identifier.

Specified by:

getOperator in interface IBaseWorkflowModule

Parameters:

id - A string identifier.

Returns:

A IOperator object.

Throws:

WorkflowModuleException - default module exception.

getResource

@Deprecated
IResource getResource(String id)
               throws WorkflowModuleException

Deprecated.

Use getResource( IStorageKey key ) method instead.

Gets a IResource object from its string identifier.

Specified by:

getResource in interface IBaseWorkflowModule

Parameters:

id - A string identifier.

Returns:

A IResource object.

Throws:

WorkflowModuleException - default module exception.

getResources

Collection<? extends IResource> getResources(IContext context,
 IResourceDefinition resourceDefinition)
                                      throws WorkflowModuleException

Gets a collection of IResource objects from a resource definition.

Specified by:

getResources in interface IBaseWorkflowModule

Parameters:

context - The execution context.

resourceDefinition - The IResourceDefinition object.

Returns:

a Collection of IResource object.

Throws:

WorkflowModuleException - default module exception.

getResources

Collection<? extends IResource> getResources(IContext context,
 ICatalog catalog)
                                      throws WorkflowModuleException

Gets a collection of IResource objects from a catalog

Specified by:

getResources in interface IBaseWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog object.

Returns:

a Collection of IResource object.

Throws:

WorkflowModuleException - default module exception.

findStorageResourceByReference

IStorageResource findStorageResourceByReference(IContext context,
 IResourceDefinition resourceDefinition,
 String reference)

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

Specified by:

findStorageResourceByReference in interface IBaseWorkflowModule

Parameters:

context - The execution context.

resourceDefinition - The IResourceDefinition object.

reference - The reference to set.

Returns:

a IStorageResource object or null.

createStorageResource

IStorageResource createStorageResource(IContext context,
 IResourceDefinition resourceDefinition,
 String reference,
 String label)
                                throws WorkflowModuleException

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

Specified by:

createStorageResource in interface IBaseWorkflowModule

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.

createStorageResource

IStorageResource createStorageResource(IContext context,
 IResourceDefinition resourceDefinition,
 String reference)
                                throws WorkflowModuleException

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

Specified by:

createStorageResource in interface IBaseWorkflowModule

Parameters:

context - The execution context.

resourceDefinition - The IResourceDefinition object.

reference - The reference to set.

Returns:

a IStorageResource object.

Throws:

WorkflowModuleException - default module exception.

getElementByProtocolURI

IProtocolSupport getElementByProtocolURI(String protocolURI)
                                  throws ModuleException

Gets an IElement object which implements IProtocolSupport interface.

Specified by:

getElementByProtocolURI in interface IBaseWorkflowModule

Parameters:

protocolURI - The protocol URI as a java.lang.String.

Returns:

A IProtocolSupport object.

Throws:

ModuleException - default module exception.

setDynamicLocalizationsWrapperMessageForLanguage

IDynamicLocalizationsWrapper setDynamicLocalizationsWrapperMessageForLanguage(IContext context,
 IDynamicLocalizationsWrapper dynamicLocalizationsWrapper,
 ICatalog catalog,
 String language,
 String message)
                                                                       throws ModuleException

Creates a dynamicLocalizationsWrapper object by specifying the parent ICatalog object.

Specified by:

setDynamicLocalizationsWrapperMessageForLanguage in interface IBaseWorkflowModule

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

IDynamicLocalizationsWrapper createDynamicLocalizationsWrapper(IContext context,
 ICatalog catalog)
                                                        throws ModuleException

Creates a dynamicLocalizationsWrapper object by specifying the parent ICatalog object.

Specified by:

createDynamicLocalizationsWrapper in interface IBaseWorkflowModule

Parameters:

context - The execution context.

catalog - The ICatalog object.

Returns:

A IDynamicLocalizationsWrapper object.

Throws:

ModuleException - default module exception.

hasDiscussionThread

boolean hasDiscussionThread(IContext context,
 IWorkflowInstance iWorkflowInstance)

Allows knowing if an IWorkflowInstance has a discussion thread or not

Specified by:

hasDiscussionThread in interface IBaseWorkflowModule

Parameters:

context - the context

iWorkflowInstance - the IWorkflowInstance

Returns:

true if IWorkflowInstance has a discussion thread otherwise false

getDiscussionMessagesOrderByCreationDateDesc

Collection<IWorkflowInstanceDiscussionMessage> getDiscussionMessagesOrderByCreationDateDesc(IContext context,
 IWorkflowInstance workflowInstance)

Retrieve IWorkflowInstance's message

Specified by:

getDiscussionMessagesOrderByCreationDateDesc in interface IBaseWorkflowModule

Parameters:

context - the context

workflowInstance - the workflowInstance

Returns:

the IWorkflowInstanceDiscussionMessage collection

canModifyDiscussionMessage

DiscussionAccessCheckResult canModifyDiscussionMessage(IContext context,
 IDiscussionMessage iDiscussionMessage)

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

Specified by:

canModifyDiscussionMessage in interface IBaseWorkflowModule

Parameters:

context - the context

iDiscussionMessage - the IDiscussionMessage

Returns:

the DiscussionAccessCheckResult enum value result

canDeleteDiscussionMessage

DiscussionAccessCheckResult canDeleteDiscussionMessage(IContext context,
 IDiscussionMessage iDiscussionMessage)

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

Specified by:

canDeleteDiscussionMessage in interface IBaseWorkflowModule

Parameters:

context - the context

iDiscussionMessage - the IDiscussionMessage

Returns:

the DiscussionAccessCheckResult enum value result

deleteDiscussionMessage

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

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

Specified by:

deleteDiscussionMessage in interface IBaseWorkflowModule

Parameters:

context - the context

iWorkflowInstanceDiscussionMessage - the iWorkflowInstanceDiscussionMessage

iWorkflowInstance - the the IWorkflowInstance

createDiscussionMessage

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.

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

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

void updateDiscussionMessage(IContext context,
 IWorkflowInstanceDiscussionMessage iWorkflowInstanceDiscussionMessage,
 String content,
 Collection<IAttachment> attachments)

Update content and/or attachments of a message.

Specified by:

updateDiscussionMessage in interface IBaseWorkflowModule

Parameters:

context - the context

iWorkflowInstanceDiscussionMessage - the iWorkflowInstanceDiscussionMessage

content - the content

attachments - the collection of IAttachment

getResourceController

IResourceController getResourceController(IResource resource)
                                   throws WorkflowModuleException

Gets the resource controller object.

Parameters:

resource - The main resource to work on.

Returns:

A IResourceController object.

Throws:

WorkflowModuleException - default module exception.

getFieldController

IFieldController getFieldController(ICatalog catalog)

Gets the resource controller object.

Parameters:

catalog - the catalog containing the fields

Returns:

A IFieldController object.

getFieldController

IFieldController getFieldController(IWorkflow workflow)

Gets the resource controller object.

Parameters:

workflow - the workflow containing the fields

Returns:

A IFieldController object.

getFieldController

IFieldController getFieldController(IResourceDefinition resourceDefinition)

Gets the resource controller object.

Parameters:

resourceDefinition - the resourceDefinition containing the fields

Returns:

A IFieldController object.

getDefinitionsFactory

com.axemble.vdoc.sdk.interfaces.ui.definitions.IDefinitionsFactory getDefinitionsFactory()

Gets access to all available definitions.

Returns:

IDefinitionsFactory object.

lock

void lock(IContext context,
 IWorkflowInstance workflowInstance,
 int delay)
   throws WorkflowModuleException

Allows to lock workflow instance.

Parameters:

context - The IContext execution context.

workflowInstance - The IWorkflowInstance object.

delay - lock delay in second

Throws:

WorkflowModuleException - default module exception.

unlock

void unlock(IContext context,
 IWorkflowInstance workflowInstance)
     throws WorkflowModuleException

Allows to unlock workflow instance.

Parameters:

context - The IContext execution context.

workflowInstance - The IWorkflowInstance object.

Throws:

WorkflowModuleException - default module exception.

isLocked

boolean isLocked(IContext context,
 IWorkflowInstance workflowInstance)
          throws WorkflowModuleException

Checks if a specified workflow instance is locked

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

Collection<IUser> lockedBy(IContext context,
 IWorkflowInstance workflowInstance)
                    throws WorkflowModuleException

Retrieve the users who locked the workflow instance.

Parameters:

context - The IContext execution context.

workflowInstance - The IWorkflowInstance object.

Returns:

a list of IUser users.

Throws:

WorkflowModuleException - default module exception.

isLockBySDK

boolean isLockBySDK(IContext context,
 IWorkflowInstance workflowInstance)
             throws WorkflowModuleException

Checks if a specified workflow instance is locked by the SDK

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

String getListLabel(ICatalog catalog,
 String listName,
 String key,
 String language)
             throws WorkflowModuleException

get translated value of a list

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