IBaseDocumentModule (moovapps-process-parent 18.0.0 API)

All Superinterfaces:: IModule, Remote

All Known Subinterfaces:: IDocumentModule

public interface IBaseDocumentModule
extends IModule

The document management module interface.

Code sample :

 // creation of a directory module object
 IBaseDocumentModule documentModule = Modules.getDocumentModule();
 try
 {
 }
 finally
 {
  // uninitialize the module
        Modules.releaseModule(documentModule);
 }

Since:: 1.0
Version:: 1.0, 10/06/2010
Author:: vlygeros
See Also:: IVersion, IFolder

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`abort(IContext context, IVersion version, String comment)` Allows to abort workflow instance.
`IAttachment`	`addAttachment(IResource resource, String propertyName, File file)` Adds an attachment as a `java.io.File` object.
`IAttachment`	`addAttachment(IResource resource, String propertyName, IAttachment attachment)` Adds an attachment from an attachment.
`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.
`ICatalog`	`createCatalog(IContext context, String name, String label, IProject project)` Allows to create a new catalog.
`IDataUnit`	`createDataUnit(IContext context, IResourceDefinition resourceDefinition, String reference)` Creates a storage resource object by specifying the `IResourceDefinition` object, its reference.
`IDataUnit`	`createDataUnit(IContext context, IResourceDefinition resourceDefinition, String reference, String label)` Creates a data unit object by specifying the `IResourceDefinition` object, its reference, and its label.
`IResource`	`createGenericResource()` Creates a generic resource for mail purposes.
`IRole`	`createRole(IContext context, ICatalog catalog, String name)` Creates a `IRole` into the catalog object.
`IVersion`	`createVersion(IContext context, IAttachmentTemplate attachmentTemplate, String reference)` Creates a version instance object by specifying the `IAttachmentTemplate` object, its reference.
`IVersion`	`createVersion(IContext context, IResourceDefinition resourceDefinition, String reference, String label)` Creates a version 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.
`void`	`end(IContext context, ITaskInstance instance, IAction action, String comment)` Crosses a transition.
`void`	`end(IContext context, IUser addressee, ITaskInstance instance, IAction action, String comment)` Allows to cross a transition for another user.
`String`	`evaluatedHtml(IResource resource, IMailForm mailForm)` Evaluates the form and returns the HTML content as a `java.lang.String` object.
`String`	`evaluatedHtml(ITaskInstance taskInstance, IMailForm mailForm)` Evaluates the form and returns the HTML content as a `java.lang.String` object.
`void`	`execute(IAgent agent)` Allows to execute an agent.
`void`	`execute(IContext context, IAgent agent)` Allows to execute an agent.
`int`	`generateChrono(IResourceDefinition resourceDefinition)` Evaluate the next chrono based on the format specified on the Designer tool.
`String`	`generateReference(IResource resource)` Evaluate the next reference based on the format specified on the Designer tool.
`String`	`generateReference(IResourceDefinition resourceDefinition)` Evaluate the next reference based on the format specified on the Designer tool.
`String`	`generateReference(IResourceDefinition resourceDefinition, String format)` Evaluate the next reference based on the passed format.
`String`	`generateReference(IResource resource, String format)` Evaluate the next reference based on the specified format.
`Collection<? extends ITaskInstance>`	`getAbortedTaskInstances(IContext context, IVersion version)` Retrieves all the aborted task instances of a version.
`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.
`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, int catalogType, IProject project)` Retrieves a catalog form its name.
`ICatalog`	`getCatalog(IResourceDefinition resourceDefinition)` Gets a `ICatalog` object from a resource definitino.
`ICatalog`	`getCatalog(IStorageKey key)` Gets a catalog object from its identifier.
`ICatalog`	`getCatalog(IWorkflow workflow)` Retrieves the catalog of a `IWorkflow` object.
`Collection<? extends ICatalog>`	`getCatalogs(IContext context)` Retrieves a collection of `ICatalog` object.
`Collection<? extends ICatalog>`	`getCatalogs(IContext context, int catalogType)` Retrieves a collection of `ICatalog` object.
`Collection<? extends ICatalog>`	`getCatalogs(IContext context, 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.
`IConnectionDefinition`	`getConnectionDefinition(IContext context, String name)` Gets a connection from its name.
`Collection<? extends IConnectionDefinition>`	`getConnectionDefinitions(IContext context)` Gets a collection of connections.
`IDataSourceReference`	`getDataSourceReference(String name)` Gets a data source reference from its JNDI name.
`IDelegationController`	`getDelegationController()` Gets a delegation controller to delegate `IDelegationSupport` objects.
`IProtocolSupport`	`getElementByProtocolURI(String protocolURI)` Gets an `IElement` object which implements `IProtocolSupport` interface.
`Collection<? extends ITaskInstance>`	`getEndedTaskInstances(IContext context, IVersion version)` Retrieves all the ended task instances of a version.
`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.
`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()`
`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.
`IList`	`getList(IContext context, ICatalog catalog, String name)` Gets a list object from a catalog by its name.
`Collection`	`getList(IResource resource, String propertyName)` Gets the available values of a list property.
`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, IVersion version)` Retrieves all the manual task instances of a workflow instance.
`ITaskInstance`	`getOneTaskInstance(IContext context, IVersion version)` Gets one of the task instances (any).
`IOperator`	`getOperator(IStorageKey key)` Gets a operator object from its identifier.
`Collection<? extends IOperator>`	`getOperators(ITaskInstance instance)` Retrieves the operators of a task instance.
`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.
`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)` Retrieves a `IRole` object by its system name.
`IRole`	`getRole(IStorageKey key)` Gets a role object from its identifier.
`Collection<? extends IRole>`	`getRoles(IContext context, ICatalog catalog)` Retrieves a collection of `IRole` objects within a specified catalog.
`ISearchController`	`getSearchController()` Gets the default `ISearchController` object.
`ISearchController`	`getSearchController(IConnectionDefinition connectionDefinition)` Gets a connection from its name.
`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, IVersion version)` Retrieves all the started task instances of a version.
`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, IVersion version, String name)` Gets a task instance associated with a specified task name.
`ITaskInstance`	`getTaskInstance(IStorageKey key)` Gets a task instance object from its identifier.
`Collection<? extends ITaskInstance>`	`getTaskInstances(IContext context, IVersion version)` Retrieves all the task instances of a specified version.
`Collection<? extends ITaskInstance>`	`getTaskInstances(IContext context, IVersion version, String name)` Retrieves all the task instances of a specified version 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`	`getUserByLogin(String login)` Gets a user by its login
`Object`	`getValue(IResource resource, String propertyName)` Gets the value of a property.
`IVersion`	`getVersion(IStorageKey key)` Gets a version object from its identifier.
`Collection<? extends IVersion>`	`getVersions(IContext context, ICatalog catalog)` Gets all the versions of a specified `ICatalog` object.
`Collection<? extends IVersion>`	`getVersions(IContext context, ICatalog catalog, String reference)` Gets all the versions with the same reference within a specified `ICatalog` object.
`Collection<? extends IVersion>`	`getVersions(IContext context, IResourceDefinition resourceDefinition, String reference)` Gets all the versions with the same reference within a specified `IWorkflow` object.
`Collection<IVersion>`	`getVersions(IContext context, ITask task)` Gets all the workflow instances of a specified `ITask` object.
`Collection<? extends IVersion>`	`getVersions(IContext context, IWorkflow workflow)` Gets all the versions of a specified `IWorkflow` object.
`IView`	`getView(IContext context, IResourceDefinition resourceDefinition, String viewName)` Retrieves a view by its name.
`IViewController`	`getViewController()` Gets a view controller to search `IResource` objects through their properties.
`IViewController`	`getViewController(Class natureClass)` Gets a view controller to search `IResource` objects through their properties.
`IViewController`	`getViewController(IContext context, InputStream inputStream)` Gets a view controller to search `IResource` objects through their properties.
`IViewController`	`getViewController(InputStream inputStream)` Gets a view controller to search `IResource` objects through their properties.
`IWorkflow`	`getWorkflow(IContext context, ICatalog catalog, String name)` Retrieves a workflow within a `IWorkflow` object and from its system 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(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.
`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`	`isMemberOf(IUser user, IRole role)` Checks if a specified user is member of a `IRole` object.
`void`	`remind(IContext context, ITaskInstance taskInstance, String comment)` Allows to remind current operators of a specified task instance.
`void`	`remind(IContext context, IVersion version, String comment)` Allows to remind current operators of a version.
`void`	`send(IContext context, IResource resource, IMailForm mailForm, Collection entries, String subject, String content)` Sends a mail by specifying the subject and the content of the body.
`void`	`send(IContext context, ITaskInstance taskInstance, IMailForm mailForm, Collection entries, String subject, String content)` Sends a mail by specifying the subject and the content of the body.
`void`	`send(IContext context, ITaskInstance instance, IMailForm form, String comment)` Sends a mail using a specified mail form.
`void`	`send(IContext context, IUser addressee, ITaskInstance instance, IMailForm form, String comment)` Sends a mail using a specified mail form.
`void`	`send(IContext context, IVersion version, String formName, Collection entries)` Allows to send a mail with a specific form to a mail recipient.
`void`	`send(IContext context, IWorkflow workflow, IResource resource, String formName, Collection entries)` Allows to send a mail.
`void`	`send(IContext context, IWorkflow workflow, String formName, Collection entries)` Allows to send a mail.
`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 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.

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 Detail
  - getConfiguration
