Uses of Class
com.axemble.vdoc.sdk.exceptions.DocumentModuleException
-
Uses of DocumentModuleException in com.axemble.vdoc.sdk.modules
Modifier and TypeMethodDescriptionvoid
Allows to abort workflow instance.IBaseDocumentModule.addAttachment
(IResource resource, String propertyName, IAttachment attachment) Adds an attachment from an attachment.IBaseDocumentModule.addAttachment
(IResource resource, String propertyName, File file) Adds an attachment as a java.io.File object.IBaseDocumentModule.addAttachment
(IResource resource, String propertyName, String fileName, InputStream inputStream) Adds an attachment as an java.io.InputStream object.IBaseDocumentModule.addAttachment
(IResource resource, String propertyName, String fileName, String fullPath) Adds an attachment with its full path.void
Adds a group to a role.void
Adds a user to a role.IBaseDocumentModule.createCatalog
(IContext context, String name, String label, IProject project) Allows to create a new catalog.IBaseDocumentModule.createDataUnit
(IContext context, IResourceDefinition resourceDefinition, String reference) Creates a storage resource object by specifying theIResourceDefinition
object, its reference.IBaseDocumentModule.createDataUnit
(IContext context, IResourceDefinition resourceDefinition, String reference, String label) Creates a data unit object by specifying theIResourceDefinition
object, its reference, and its label.IBaseDocumentModule.createGenericResource()
Creates a generic resource for mail purposes.IBaseDocumentModule.createRole
(IContext context, ICatalog catalog, String name) Creates aIRole
into the catalog object.IBaseDocumentModule.createVersion
(IContext context, IAttachmentTemplate attachmentTemplate, String reference) Creates a version instance object by specifying theIAttachmentTemplate
object, its reference.IBaseDocumentModule.createVersion
(IContext context, IResourceDefinition resourceDefinition, String reference, String label) Creates a version object by specifying theIResourceDefinition
object, its reference, and its label.IBaseDocumentModule.createWorkflow
(IContext context, IWorkflowContainer container, String name, byte[] content) Creates a workflow within a workflow container.IBaseDocumentModule.createWorkflowContainer
(IContext context, ICatalog catalog, String name) Creates a workflow container within aICatalog
object.void
IBaseDocumentModule.end
(IContext context, ITaskInstance instance, IAction action, String comment) Crosses a transition.void
IBaseDocumentModule.end
(IContext context, IUser addressee, ITaskInstance instance, IAction action, String comment) Allows to cross a transition for another user.IBaseDocumentModule.evaluatedHtml
(IResource resource, IMailForm mailForm) Evaluates the form and returns the HTML content as a java.lang.String object.IBaseDocumentModule.evaluatedHtml
(ITaskInstance taskInstance, IMailForm mailForm) Evaluates the form and returns the HTML content as a java.lang.String object.void
Allows to execute an agent.void
Allows to execute an agent.int
IBaseDocumentModule.generateChrono
(IResourceDefinition resourceDefinition) Evaluate the next chrono based on the format specified on the Designer tool.IBaseDocumentModule.generateReference
(IResource resource) Evaluate the next reference based on the format specified on the Designer tool.IBaseDocumentModule.generateReference
(IResourceDefinition resourceDefinition) Evaluate the next reference based on the format specified on the Designer tool.IBaseDocumentModule.generateReference
(IResourceDefinition resourceDefinition, String format) Evaluate the next reference based on the passed format.IBaseDocumentModule.generateReference
(IResource resource, String format) Evaluate the next reference based on the specified format.Collection
<? extends ITaskInstance> IBaseDocumentModule.getAbortedTaskInstances
(IContext context, IVersion version) Retrieves all the aborted task instances of a version.Retrieve a specificIAction
object from its system name.IBaseDocumentModule.getAction
(IStorageKey key) Gets an action object from its identifier.Collection
<? extends IAction> IBaseDocumentModule.getActions
(IContext context, ITask task) Gets an agent from its name.IBaseDocumentModule.getArchivingController()
Gets a archiving controller to archiveIElement
objects.IBaseDocumentModule.getAttachment
(IResource resource, String propertyName, String fileName) Gets an attachment by its file name.Collection
<? extends IAttachment> IBaseDocumentModule.getAttachments
(IResource resource, String propertyName) Gets all the attachments associated with a property.IBaseDocumentModule.getCatalog
(IContext context, String name, int catalogType, IProject project) Retrieves a catalog form its name.IBaseDocumentModule.getCatalog
(IResourceDefinition resourceDefinition) Gets aICatalog
object from a resource definitino.IBaseDocumentModule.getCatalog
(IStorageKey key) Gets a catalog object from its identifier.IBaseDocumentModule.getCatalog
(IWorkflow workflow) Retrieves the catalog of aIWorkflow
object.Collection
<? extends ICatalog> IBaseDocumentModule.getCatalogs
(IContext context) Retrieves a collection ofICatalog
object.Collection
<? extends ICatalog> IBaseDocumentModule.getCatalogs
(IContext context, int catalogType) Retrieves a collection ofICatalog
object.Collection
<? extends ICatalog> IBaseDocumentModule.getCatalogs
(IContext context, IProject project) Retrieves a collection ofICatalog
object.IBaseDocumentModule.getCatalogViewTransformer()
Gets a catalog view transformer to transformICatalog
objects.IBaseDocumentModule.getConnectionDefinition
(IContext context, String name) Gets a connection from its name.Collection
<? extends IConnectionDefinition> IBaseDocumentModule.getConnectionDefinitions
(IContext context) Gets a collection of connections.IBaseDocumentModule.getDataSourceReference
(String name) Gets a data source reference from its JNDI name.IBaseDocumentModule.getDelegationController()
Gets a delegation controller to delegateIDelegationSupport
objects.Collection
<? extends ITaskInstance> IBaseDocumentModule.getEndedTaskInstances
(IContext context, IVersion version) Retrieves all the ended task instances of a version.IBaseDocumentModule.getExternalElements
(IResource resource, String propertyName) Gets a collection ofIElement
objects from a multiple selector property.IBaseDocumentModule.getExternalFile
(IResource resource, String propertyName) Gets aIFile
object from a single file selector property.IBaseDocumentModule.getExternalFolder
(IResource resource, String propertyName) Gets aIFolder
object from a single folder selector property.IBaseDocumentModule.getExternalGroup
(IResource resource, String propertyName) Gets aIGroup
object from a single group selector property.IBaseDocumentModule.getExternalLibrary
(IResource resource, String propertyName) Gets aILibrary
object from a single library selector property.IBaseDocumentModule.getExternalLocalization
(IResource resource, String propertyName) Gets aILocalization
object from a single localization selector property.IBaseDocumentModule.getExternalOrganization
(IResource resource, String propertyName) Gets aIOrganization
object from a single organization selector property.IBaseDocumentModule.getExternalUser
(IResource resource, String propertyName) Gets aIUser
object from a single user selector property.Gets a action form by its name.IBaseDocumentModule.getForm
(IContext context, IResourceDefinition resourceDefinition, String formName) Gets a resource definition form by its name.Gets a task form by its name.Gets a workflow form by its name.IBaseDocumentModule.getGenericViewTransformer()
IBaseDocumentModule.getJdbcReference
(IContext context, String name) Deprecated.: use getConnectionDefinition( IContext context, String name ) method instead.Collection
<? extends IJdbcReference> IBaseDocumentModule.getJdbcReferences
(IContext context) Deprecated.: use getConnectionDefinitions( IContext context ) method instead.Gets a list object from a catalog by its name.Gets the available values of a list property.Collection
<? extends IList> Gets a collection of a the lists available on a specifiedICatalog
object.IBaseDocumentModule.getMailForm
(IContext context, IWorkflow workflow, String mailFormName) Collection
<? extends IMailForm> IBaseDocumentModule.getMailForms
(IContext context, IWorkflow workflow) Gets all the mail forms from a specifiedIWorkflow
object.Collection
<? extends IMailForm> IBaseDocumentModule.getMailForms
(IContext context, IWorkflow workflow, String startsWith) Collection
<? extends ITaskInstance> IBaseDocumentModule.getManualTaskInstances
(IContext context, IVersion version) Retrieves all the manual task instances of a workflow instance.IBaseDocumentModule.getOneTaskInstance
(IContext context, IVersion version) Gets one of the task instances (any).IBaseDocumentModule.getOperator
(IStorageKey key) Gets a operator object from its identifier.Collection
<? extends IOperator> IBaseDocumentModule.getOperators
(ITaskInstance instance) Retrieves the operators of a task instance.Collection
<? extends IProperty> IBaseDocumentModule.getProperties
(IContext context, IResourceDefinition resourceDefinition) Gets all the properties of a specified definition.IBaseDocumentModule.getProperty
(IContext context, IResourceDefinition resourceDefinition, String name) Gets a property definition by specifying theIResourceDefinition
and its system name.IBaseDocumentModule.getProperty
(IStorageKey key) Gets a property object from its identifier.IBaseDocumentModule.getResource
(IStorageKey key) Gets a resource object from its identifier.IBaseDocumentModule.getResourceDefinition
(IContext context, ICatalog catalog, String name) Retrieves a resource definition by specifying theICatalog
and its system name.IBaseDocumentModule.getResourceDefinition
(IStorageKey key) Gets a resource definition object from its identifier.Collection
<? extends IResourceDefinition> IBaseDocumentModule.getResourceDefinitions
(IContext context, ICatalog catalog) Retrieves all resource definitions by specifying theICatalog
Collection
<? extends IResource> IBaseDocumentModule.getResources
(IContext context, ICatalog catalog) Gets a collection ofIResource
objects from a catalogCollection
<? extends IResource> IBaseDocumentModule.getResources
(IContext context, IResourceDefinition resourceDefinition) Gets a collection ofIResource
objects from a resource definition.IBaseDocumentModule.getResourceViewTransformer()
Gets a resource view transformer to transformIResource
objects.Retrieves aIRole
object by its system name.IBaseDocumentModule.getRole
(IStorageKey key) Gets a role object from its identifier.Collection
<? extends IRole> Retrieves a collection ofIRole
objects within a specified catalog.IBaseDocumentModule.getSearchController()
Gets the defaultISearchController
object.IBaseDocumentModule.getSearchController
(IConnectionDefinition connectionDefinition) Gets a connection from its name.IBaseDocumentModule.getSearchController
(IDataSourceReference reference) Gets a search controller object by specifying an external data source.IBaseDocumentModule.getSearchController
(IJdbcReference reference) Deprecated.: use getSearchController ( IConnectionDefinition connectionDefinition) method instead.IBaseDocumentModule.getSearchViewTransformer()
Gets a search view transformer to transformIResource
objects.IBaseDocumentModule.getSecurityController
(ISecuritySupport securitySupport) Gets a security controller on a specified object.Collection
<? extends ITaskInstance> IBaseDocumentModule.getStartedTaskInstances
(IContext context, IVersion version) Retrieves all the started task instances of a version.IBaseDocumentModule.getSubForm
(IContext context, IWorkflow workflow, String formName) Gets a sub form by its name.Retrieves a specific task of aIWorkflow
object by its name.IBaseDocumentModule.getTask
(IStorageKey key) Gets a task object from its identifier.IBaseDocumentModule.getTask
(ITaskInstance instance) Gets the definition of a task instance.IBaseDocumentModule.getTaskInstance
(IContext context, IVersion version, String name) Gets a task instance associated with a specified task name.IBaseDocumentModule.getTaskInstance
(IStorageKey key) Gets a task instance object from its identifier.Collection
<? extends ITaskInstance> IBaseDocumentModule.getTaskInstances
(IContext context, IVersion version) Retrieves all the task instances of a specified version.Collection
<? extends ITaskInstance> IBaseDocumentModule.getTaskInstances
(IContext context, IVersion version, String name) Retrieves all the task instances of a specified version filtered by the name of aITask
.IBaseDocumentModule.getTaskInstanceTransformer()
Gets a task transformer to transformITaskInstance
object.IBaseDocumentModule.getTaskViewTransformer()
Gets a task view transformer to transformITaskInstance
objects.IBaseDocumentModule.getTransformer()
Gets a transformer to transformIResource
object.IBaseDocumentModule.getUser
(IStorageKey key) Gets a user object from its identifier.IBaseDocumentModule.getUserByLogin
(String login) Gets a user by its loginGets the value of a property.IBaseDocumentModule.getVersion
(IStorageKey key) Gets a version object from its identifier.Collection
<? extends IVersion> IBaseDocumentModule.getVersions
(IContext context, ICatalog catalog) Gets all the versions of a specifiedICatalog
object.Collection
<? extends IVersion> IBaseDocumentModule.getVersions
(IContext context, ICatalog catalog, String reference) Gets all the versions with the same reference within a specifiedICatalog
object.Collection
<? extends IVersion> IBaseDocumentModule.getVersions
(IContext context, IResourceDefinition resourceDefinition, String reference) Gets all the versions with the same reference within a specifiedIWorkflow
object.IBaseDocumentModule.getVersions
(IContext context, ITask task) Gets all the workflow instances of a specifiedITask
object.Collection
<? extends IVersion> IBaseDocumentModule.getVersions
(IContext context, IWorkflow workflow) Gets all the versions of a specifiedIWorkflow
object.IBaseDocumentModule.getView
(IContext context, IResourceDefinition resourceDefinition, String viewName) Retrieves a view by its name.IBaseDocumentModule.getViewController()
Gets a view controller to searchIResource
objects through their properties.IBaseDocumentModule.getViewController
(IContext context, InputStream inputStream) Gets a view controller to searchIResource
objects through their properties.IBaseDocumentModule.getViewController
(InputStream inputStream) Gets a view controller to searchIResource
objects through their properties.IBaseDocumentModule.getViewController
(Class natureClass) Gets a view controller to searchIResource
objects through their properties.IBaseDocumentModule.getWorkflow
(IContext context, ICatalog catalog, String name) Retrieves a workflow within aIWorkflow
object and from its system name.IBaseDocumentModule.getWorkflow
(IStorageKey key) Gets a workflow object from its identifier.IBaseDocumentModule.getWorkflow
(ITask task) Gets the associated workflow of a task.IBaseDocumentModule.getWorkflowContainer
(IContext context, ICatalog catalog, String name) Retrieves aIWorkflowContainer
within aICatalog
by its system nameIBaseDocumentModule.getWorkflowContainer
(IWorkflow workflow) Retrieves the workflow container of aIWorkflow
object.Collection
<? extends IWorkflowContainer> IBaseDocumentModule.getWorkflowContainers
(IContext context, ICatalog catalog) Retrieves a collection ofIWorkflowContainer
objects within aICatalog
object.IBaseDocumentModule.getWorkflowContainerViewTransformer()
Gets a workflow container view transformer to transformIWorkflowContainer
objects.Collection
<? extends IWorkflow> IBaseDocumentModule.getWorkflows
(IContext context, ICatalog catalog) Collection
<? extends IWorkflow> IBaseDocumentModule.getWorkflows
(IContext context, IWorkflowContainer container) Retrieves a collection ofIWorkflow
objects within aIWorkflowContainer
object.IBaseDocumentModule.getWorkflowViewTransformer()
Gets a workflow view transformer to transformIWorkflow
objects.boolean
IBaseDocumentModule.isMemberOf
(IUser user, IRole role) Checks if a specified user is member of aIRole
object.void
IBaseDocumentModule.remind
(IContext context, ITaskInstance taskInstance, String comment) Allows to remind current operators of a specified task instance.void
Allows to remind current operators of a version.void
IBaseDocumentModule.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
IBaseDocumentModule.send
(IContext context, ITaskInstance instance, IMailForm form, String comment) Sends a mail using a specified mail form.void
IBaseDocumentModule.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
IBaseDocumentModule.send
(IContext context, IUser addressee, ITaskInstance instance, IMailForm form, String comment) Sends a mail using a specified mail form.void
IBaseDocumentModule.send
(IContext context, IVersion version, String formName, Collection entries) Allows to send a mail with a specific form to a mail recipient.void
IBaseDocumentModule.send
(IContext context, IWorkflow workflow, IResource resource, String formName, Collection entries) Allows to send a mail.void
IBaseDocumentModule.send
(IContext context, IWorkflow workflow, String formName, Collection entries) Allows to send a mail.void
IBaseDocumentModule.setExternalElements
(IResource resource, String propertyName, Collection elements) Sets aIElement
to a multiple selector property.void
IBaseDocumentModule.setExternalFile
(IResource resource, String propertyName, IFile file) Sets aIFile
to a single selector property.void
IBaseDocumentModule.setExternalFolder
(IResource resource, String propertyName, IFolder folder) Sets aIFolder
to a single selector property.void
IBaseDocumentModule.setExternalGroup
(IResource resource, String propertyName, IGroup group) Sets aIGroup
to a single selector property.void
IBaseDocumentModule.setExternalLibrary
(IResource resource, String propertyName, ILibrary library) Sets aILibrary
to a single selector property.void
IBaseDocumentModule.setExternalLocalization
(IResource resource, String propertyName, ILocalization localization) Sets aILocalization
to a single selector property.void
IBaseDocumentModule.setExternalOrganization
(IResource resource, String propertyName, IOrganization organization) Sets aIOrganization
to a single selector property.void
IBaseDocumentModule.setExternalUser
(IResource resource, String propertyName, IUser user) Sets aIUser
to a single selector property.void
IBaseDocumentModule.setList
(IResource resource, String propertyName, Collection values) Sets the list of available values to a list property.void
Sets a value to a property.