```
IConfiguration getConfiguration()
```
    Gets the global configuration.
    
    Returns:
    
    a IConfiguration object.
  - getAgent
```
IAgent getAgent(IContext context,
                String name)
         throws DocumentModuleException
```
    Gets an agent from its name.
    
    Parameters:
    
    context - The execution context.
    
    name - The name of the agent.
    
    Returns:
    
    a IAgent object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - execute
```
void execute(IAgent agent)
      throws DocumentModuleException
```
    Allows to execute an agent.
    
    Parameters:
    
    agent - The IAgent to execute.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - execute
```
void execute(IContext context,
             IAgent agent)
      throws DocumentModuleException
```
    Allows to execute an agent.
    
    Parameters:
    
    context - The execution context.
    
    agent - The IAgent to execute.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getDataSourceReference
```
IDataSourceReference getDataSourceReference(String name)
                                     throws DocumentModuleException
```
    Gets a data source reference from its JNDI name.
    
    Parameters:
    
    name - The JNDI name.
    
    Returns:
    
    a IDataSourceReference object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getJdbcReference
```
@Deprecated
IJdbcReference getJdbcReference(IContext context,
                                            String name)
                                     throws DocumentModuleException
```
    Deprecated. : use getConnectionDefinition( IContext context, String name ) method instead.
    
    Gets a JDBC reference from its name.
    
    Parameters:
    
    context - The execution context.
    
    name - The name of the external reference.
    
    Returns:
    
    a IJdbcReference object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getConnectionDefinition
```
IConnectionDefinition getConnectionDefinition(IContext context,
                                              String name)
                                       throws DocumentModuleException
```
    Gets a connection from its name.
    
    Parameters:
    
    context - The execution context.
    
    name - The name of the external reference.
    
    Returns:
    
    a IConnectionDefinition object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getJdbcReferences
```
@Deprecated
Collection<? extends IJdbcReference> getJdbcReferences(IContext context)
                                                            throws DocumentModuleException
```
    Deprecated. : use getConnectionDefinitions( IContext context ) method instead.
    
    Gets a collection of JDBC references.
    
    Parameters:
    
    context - The execution context.
    
    Returns:
    
    a Collection of IJdbcReference object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getConnectionDefinitions
```
Collection<? extends IConnectionDefinition> getConnectionDefinitions(IContext context)
                                                              throws DocumentModuleException
```
    Gets a collection of connections.
    
    Parameters:
    
    context - The execution context.
    
    Returns:
    
    a Collection of IConnectionDefinition object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getList
```
IList getList(IContext context,
              ICatalog catalog,
              String name)
       throws DocumentModuleException
```
    Gets a list object from a catalog by its name.
    
    Parameters:
    
    context - The execution context.
    
    catalog - The ICatalog representing the application.
    
    name - The name of the list.
    
    Returns:
    
    a IList object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getLists
```
Collection<? extends IList> getLists(IContext context,
                                     ICatalog catalog)
                              throws DocumentModuleException
```
    Gets a collection of a the lists available on a specified ICatalog object.
    
    Parameters:
    
    context - The execution context.
    
    catalog - The ICatalog representing the application.
    
    Returns:
    
    a collection of IList object
    
    Throws:
    
    DocumentModuleException - default module exception.
  - createCatalog
```
ICatalog createCatalog(IContext context,
                       String name,
                       String label,
                       IProject project)
                throws DocumentModuleException
```
    Allows to create a new catalog. This method allows to specify the system name, the label of the catalog and the attached project
    
    Parameters:
    
    context - The execution context.
    
    name - The system name of the catalog.
    
    label - The label of the catalog.
    
    project - The project of the catalog
    
    Returns:
    
    a ICatalog object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getCatalog
```
ICatalog getCatalog(IContext context,
                    String name,
                    int catalogType,
                    IProject project)
             throws DocumentModuleException
```
    Retrieves a catalog form its name.
    
    Parameters:
    
    context - The execution context.
    
    name - The system name of the catalog.
    
    catalogType - The ICatalog.IType of the catalog.
    
    project - The project of the catalog
    
    Returns:
    
    a ICatalog object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getCatalogs
```
Collection<? extends ICatalog> getCatalogs(IContext context)
                                    throws DocumentModuleException
```
    Retrieves a collection of ICatalog object.
    
    Parameters:
    
    context - The execution context.
    
    project - The project of the catalog
    
    Returns:
    
    a collection of ICatalog objects.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getCatalogs
```
Collection<? extends ICatalog> getCatalogs(IContext context,
                                           int catalogType)
                                    throws DocumentModuleException
```
    Retrieves a collection of ICatalog object.
    
    Parameters:
    
    context - The execution context.
    
    catalogType - The ICatalog.IType of the catalogs.
    
    project - The project of the catalog
    
    Returns:
    
    a collection of ICatalog objects.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getCatalogs
```
Collection<? extends ICatalog> getCatalogs(IContext context,
                                           IProject project)
                                    throws DocumentModuleException
```
    Retrieves a collection of ICatalog object.
    
    Parameters:
    
    context - The execution context.
    
    catalogType - The ICatalog.IType of the catalogs.
    
    project - The project of the catalog
    
    Returns:
    
    a collection of ICatalog objects.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - createRole
```
IRole createRole(IContext context,
                 ICatalog catalog,
                 String name)
          throws DocumentModuleException
```
    Creates a IRole into the catalog object.
    
    Parameters:
    
    context - The execution context.
    
    catalog - The ICatalog object.
    
    name - The system name of the IRole to be created.
    
    Returns:
    
    a IRole object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getRole
```
IRole getRole(IContext context,
              ICatalog catalog,
              String name)
       throws DocumentModuleException
```
    Retrieves a IRole object by its system name.
    
    Parameters:
    
    context - The execution context.
    
    catalog - The ICatalog scope object.
    
    name - The system name of the role.
    
    Returns:
    
    a IRole object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getRoles
```
Collection<? extends IRole> getRoles(IContext context,
                                     ICatalog catalog)
                              throws DocumentModuleException
```
    Retrieves a collection of IRole objects within a specified catalog.
    
    Parameters:
    
    context - The execution context.
    
    catalog - The ICatalog object.
    
    Returns:
    
    a collection of IRole objects.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - isMemberOf
```
boolean isMemberOf(IUser user,
                   IRole role)
            throws DocumentModuleException
```
    Checks if a specified user is member of a IRole object.
    
    Parameters:
    
    user - The IUser object to check.
    
    role - The IRole object.
    
    Returns:
    
    return true if the user is member of the IRole object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - addChild
```
void addChild(IGroup group,
              IRole role)
       throws DocumentModuleException
```
    Adds a group to a role.
    
    Parameters:
    
    group - The group to add.
    
    role - The role object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - addMember
```
void addMember(IUser user,
               IRole role)
        throws DocumentModuleException
```
    Adds a user to a role.
    
    Parameters:
    
    user - The user to add.
    
    role - The role object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - createWorkflowContainer
```
IWorkflowContainer createWorkflowContainer(IContext context,
                                           ICatalog catalog,
                                           String name)
                                    throws DocumentModuleException
```
    Creates a workflow container within a ICatalog object.
    
    Parameters:
    
    context - The execution context.
    
    catalog - The ICatalog object.
    
    name - The system name of the IWorkflowContainer object.
    
    Returns:
    
    a IWorkflowContainer object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getWorkflowContainer
```
IWorkflowContainer getWorkflowContainer(IContext context,
                                        ICatalog catalog,
                                        String name)
                                 throws DocumentModuleException
```
    Retrieves a IWorkflowContainer within a ICatalog by its system name
    
    Parameters:
    
    context - The execution context.
    
    catalog - The ICatalog object.
    
    name - The system name of the IWorkflowContainer object.
    
    Returns:
    
    a IWorkflowContainer object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getWorkflowContainers
```
Collection<? extends IWorkflowContainer> getWorkflowContainers(IContext context,
                                                               ICatalog catalog)
                                                        throws DocumentModuleException
```
    Retrieves a collection of IWorkflowContainer objects within a ICatalog object.
    
    Parameters:
    
    context - The execution context.
    
    catalog - The ICatalog object.
    
    Returns:
    
    a collection of IWorkflowContainer objects.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - createWorkflow
```
IWorkflow createWorkflow(IContext context,
                         IWorkflowContainer container,
                         String name,
                         byte[] content)
                  throws DocumentModuleException
```
    Creates a workflow within a workflow container.
    
    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:
    
    DocumentModuleException - default module exception.
  - getWorkflow
```
IWorkflow getWorkflow(IContext context,
                      ICatalog catalog,
                      String name)
               throws DocumentModuleException
```
    Retrieves a workflow within a IWorkflow object and from its system name.
    
    Parameters:
    
    context - The execution context.
    
    catalog - The ICatalog object.
    
    name - The system name of the workflow.
    
    Returns:
    
    a IWorkflow object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getWorkflows
```
Collection<? extends IWorkflow> getWorkflows(IContext context,
                                             ICatalog catalog)
                                      throws DocumentModuleException
```
    Retrieves a collection of IWorkflow objects within a ICatalog object.
    
    Parameters:
    
    context - The execution context.
    
    catalog - The ICatalog object.
    
    Returns:
    
    a collection of IWorkflow objects.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getWorkflows
```
Collection<? extends IWorkflow> getWorkflows(IContext context,
                                             IWorkflowContainer container)
                                      throws DocumentModuleException
```
    Retrieves a collection of IWorkflow objects within a IWorkflowContainer object.
    
    Parameters:
    
    context - The execution context.
    
    container - The IWorkflowContainer object.
    
    Returns:
    
    a collection of IWorkflow objects.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getCatalog
```
ICatalog getCatalog(IWorkflow workflow)
             throws DocumentModuleException
```
    Retrieves the catalog of a IWorkflow object.
    
    Parameters:
    
    workflow - The workflow object.
    
    Returns:
    
    a ICatalog object
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getWorkflowContainer
```
IWorkflowContainer getWorkflowContainer(IWorkflow workflow)
                                 throws DocumentModuleException
```
    Retrieves the workflow container of a IWorkflow object.
    
    Parameters:
    
    workflow - The workflow object.
    
    Returns:
    
    a IWorkflowContainer object
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getTask
```
ITask getTask(IContext context,
              IWorkflow workflow,
              String name)
       throws DocumentModuleException
```
    Retrieves a specific task of a IWorkflow object by its name.
    
    Parameters:
    
    context - The execution context.
    
    workflow - The IWorkflow object.
    
    name - The system name of the ITask object.
    
    Returns:
    
    a ITask object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getActions
```
Collection<? extends IAction> getActions(IContext context,
                                         ITask task)
                                  throws DocumentModuleException
```
    Retrieves a collection of IAction objects within a ITask.
    
    Parameters:
    
    context - The execution context.
    
    task - The ITask object.
    
    Returns:
    
    a collection of IAction objects.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getAction
```
IAction getAction(IContext context,
                  ITask task,
                  String name)
           throws DocumentModuleException
```
    Retrieve a specific IAction object from its system name.
    
    Parameters:
    
    context - The execution context.
    
    task - The ITask object.
    
    name - The system name of the IAction object to retrieve.
    
    Returns:
    
    a IAction object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getWorkflow
```
IWorkflow getWorkflow(ITask task)
               throws DocumentModuleException
```
    Gets the associated workflow of a task.
    
    Parameters:
    
    task - the ITask object.
    
    Returns:
    
    a IWorkflow object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getResourceDefinition
```
IResourceDefinition getResourceDefinition(IContext context,
                                          ICatalog catalog,
                                          String name)
                                   throws DocumentModuleException
```
    Retrieves a resource definition by specifying the ICatalog and its system name.
    
    Parameters:
    
    context - The execution context.
    
    catalog - The ICatalog object.
    
    name - The system name of the resource definition.
    
    Returns:
    
    a IResourceDefinition object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getResourceDefinitions
```
Collection<? extends IResourceDefinition> getResourceDefinitions(IContext context,
                                                                 ICatalog catalog)
                                                          throws DocumentModuleException
```
    Retrieves all resource definitions by specifying the ICatalog
    
    Parameters:
    
    context - The execution context.
    
    catalog - The ICatalog object.
    
    Returns:
    
    a collection of IResourceDefinition objects.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getView
```
IView getView(IContext context,
              IResourceDefinition resourceDefinition,
              String viewName)
       throws DocumentModuleException
```
    Retrieves a view by its name.
    
    Parameters:
    
    context - The execution context.
    
    resourceDefinition - The IResourceDefinition object.
    
    viewName - The name of the view.
    
    Returns:
    
    a IView object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getProperties
```
Collection<? extends IProperty> getProperties(IContext context,
                                              IResourceDefinition resourceDefinition)
                                       throws DocumentModuleException
```
    Gets all the properties of a specified definition.
    
    Parameters:
    
    context - The execution context.
    
    resourceDefinition - a IResourceDefinition object.
    
    Returns:
    
    a collection of IProperty objects.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getProperty
```
IProperty getProperty(IContext context,
                      IResourceDefinition resourceDefinition,
                      String name)
               throws DocumentModuleException
```
    Gets a property definition by specifying the IResourceDefinition and its system name.
    
    Parameters:
    
    context - The execution context.
    
    resourceDefinition - The IResourceDefinition object.
    
    name - The system name of the property.
    
    Returns:
    
    a IProperty object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - generateReference
```
String generateReference(IResourceDefinition resourceDefinition)
                  throws DocumentModuleException
```
    Evaluate the next reference based on the format specified on the Designer tool.
    
    Parameters:
    
    resourceDefinition - The resource definition object.
    
    Returns:
    
    The evaluated reference.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - generateReference
```
String generateReference(IResourceDefinition resourceDefinition,
                         String format)
                  throws DocumentModuleException
```
    Evaluate the next reference based on the passed format.
    
    Parameters:
    
    resourceDefinition - The IResourceDefinition object.
    
    format - The format to use to evaluate the next reference.
    
    Returns:
    
    The evaluated reference.
    
    Throws:
    
    DocumentModuleException
  - generateReference
```
String generateReference(IResource resource)
                  throws DocumentModuleException
```
    Evaluate the next reference based on the format specified on the Designer tool.
    
    Parameters:
    
    resource - The resource to be created.
    
    Returns:
    
    The evaluated reference.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - generateReference
```
String generateReference(IResource resource,
                         String format)
                  throws DocumentModuleException
```
    Evaluate the next reference based on the specified format.
    
    Parameters:
    
    resource - The resource to be created.
    
    format - The format to use to evaluate the next reference.
    
    Returns:
    
    The evaluated reference.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - generateChrono
```
int generateChrono(IResourceDefinition resourceDefinition)
            throws DocumentModuleException
```
    Evaluate the next chrono based on the format specified on the Designer tool.
    
    Parameters:
    
    resourceDefinition - The resource definition object
    
    Returns:
    
    The evaluated chrono.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - createVersion
```
IVersion createVersion(IContext context,
                       IResourceDefinition resourceDefinition,
                       String reference,
                       String label)
                throws DocumentModuleException
```
    Creates a version object by specifying the IResourceDefinition object, its reference, and its label.
    
    Parameters:
    
    context - The execution context.
    
    resourceDefinition - The IResourceDefinition object.
    
    reference - The reference to set.
    
    label - The label to set.
    
    Returns:
    
    a IVersion object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - createVersion
```
IVersion createVersion(IContext context,
                       IAttachmentTemplate attachmentTemplate,
                       String reference)
                throws DocumentModuleException
```
    Creates a version instance object by specifying the IAttachmentTemplate object, its reference.
    
    Parameters:
    
    context - The execution context.
    
    attachmentTemplate - The IAttachmentTemplate object.
    
    reference - The reference to set.
    
    Returns:
    
    a IVersion object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getVersions
```
Collection<? extends IVersion> getVersions(IContext context,
                                           ICatalog catalog,
                                           String reference)
                                    throws DocumentModuleException
```
    Gets all the versions with the same reference within a specified ICatalog object.
    
    Parameters:
    
    context - The execution context.
    
    catalog - The ICatalog object.
    
    reference - The reference of the workflow instance.
    
    Returns:
    
    a collection of IVersion objects.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getVersions
```
Collection<? extends IVersion> getVersions(IContext context,
                                           IResourceDefinition resourceDefinition,
                                           String reference)
                                    throws DocumentModuleException
```
    Gets all the versions with the same reference within a specified IWorkflow object.
    
    Parameters:
    
    context - The execution context.
    
    resourceDefinition - The IResourceDefinition object.
    
    reference - The reference of the version.
    
    Returns:
    
    a collection of IVersion objects.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getVersions
```
Collection<? extends IVersion> getVersions(IContext context,
                                           ICatalog catalog)
                                    throws DocumentModuleException
```
    Gets all the versions of a specified ICatalog object.
    
    Parameters:
    
    context - The execution context.
    
    catalog - The ICatalog object.
    
    Returns:
    
    a collection of IVersion objects.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getVersions
```
Collection<? extends IVersion> getVersions(IContext context,
                                           IWorkflow workflow)
                                    throws DocumentModuleException
```
    Gets all the versions of a specified IWorkflow object.
    
    Parameters:
    
    context - The execution context.
    
    workflow - The IWorkflow object.
    
    Returns:
    
    a collection of IVersion objects.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getVersions
```
Collection<IVersion> getVersions(IContext context,
                                 ITask task)
                          throws DocumentModuleException
```
    Gets all the workflow instances of a specified ITask object.
    
    Parameters:
    
    context - The execution context.
    
    task - The ITask object.
    
    Returns:
    
    a collection of IVersion objects.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - setValue
```
void setValue(IResource resource,
              String propertyName,
              Object value)
       throws DocumentModuleException
```
    Sets a value to a property.
    
    Parameters:
    
    resource - The IVersion object.
    
    propertyName - The system name of the property.
    
    value - The value object to set.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getValue
```
Object getValue(IResource resource,
                String propertyName)
         throws DocumentModuleException
```
    Gets the value of a property.
    
    Parameters:
    
    resource - The IVersion object.
    
    propertyName - The system name of the property.
    
    Returns:
    
    a Object object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - setList
```
void setList(IResource resource,
             String propertyName,
             Collection values)
      throws DocumentModuleException
```
    Sets the list of available values to a list property.
    
    Parameters:
    
    resource - The IVersion object.
    
    propertyName - The system name of the property.
    
    values - a collection of either String or Option.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getList
```
Collection getList(IResource resource,
                   String propertyName)
            throws DocumentModuleException
```
    Gets the available values of a list property.
    
    Parameters:
    
    resource - The IVersion object.
    
    propertyName - The system name of the property.
    
    Returns:
    
    a collection of either String or Option.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - abort
```
void abort(IContext context,
           IVersion version,
           String comment)
    throws DocumentModuleException
```
    Allows to abort workflow instance.
    
    Parameters:
    
    context - The execution context.
    
    version - The IVersion object.
    
    comment - The reason of the abortion. This comment will appear in the history entries.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - remind
```
void remind(IContext context,
            IVersion version,
            String comment)
     throws DocumentModuleException
```
    Allows to remind current operators of a version.
    
    Parameters:
    
    context - The execution context.
    
    version - The IVersion object.
    
    comment - The reason of the reminder. This comment will appear in the history entries.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - remind
```
void remind(IContext context,
            ITaskInstance taskInstance,
            String comment)
     throws DocumentModuleException
```
    Allows to remind current operators of a specified task instance.
    
    Parameters:
    
    context - The execution context.
    
    taskInstance - The ITaskInstance object.
    
    comment - The reason of the reminder. This comment will appear in the history entries.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - send
```
void send(IContext context,
          IVersion version,
          String formName,
          Collection entries)
   throws DocumentModuleException
```
    Allows to send a mail with a specific form to a mail recipient.
    
    Parameters:
    
    context - The execution context.
    
    version - The IVersion object.
    
    formName - The system name of the form to use.
    
    entries - A collection of IUser, IGroup, InternetAddress or String objects.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - send
```
void send(IContext context,
          IWorkflow workflow,
          IResource resource,
          String formName,
          Collection entries)
   throws DocumentModuleException
```
    Allows to send a mail.
    
    Parameters:
    
    context - The execution context.
    
    workflow - The IWorkflow object.
    
    resource - The IResourceInstance object.
    
    formName - The system name of the form to use.
    
    entries - A collection of IUser, IGroup, InternetAddress or String objects.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - send
```
void send(IContext context,
          IWorkflow workflow,
          String formName,
          Collection entries)
   throws DocumentModuleException
```
    Allows to send a mail.
    
    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:
    
    DocumentModuleException - default module exception.
  - getTaskInstances
```
Collection<? extends ITaskInstance> getTaskInstances(IContext context,
                                                     IVersion version)
                                              throws DocumentModuleException
```
    Retrieves all the task instances of a specified version.
    
    Parameters:
    
    context - The execution context.
    
    version - The IVersion object.
    
    Returns:
    
    a collection of ITaskInstance
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getTaskInstances
```
Collection<? extends ITaskInstance> getTaskInstances(IContext context,
                                                     IVersion version,
                                                     String name)
                                              throws DocumentModuleException
```
    Retrieves all the task instances of a specified version filtered by the name of a ITask.
    
    Parameters:
    
    context - The execution context.
    
    version - The IVersion object.
    
    name - The system name of ITask to use as a filter.
    
    Returns:
    
    a collection of ITaskInstance
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getManualTaskInstances
```
Collection<? extends ITaskInstance> getManualTaskInstances(IContext context,
                                                           IVersion version)
                                                    throws DocumentModuleException
```
    Retrieves all the manual task instances of a workflow instance.
    
    Parameters:
    
    context - The execution context.
    
    version - The IVersion object.
    
    Returns:
    
    a collection of ITaskInstance
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getStartedTaskInstances
```
Collection<? extends ITaskInstance> getStartedTaskInstances(IContext context,
                                                            IVersion version)
                                                     throws DocumentModuleException
```
    Retrieves all the started task instances of a version.
    
    Parameters:
    
    context - The execution context.
    
    version - The IVersion object.
    
    Returns:
    
    a collection of ITaskInstance
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getEndedTaskInstances
```
Collection<? extends ITaskInstance> getEndedTaskInstances(IContext context,
                                                          IVersion version)
                                                   throws DocumentModuleException
```
    Retrieves all the ended task instances of a version.
    
    Parameters:
    
    context - The execution context.
    
    version - The IVersion object.
    
    Returns:
    
    a collection of ITaskInstance
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getAbortedTaskInstances
```
Collection<? extends ITaskInstance> getAbortedTaskInstances(IContext context,
                                                            IVersion version)
                                                     throws DocumentModuleException
```
    Retrieves all the aborted task instances of a version.
    
    Parameters:
    
    context - The execution context.
    
    instance - The IVersion object.
    
    Returns:
    
    a collection of ITaskInstance
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getTaskInstance
```
ITaskInstance getTaskInstance(IContext context,
                              IVersion version,
                              String name)
                       throws DocumentModuleException
```
    Gets a task instance associated with a specified task name.
    
    Parameters:
    
    context - The execution context.
    
    version - The IVersion object.
    
    name - The system name of a ITask object.
    
    Returns:
    
    a ITaskInstance object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getOneTaskInstance
```
ITaskInstance getOneTaskInstance(IContext context,
                                 IVersion version)
                          throws DocumentModuleException
```
    Gets one of the task instances (any).
    
    Parameters:
    
    context - The execution context.
    
    version - The IVersion object.
    
    Returns:
    
    a ITaskInstance object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getTask
```
ITask getTask(ITaskInstance instance)
       throws DocumentModuleException
```
    Gets the definition of a task instance.
    
    Parameters:
    
    instance - The ITaskInstance object.
    
    Returns:
    
    a ITask object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getOperators
```
Collection<? extends IOperator> getOperators(ITaskInstance instance)
                                      throws DocumentModuleException
```
    Retrieves the operators of a task instance.
    
    Parameters:
    
    instance - the ITaskInstance object.
    
    Returns:
    
    a collection of IOperator objects.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - end
```
void end(IContext context,
         ITaskInstance instance,
         IAction action,
         String comment)
  throws DocumentModuleException
```
    Crosses a transition.
    
    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:
    
    DocumentModuleException - default module exception.
  - end
```
void end(IContext context,
         IUser addressee,
         ITaskInstance instance,
         IAction action,
         String comment)
  throws DocumentModuleException
```
    Allows to cross a transition for another user.
    
    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:
    
    DocumentModuleException - default module exception.
  - send
```
void send(IContext context,
          ITaskInstance instance,
          IMailForm form,
          String comment)
   throws DocumentModuleException
```
    Sends a mail using a specified mail form.
    
    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:
    
    DocumentModuleException - default module exception.
  - send
```
void send(IContext context,
          IUser addressee,
          ITaskInstance instance,
          IMailForm form,
          String comment)
   throws DocumentModuleException
```
    Sends a mail using a specified mail form.
    
    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:
    
    DocumentModuleException - default module exception. default module exception.
  - evaluatedHtml
```
String evaluatedHtml(IResource resource,
                     IMailForm mailForm)
              throws DocumentModuleException
```
    Evaluates the form and returns the HTML content as a java.lang.String object.
    
    Parameters:
    
    resource - The IResource object to evaluate with.
    
    mailForm - The IMailForm object.
    
    Returns:
    
    A java.lang.String object.
    
    Throws:
    
    DocumentModuleException - default module exception. default module exception.
  - evaluatedHtml
```
String evaluatedHtml(ITaskInstance taskInstance,
                     IMailForm mailForm)
              throws DocumentModuleException
```
    Evaluates the form and returns the HTML content as a java.lang.String object.
    
    Parameters:
    
    taskInstance - The ITaskInstance object to evaluate with.
    
    mailForm - The IMailForm object.
    
    Returns:
    
    A java.lang.String object.
    
    Throws:
    
    DocumentModuleException - default module exception. default module exception.
  - send
```
void send(IContext context,
          IResource resource,
          IMailForm mailForm,
          Collection entries,
          String subject,
          String content)
   throws DocumentModuleException
```
    Sends a mail by specifying the subject and the content of the body.
    
    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:
    
    DocumentModuleException - default module exception. default module exception.
  - send
```
void send(IContext context,
          ITaskInstance taskInstance,
          IMailForm mailForm,
          Collection entries,
          String subject,
          String content)
   throws DocumentModuleException
```
    Sends a mail by specifying the subject and the content of the body.
    
    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:
    
    DocumentModuleException - default module exception. default module exception.
  - getForm
```
IForm getForm(IContext context,
              IWorkflow workflow,
              String formName)
       throws DocumentModuleException
```
    Gets a workflow form by its name.
    
    Parameters:
    
    context - The execution context.
    
    workflow - The IWorkflow object.
    
    formName - The name of the form.
    
    Returns:
    
    a IForm object.
    
    Throws:
    
    DocumentModuleException - default module exception. default module exception.
  - getForm
```
IForm getForm(IContext context,
              IResourceDefinition resourceDefinition,
              String formName)
       throws DocumentModuleException
```
    Gets a resource definition form by its name.
    
    Parameters:
    
    context - The execution context.
    
    resourceDefinition - The IResourceDefinition object.
    
    formName - The name of the form.
    
    Returns:
    
    a IForm object.
    
    Throws:
    
    DocumentModuleException - default module exception. default module exception.
  - getForm
```
IForm getForm(IContext context,
              ITask task,
              String formName)
       throws DocumentModuleException
```
    Gets a task form by its name.
    
    Parameters:
    
    context - The execution context.
    
    task - The ITask object.
    
    formName - The name of the form.
    
    Returns:
    
    a IForm object.
    
    Throws:
    
    DocumentModuleException - default module exception. default module exception.
  - getForm
```
IForm getForm(IContext context,
              IAction action,
              String formName)
       throws DocumentModuleException
```
    Gets a action form by its name.
    
    Parameters:
    
    context - The execution context.
    
    action - The IAction object.
    
    formName - The name of the form.
    
    Returns:
    
    a IForm object.
    
    Throws:
    
    DocumentModuleException - default module exception. default module exception.
  - getSubForm
```
IForm getSubForm(IContext context,
                 IWorkflow workflow,
                 String formName)
          throws DocumentModuleException
```
    Gets a sub form by its name.
    
    Parameters:
    
    context - The execution context.
    
    workflow - The IWorkflow object.
    
    formName - The name of the form.
    
    Returns:
    
    a IForm object.
    
    Throws:
    
    DocumentModuleException - default module exception. default module exception.
  - getMailForms
```
Collection<? extends IMailForm> getMailForms(IContext context,
                                             IWorkflow workflow)
                                      throws DocumentModuleException
```
    Gets all the mail forms from a specified IWorkflow object.
    
    Parameters:
    
    context - The execution context.
    
    workflow - The IWorkflow object.
    
    Returns:
    
    A collection of IMailForm objects.
    
    Throws:
    
    DocumentModuleException - default module exception. default module exception.
  - getMailForm
```
IMailForm getMailForm(IContext context,
                      IWorkflow workflow,
                      String mailFormName)
               throws DocumentModuleException
```
    Parameters:
    
    context - The execution context.
    
    workflow - The IWorkflow object.
    
    mailFormName - The name of the form.
    
    Returns:
    
    a IMailForm object.
    
    Throws:
    
    DocumentModuleException - default module exception. default module exception.
  - getMailForms
```
Collection<? extends IMailForm> getMailForms(IContext context,
                                             IWorkflow workflow,
                                             String startsWith)
                                      throws DocumentModuleException
```
    Parameters:
    
    context - The execution context.
    
    workflow - The IWorkflow object.
    
    startsWith - The start part of the form name.
    
    Returns:
    
    A collection of IMailForm objects.
    
    Throws:
    
    DocumentModuleException - default module exception. default module exception.
  - createGenericResource
```
IResource createGenericResource()
                         throws DocumentModuleException
```
    Creates a generic resource for mail purposes.
    
    Returns:
    
    The IResource object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getAttachments
```
Collection<? extends IAttachment> getAttachments(IResource resource,
                                                 String propertyName)
                                          throws DocumentModuleException
```
    Gets all the attachments associated with a property.
    
    Parameters:
    
    resource - The main resource object.
    
    propertyName - The system name of the property.
    
    Returns:
    
    A collection of IAttachment objects.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getAttachment
```
IAttachment getAttachment(IResource resource,
                          String propertyName,
                          String fileName)
                   throws DocumentModuleException
```
    Gets an attachment by its file name.
    
    Parameters:
    
    resource - The main resource object.
    
    propertyName - The system name of the property.
    
    fileName - The file name to retrieve.
    
    Returns:
    
    An IAttachment object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - addAttachment
```
IAttachment addAttachment(IResource resource,
                          String propertyName,
                          File file)
                   throws DocumentModuleException
```
    Adds an attachment as a java.io.File object.
    
    Parameters:
    
    resource - The main resource object.
    
    propertyName - The system name of the property.
    
    file - The File object.
    
    Returns:
    
    An IAttachment object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - addAttachment
```
IAttachment addAttachment(IResource resource,
                          String propertyName,
                          String fileName,
                          InputStream inputStream)
                   throws DocumentModuleException
```
    Adds an attachment as an java.io.InputStream object.
    
    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:
    
    DocumentModuleException - default module exception.
  - addAttachment
```
IAttachment addAttachment(IResource resource,
                          String propertyName,
                          String fileName,
                          String fullPath)
                   throws DocumentModuleException
```
    Adds an attachment with its full path.
    
    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:
    
    DocumentModuleException - default module exception.
  - addAttachment
```
IAttachment addAttachment(IResource resource,
                          String propertyName,
                          IAttachment attachment)
                   throws DocumentModuleException
```
    Adds an attachment from an attachment.
    
    Parameters:
    
    resource - The main resource object.
    
    propertyName - The system name of the property.
    
    attachment - The IAttachment to add.
    
    Returns:
    
    An IAttachment object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getExternalUser
```
IUser getExternalUser(IResource resource,
                      String propertyName)
               throws DocumentModuleException
```
    Gets a IUser object from a single user selector property.
    
    Parameters:
    
    resource - The main resource object.
    
    propertyName - The system name of the property.
    
    Returns:
    
    A IUser object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getExternalGroup
```
IGroup getExternalGroup(IResource resource,
                        String propertyName)
                 throws DocumentModuleException
```
    Gets a IGroup object from a single group selector property.
    
    Parameters:
    
    resource - The main resource object.
    
    propertyName - The system name of the property.
    
    Returns:
    
    A IGroup object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getExternalLocalization
```
ILocalization getExternalLocalization(IResource resource,
                                      String propertyName)
                               throws DocumentModuleException
```
    Gets a ILocalization object from a single localization selector property.
    
    Parameters:
    
    resource - The main resource object.
    
    propertyName - The system name of the property.
    
    Returns:
    
    A ILocalization object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getExternalOrganization
```
IOrganization getExternalOrganization(IResource resource,
                                      String propertyName)
                               throws DocumentModuleException
```
    Gets a IOrganization object from a single organization selector property.
    
    Parameters:
    
    resource - The main resource object.
    
    propertyName - The system name of the property.
    
    Returns:
    
    A IOrganization object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getExternalFile
```
IFile getExternalFile(IResource resource,
                      String propertyName)
               throws DocumentModuleException
```
    Gets a IFile object from a single file selector property.
    
    Parameters:
    
    resource - The main resource object.
    
    propertyName - The system name of the property.
    
    Returns:
    
    A IFile object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getExternalFolder
```
IFolder getExternalFolder(IResource resource,
                          String propertyName)
                   throws DocumentModuleException
```
    Gets a IFolder object from a single folder selector property.
    
    Parameters:
    
    resource - The main resource object.
    
    propertyName - The system name of the property.
    
    Returns:
    
    A IFolder object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getExternalLibrary
```
ILibrary getExternalLibrary(IResource resource,
                            String propertyName)
                     throws DocumentModuleException
```
    Gets a ILibrary object from a single library selector property.
    
    Parameters:
    
    resource - The main resource object.
    
    propertyName - The system name of the property.
    
    Returns:
    
    A ILibrary object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getExternalElements
```
Collection getExternalElements(IResource resource,
                               String propertyName)
                        throws DocumentModuleException
```
    Gets a collection of IElement objects from a multiple selector property.
    
    Parameters:
    
    resource - The main resource object.
    
    propertyName - The system name of the property.
    
    Returns:
    
    A collection of IElement objects.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - setExternalUser
```
void setExternalUser(IResource resource,
                     String propertyName,
                     IUser user)
              throws DocumentModuleException
```
    Sets a IUser to a single selector property.
    
    Parameters:
    
    resource - The main resource object.
    
    propertyName - The system name of the property.
    
    user - A IUser object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - setExternalGroup
```
void setExternalGroup(IResource resource,
                      String propertyName,
                      IGroup group)
               throws DocumentModuleException
```
    Sets a IGroup to a single selector property.
    
    Parameters:
    
    resource - The main resource object.
    
    propertyName - The system name of the property.
    
    group - A IGroup object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - setExternalLocalization
```
void setExternalLocalization(IResource resource,
                             String propertyName,
                             ILocalization localization)
                      throws DocumentModuleException
```
    Sets a ILocalization to a single selector property.
    
    Parameters:
    
    resource - The main resource object.
    
    propertyName - The system name of the property.
    
    localization - A ILocalization object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - setExternalOrganization
```
void setExternalOrganization(IResource resource,
                             String propertyName,
                             IOrganization organization)
                      throws DocumentModuleException
```
    Sets a IOrganization to a single selector property.
    
    Parameters:
    
    resource - The main resource object.
    
    propertyName - The system name of the property.
    
    organization - A IOrganization object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - setExternalFile
```
void setExternalFile(IResource resource,
                     String propertyName,
                     IFile file)
              throws DocumentModuleException
```
    Sets a IFile to a single selector property.
    
    Parameters:
    
    resource - The main resource object.
    
    propertyName - The system name of the property.
    
    file - A IFile object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - setExternalFolder
```
void setExternalFolder(IResource resource,
                       String propertyName,
                       IFolder folder)
                throws DocumentModuleException
```
    Sets a IFolder to a single selector property.
    
    Parameters:
    
    resource - The main resource object.
    
    propertyName - The system name of the property.
    
    folder - A IFolder object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - setExternalLibrary
```
void setExternalLibrary(IResource resource,
                        String propertyName,
                        ILibrary library)
                 throws DocumentModuleException
```
    Sets a ILibrary to a single selector property.
    
    Parameters:
    
    resource - The main resource object.
    
    propertyName - The system name of the property.
    
    library - A ILibrary object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - setExternalElements
```
void setExternalElements(IResource resource,
                         String propertyName,
                         Collection elements)
                  throws DocumentModuleException
```
    Sets a IElement to a multiple selector property.
    
    Parameters:
    
    resource - The main resource object.
    
    propertyName - The system name of the property.
    
    elements - A collection of IElement objects.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getSearchController
```
ISearchController getSearchController()
                               throws DocumentModuleException
```
    Gets the default ISearchController object.
    
    Returns:
    
    The default ISearchController object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getSearchController
```
@Deprecated
ISearchController getSearchController(IJdbcReference reference)
                                           throws DocumentModuleException
```
    Deprecated. : use getSearchController ( IConnectionDefinition connectionDefinition) method instead.
    
    Gets a search controller object by specifying a JDBC external reference.
    
    Parameters:
    
    reference - The IJdbcReference object.
    
    Returns:
    
    The ISearchController object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getSearchController
```
ISearchController getSearchController(IConnectionDefinition connectionDefinition)
                               throws DocumentModuleException
```
    Gets a connection from its name.
    
    Parameters:
    
    connectionDefinition - The IConnectionDefinition object.
    
    Returns:
    
    a IConnectionDefinition object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getSearchController
```
ISearchController getSearchController(IDataSourceReference reference)
                               throws DocumentModuleException
```
    Gets a search controller object by specifying an external data source.
    
    Parameters:
    
    reference - The IDataSourceReference object.
    
    Returns:
    
    The ISearchController object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getSecurityController
```
ISecurityController getSecurityController(ISecuritySupport securitySupport)
                                   throws DocumentModuleException
```
    Gets a security controller on a specified object.
    
    Parameters:
    
    securitySupport - Any IElement that implements ISecuritySupport interface.
    
    Returns:
    
    The ISecurityController object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getTransformer
```
ITransformer getTransformer()
                     throws DocumentModuleException
```
    Gets a transformer to transform IResource object.
    
    Returns:
    
    A ITransformer object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getTaskInstanceTransformer
```
ITaskInstanceTransformer getTaskInstanceTransformer()
                                             throws DocumentModuleException
```
    Gets a task transformer to transform ITaskInstance object.
    
    Returns:
    
    A ITaskInstanceTransformer object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getTaskViewTransformer
```
ITaskViewTransformer getTaskViewTransformer()
                                     throws DocumentModuleException
```
    Gets a task view transformer to transform ITaskInstance objects.
    
    Returns:
    
    A ITaskViewTransformer object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getResourceViewTransformer
```
IResourceViewTransformer getResourceViewTransformer()
                                             throws DocumentModuleException
```
    Gets a resource view transformer to transform IResource objects.
    
    Returns:
    
    A IResourceViewTransformer object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getWorkflowViewTransformer
```
IWorkflowViewTransformer getWorkflowViewTransformer()
                                             throws DocumentModuleException
```
    Gets a workflow view transformer to transform IWorkflow objects.
    
    Returns:
    
    A IWorkflowViewTransformer object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getWorkflowContainerViewTransformer
```
IWorkflowContainerViewTransformer getWorkflowContainerViewTransformer()
                                                               throws DocumentModuleException
```
    Gets a workflow container view transformer to transform IWorkflowContainer objects.
    
    Returns:
    
    A IWorkflowContainerViewTransformer object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getCatalogViewTransformer
```
ICatalogViewTransformer getCatalogViewTransformer()
                                           throws DocumentModuleException
```
    Gets a catalog view transformer to transform ICatalog objects.
    
    Returns:
    
    A ICatalogViewTransformer object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getSearchViewTransformer
```
ISearchViewTransformer getSearchViewTransformer()
                                         throws DocumentModuleException
```
    Gets a search view transformer to transform IResource objects.
    
    Returns:
    
    A ISearchViewTransformer object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getGenericViewTransformer
```
IGenericViewTransformer getGenericViewTransformer()
                                           throws DocumentModuleException
```
    Throws:
    
    DocumentModuleException
  - getViewController
```
IViewController getViewController()
                           throws DocumentModuleException
```
    Gets a view controller to search IResource objects through their properties.
    
    Returns:
    
    A IViewController object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getViewController
```
IViewController getViewController(Class natureClass)
                           throws DocumentModuleException
```
    Gets a view controller to search IResource objects through their properties.
    
    Parameters:
    
    natureClass - : The class of the searched objects IVersion
    
    Returns:
    
    A IViewController object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getViewController
```
IViewController getViewController(InputStream inputStream)
                           throws DocumentModuleException
```
    Gets a view controller to search IResource objects through their properties.
    
    Parameters:
    
    inputStream - The java.io.InputStream XML entry.
    
    Returns:
    
    A IViewController object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getViewController
```
IViewController getViewController(IContext context,
                                  InputStream inputStream)
                           throws DocumentModuleException
```
    Gets a view controller to search IResource objects through their properties.
    
    Parameters:
    
    context - The execution context.
    
    inputStream - The java.io.InputStream XML entry.
    
    Returns:
    
    A IViewController object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getDelegationController
```
IDelegationController getDelegationController()
                                       throws DocumentModuleException
```
    Gets a delegation controller to delegate IDelegationSupport objects.
    
    Returns:
    
    A IDelegationController object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getArchivingController
```
IArchivingController getArchivingController()
                                     throws DocumentModuleException
```
    Gets a archiving controller to archive IElement objects.
    
    Returns:
    
    A IArchivingController object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getUserByLogin
```
IUser getUserByLogin(String login)
              throws DocumentModuleException
```
    Gets a user by its login
    
    Parameters:
    
    login - The login of the user
    
    Returns:
    
    A IUser object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getCatalog
```
ICatalog getCatalog(IStorageKey key)
             throws DocumentModuleException
```
    Gets a catalog object from its identifier.
    
    Parameters:
    
    key - A IStorageKey object.
    
    Returns:
    
    A ICatalog object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getUser
```
IUser getUser(IStorageKey key)
       throws DocumentModuleException
```
    Gets a user object from its identifier.
    
    Parameters:
    
    key - A IStorageKey object.
    
    Returns:
    
    A IUser object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getRole
```
IRole getRole(IStorageKey key)
       throws DocumentModuleException
```
    Gets a role object from its identifier.
    
    Parameters:
    
    key - A IStorageKey object.
    
    Returns:
    
    A IRole object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getWorkflow
```
IWorkflow getWorkflow(IStorageKey key)
               throws DocumentModuleException
```
    Gets a workflow object from its identifier.
    
    Parameters:
    
    key - A IStorageKey object.
    
    Returns:
    
    A IWorkflow object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getTask
```
ITask getTask(IStorageKey key)
       throws DocumentModuleException
```
    Gets a task object from its identifier.
    
    Parameters:
    
    key - A IStorageKey object.
    
    Returns:
    
    A ITask object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getAction
```
IAction getAction(IStorageKey key)
           throws DocumentModuleException
```
    Gets an action object from its identifier.
    
    Parameters:
    
    key - A IStorageKey object.
    
    Returns:
    
    A IAction object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getResourceDefinition
```
IResourceDefinition getResourceDefinition(IStorageKey key)
                                   throws DocumentModuleException
```
    Gets a resource definition object from its identifier.
    
    Parameters:
    
    key - A IStorageKey object.
    
    Returns:
    
    A IResourceDefinition object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getProperty
```
IProperty getProperty(IStorageKey key)
               throws DocumentModuleException
```
    Gets a property object from its identifier.
    
    Parameters:
    
    key - A IStorageKey object.
    
    Returns:
    
    A IProperty object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getVersion
```
IVersion getVersion(IStorageKey key)
             throws DocumentModuleException
```
    Gets a version object from its identifier.
    
    Parameters:
    
    key - A IStorageKey object.
    
    Returns:
    
    A IVersion object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getTaskInstance
```
ITaskInstance getTaskInstance(IStorageKey key)
                       throws DocumentModuleException
```
    Gets a task instance object from its identifier.
    
    Parameters:
    
    key - A IStorageKey object.
    
    Returns:
    
    A ITaskInstance object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getOperator
```
IOperator getOperator(IStorageKey key)
               throws DocumentModuleException
```
    Gets a operator object from its identifier.
    
    Parameters:
    
    key - A IStorageKey object.
    
    Returns:
    
    A IOperator object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getResource
```
IResource getResource(IStorageKey key)
               throws DocumentModuleException
```
    Gets a resource object from its identifier.
    
    Parameters:
    
    key - A IStorageKey object.
    
    Returns:
    
    A IResource object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getCatalog
```
ICatalog getCatalog(IResourceDefinition resourceDefinition)
             throws DocumentModuleException
```
    Gets a ICatalog object from a resource definitino.
    
    Parameters:
    
    resourceDefinition - A resource definition.
    
    Returns:
    
    A ICatalog object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getResources
```
Collection<? extends IResource> getResources(IContext context,
                                             IResourceDefinition resourceDefinition)
                                      throws DocumentModuleException
```
    Gets a collection of IResource objects from a resource definition.
    
    Parameters:
    
    context - The execution context.
    
    resourceDefinition - The IResourceDefinition object.
    
    Returns:
    
    a Collection of IResources object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getResources
```
Collection<? extends IResource> getResources(IContext context,
                                             ICatalog catalog)
                                      throws DocumentModuleException
```
    Gets a collection of IResource objects from a catalog
    
    Parameters:
    
    context - The execution context.
    
    catalog - The ICatalog object.
    
    Returns:
    
    a Collection of IResources object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - createDataUnit
```
IDataUnit createDataUnit(IContext context,
                         IResourceDefinition resourceDefinition,
                         String reference,
                         String label)
                  throws DocumentModuleException
```
    Creates a data unit object by specifying the IResourceDefinition object, its reference, and its label.
    
    Parameters:
    
    context - The execution context.
    
    resourceDefinition - The IResourceDefinition object.
    
    reference - The reference to set.
    
    label - The label to set.
    
    Returns:
    
    a IDataUnit object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - createDataUnit
```
IDataUnit createDataUnit(IContext context,
                         IResourceDefinition resourceDefinition,
                         String reference)
                  throws DocumentModuleException
```
    Creates a storage resource object by specifying the IResourceDefinition object, its reference.
    
    Parameters:
    
    context - The execution context.
    
    resourceDefinition - The IResourceDefinition object.
    
    reference - The reference to set.
    
    Returns:
    
    a IDataUnit object.
    
    Throws:
    
    DocumentModuleException - default module exception.
  - getElementByProtocolURI
```
IProtocolSupport getElementByProtocolURI(String protocolURI)
                                  throws ModuleException
```
    Gets an IElement object which implements IProtocolSupport interface.
    
    Parameters:
    
    protocolURI - The protocol URI as a java.lang.String.
    
    Returns:
    
    A IProtocolSupport object.
    
    Throws:
    
    ModuleException - default module exception.

Interface IBaseDocumentModule

Method Summary

Methods inherited from interface com.axemble.vdoc.sdk.modules.IModule

Method Detail

getConfiguration

getAgent

execute

execute

getDataSourceReference

getJdbcReference

getConnectionDefinition

getJdbcReferences

getConnectionDefinitions

getList

getLists

createCatalog

getCatalog

getCatalogs

getCatalogs

getCatalogs

createRole

getRole

getRoles

isMemberOf

addChild

addMember

createWorkflowContainer

getWorkflowContainer

getWorkflowContainers

createWorkflow

getWorkflow

getWorkflows

getWorkflows

getCatalog

getWorkflowContainer

getTask

getActions

getAction

getWorkflow

getResourceDefinition

getResourceDefinitions

getView

getProperties

getProperty

generateReference

generateReference

generateReference

generateReference

generateChrono

createVersion

createVersion

getVersions

getVersions

getVersions

getVersions

getVersions

setValue

getValue

setList

getList

abort

remind

remind

send

send

send

getTaskInstances

getTaskInstances

getManualTaskInstances

getStartedTaskInstances

getEndedTaskInstances

getAbortedTaskInstances

getTaskInstance

getOneTaskInstance

getTask

getOperators

end

end

send

send