| Package | Description |
|---|---|
| com.axemble.vdoc.sdk.modules |
| Modifier and Type | Method and Description |
|---|---|
void |
IBaseDocumentModule.abort(IContext context,
IVersion version,
String comment)
Allows to abort workflow instance.
|
IAttachment |
IBaseDocumentModule.addAttachment(IResource resource,
String propertyName,
File file)
Adds an attachment as a java.io.File object.
|
IAttachment |
IBaseDocumentModule.addAttachment(IResource resource,
String propertyName,
IAttachment attachment)
Adds an attachment from an attachment.
|
IAttachment |
IBaseDocumentModule.addAttachment(IResource resource,
String propertyName,
String fileName,
InputStream inputStream)
Adds an attachment as an java.io.InputStream object.
|
IAttachment |
IBaseDocumentModule.addAttachment(IResource resource,
String propertyName,
String fileName,
String fullPath)
Adds an attachment with its full path.
|
void |
IBaseDocumentModule.addChild(IGroup group,
IRole role)
Adds a group to a role.
|
void |
IBaseDocumentModule.addMember(IUser user,
IRole role)
Adds a user to a role.
|
ICatalog |
IBaseDocumentModule.createCatalog(IContext context,
String name,
String label,
IProject project)
Allows to create a new catalog.
|
IDataUnit |
IBaseDocumentModule.createDataUnit(IContext context,
IResourceDefinition resourceDefinition,
String reference)
Creates a storage resource object by specifying the
IResourceDefinition object, its reference. |
IDataUnit |
IBaseDocumentModule.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 |
IBaseDocumentModule.createGenericResource()
Creates a generic resource for mail purposes.
|
IRole |
IBaseDocumentModule.createRole(IContext context,
ICatalog catalog,
String name)
Creates a
IRole into the catalog object. |
IVersion |
IBaseDocumentModule.createVersion(IContext context,
IAttachmentTemplate attachmentTemplate,
String reference)
Creates a version instance object by specifying the
IAttachmentTemplate object, its reference. |
IVersion |
IBaseDocumentModule.createVersion(IContext context,
IResourceDefinition resourceDefinition,
String reference,
String label)
Creates a version object by specifying the
IResourceDefinition object, its reference, and its label. |
IWorkflow |
IBaseDocumentModule.createWorkflow(IContext context,
IWorkflowContainer container,
String name,
byte[] content)
Creates a workflow within a workflow container.
|
IWorkflowContainer |
IBaseDocumentModule.createWorkflowContainer(IContext context,
ICatalog catalog,
String name)
Creates a workflow container within a
ICatalog 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.
|
String |
IBaseDocumentModule.evaluatedHtml(IResource resource,
IMailForm mailForm)
Evaluates the form and returns the HTML content as a java.lang.String object.
|
String |
IBaseDocumentModule.evaluatedHtml(ITaskInstance taskInstance,
IMailForm mailForm)
Evaluates the form and returns the HTML content as a java.lang.String object.
|
void |
IBaseDocumentModule.execute(IAgent agent)
Allows to execute an agent.
|
void |
IBaseDocumentModule.execute(IContext context,
IAgent agent)
Allows to execute an agent.
|
int |
IBaseDocumentModule.generateChrono(IResourceDefinition resourceDefinition)
Evaluate the next chrono based on the format specified on the Designer tool.
|
String |
IBaseDocumentModule.generateReference(IResource resource)
Evaluate the next reference based on the format specified on the Designer tool.
|
String |
IBaseDocumentModule.generateReference(IResourceDefinition resourceDefinition)
Evaluate the next reference based on the format specified on the Designer tool.
|
String |
IBaseDocumentModule.generateReference(IResourceDefinition resourceDefinition,
String format)
Evaluate the next reference based on the passed format.
|
String |
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.
|
IAction |
IBaseDocumentModule.getAction(IContext context,
ITask task,
String name)
Retrieve a specific
IAction object from its system name. |
IAction |
IBaseDocumentModule.getAction(IStorageKey key)
Gets an action object from its identifier.
|
Collection<? extends IAction> |
IBaseDocumentModule.getActions(IContext context,
ITask task)
|
IAgent |
IBaseDocumentModule.getAgent(IContext context,
String name)
Gets an agent from its name.
|
IArchivingController |
IBaseDocumentModule.getArchivingController()
Gets a archiving controller to archive
IElement objects. |
IAttachment |
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.
|
ICatalog |
IBaseDocumentModule.getCatalog(IContext context,
String name,
int catalogType,
IProject project)
Retrieves a catalog form its name.
|
ICatalog |
IBaseDocumentModule.getCatalog(IResourceDefinition resourceDefinition)
Gets a
ICatalog object from a resource definitino. |
ICatalog |
IBaseDocumentModule.getCatalog(IStorageKey key)
Gets a catalog object from its identifier.
|
ICatalog |
IBaseDocumentModule.getCatalog(IWorkflow workflow)
Retrieves the catalog of a
IWorkflow object. |
Collection<? extends ICatalog> |
IBaseDocumentModule.getCatalogs(IContext context)
Retrieves a collection of
ICatalog object. |
Collection<? extends ICatalog> |
IBaseDocumentModule.getCatalogs(IContext context,
int catalogType)
Retrieves a collection of
ICatalog object. |
Collection<? extends ICatalog> |
IBaseDocumentModule.getCatalogs(IContext context,
IProject project)
Retrieves a collection of
ICatalog object. |
ICatalogViewTransformer |
IBaseDocumentModule.getCatalogViewTransformer()
Gets a catalog view transformer to transform
ICatalog objects. |
IConnectionDefinition |
IBaseDocumentModule.getConnectionDefinition(IContext context,
String name)
Gets a connection from its name.
|
Collection<? extends IConnectionDefinition> |
IBaseDocumentModule.getConnectionDefinitions(IContext context)
Gets a collection of connections.
|
IDataSourceReference |
IBaseDocumentModule.getDataSourceReference(String name)
Gets a data source reference from its JNDI name.
|
IDelegationController |
IBaseDocumentModule.getDelegationController()
Gets a delegation controller to delegate
IDelegationSupport objects. |
Collection<? extends ITaskInstance> |
IBaseDocumentModule.getEndedTaskInstances(IContext context,
IVersion version)
Retrieves all the ended task instances of a version.
|
Collection |
IBaseDocumentModule.getExternalElements(IResource resource,
String propertyName)
Gets a collection of
IElement objects from a multiple selector property. |
IFile |
IBaseDocumentModule.getExternalFile(IResource resource,
String propertyName)
Gets a
IFile object from a single file selector property. |
IFolder |
IBaseDocumentModule.getExternalFolder(IResource resource,
String propertyName)
Gets a
IFolder object from a single folder selector property. |
IGroup |
IBaseDocumentModule.getExternalGroup(IResource resource,
String propertyName)
Gets a
IGroup object from a single group selector property. |
ILibrary |
IBaseDocumentModule.getExternalLibrary(IResource resource,
String propertyName)
Gets a
ILibrary object from a single library selector property. |
ILocalization |
IBaseDocumentModule.getExternalLocalization(IResource resource,
String propertyName)
Gets a
ILocalization object from a single localization selector property. |
IOrganization |
IBaseDocumentModule.getExternalOrganization(IResource resource,
String propertyName)
Gets a
IOrganization object from a single organization selector property. |
IUser |
IBaseDocumentModule.getExternalUser(IResource resource,
String propertyName)
Gets a
IUser object from a single user selector property. |
IForm |
IBaseDocumentModule.getForm(IContext context,
IAction action,
String formName)
Gets a action form by its name.
|
IForm |
IBaseDocumentModule.getForm(IContext context,
IResourceDefinition resourceDefinition,
String formName)
Gets a resource definition form by its name.
|
IForm |
IBaseDocumentModule.getForm(IContext context,
ITask task,
String formName)
Gets a task form by its name.
|
IForm |
IBaseDocumentModule.getForm(IContext context,
IWorkflow workflow,
String formName)
Gets a workflow form by its name.
|
IGenericViewTransformer |
IBaseDocumentModule.getGenericViewTransformer() |
IJdbcReference |
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.
|
IList |
IBaseDocumentModule.getList(IContext context,
ICatalog catalog,
String name)
Gets a list object from a catalog by its name.
|
Collection |
IBaseDocumentModule.getList(IResource resource,
String propertyName)
Gets the available values of a list property.
|
Collection<? extends IList> |
IBaseDocumentModule.getLists(IContext context,
ICatalog catalog)
Gets a collection of a the lists available on a specified
ICatalog object. |
IMailForm |
IBaseDocumentModule.getMailForm(IContext context,
IWorkflow workflow,
String mailFormName) |
Collection<? extends IMailForm> |
IBaseDocumentModule.getMailForms(IContext context,
IWorkflow workflow)
Gets all the mail forms from a specified
IWorkflow 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.
|
ITaskInstance |
IBaseDocumentModule.getOneTaskInstance(IContext context,
IVersion version)
Gets one of the task instances (any).
|
IOperator |
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.
|
IProperty |
IBaseDocumentModule.getProperty(IContext context,
IResourceDefinition resourceDefinition,
String name)
Gets a property definition by specifying the
IResourceDefinition and its system name. |
IProperty |
IBaseDocumentModule.getProperty(IStorageKey key)
Gets a property object from its identifier.
|
IResource |
IBaseDocumentModule.getResource(IStorageKey key)
Gets a resource object from its identifier.
|
IResourceDefinition |
IBaseDocumentModule.getResourceDefinition(IContext context,
ICatalog catalog,
String name)
Retrieves a resource definition by specifying the
ICatalog and its system name. |
IResourceDefinition |
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 the
ICatalog |
Collection<? extends IResource> |
IBaseDocumentModule.getResources(IContext context,
ICatalog catalog)
Gets a collection of
IResource objects from a catalog |
Collection<? extends IResource> |
IBaseDocumentModule.getResources(IContext context,
IResourceDefinition resourceDefinition)
Gets a collection of
IResource objects from a resource definition. |
IResourceViewTransformer |
IBaseDocumentModule.getResourceViewTransformer()
Gets a resource view transformer to transform
IResource objects. |
IRole |
IBaseDocumentModule.getRole(IContext context,
ICatalog catalog,
String name)
Retrieves a
IRole object by its system name. |
IRole |
IBaseDocumentModule.getRole(IStorageKey key)
Gets a role object from its identifier.
|
Collection<? extends IRole> |
IBaseDocumentModule.getRoles(IContext context,
ICatalog catalog)
Retrieves a collection of
IRole objects within a specified catalog. |
ISearchController |
IBaseDocumentModule.getSearchController()
Gets the default
ISearchController object. |
ISearchController |
IBaseDocumentModule.getSearchController(IConnectionDefinition connectionDefinition)
Gets a connection from its name.
|
ISearchController |
IBaseDocumentModule.getSearchController(IDataSourceReference reference)
Gets a search controller object by specifying an external data source.
|
ISearchController |
IBaseDocumentModule.getSearchController(IJdbcReference reference)
Deprecated.
: use getSearchController ( IConnectionDefinition connectionDefinition) method instead.
|
ISearchViewTransformer |
IBaseDocumentModule.getSearchViewTransformer()
Gets a search view transformer to transform
IResource objects. |
ISecurityController |
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.
|
IForm |
IBaseDocumentModule.getSubForm(IContext context,
IWorkflow workflow,
String formName)
Gets a sub form by its name.
|
ITask |
IBaseDocumentModule.getTask(IContext context,
IWorkflow workflow,
String name)
Retrieves a specific task of a
IWorkflow object by its name. |
ITask |
IBaseDocumentModule.getTask(IStorageKey key)
Gets a task object from its identifier.
|
ITask |
IBaseDocumentModule.getTask(ITaskInstance instance)
Gets the definition of a task instance.
|
ITaskInstance |
IBaseDocumentModule.getTaskInstance(IContext context,
IVersion version,
String name)
Gets a task instance associated with a specified task name.
|
ITaskInstance |
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 a
ITask. |
ITaskInstanceTransformer |
IBaseDocumentModule.getTaskInstanceTransformer()
Gets a task transformer to transform
ITaskInstance object. |
ITaskViewTransformer |
IBaseDocumentModule.getTaskViewTransformer()
Gets a task view transformer to transform
ITaskInstance objects. |
ITransformer |
IBaseDocumentModule.getTransformer()
Gets a transformer to transform
IResource object. |
IUser |
IBaseDocumentModule.getUser(IStorageKey key)
Gets a user object from its identifier.
|
IUser |
IBaseDocumentModule.getUserByLogin(String login)
Gets a user by its login
|
Object |
IBaseDocumentModule.getValue(IResource resource,
String propertyName)
Gets the value of a property.
|
IVersion |
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 specified
ICatalog object. |
Collection<? extends IVersion> |
IBaseDocumentModule.getVersions(IContext context,
ICatalog catalog,
String reference)
Gets all the versions with the same reference within a specified
ICatalog object. |
Collection<? extends IVersion> |
IBaseDocumentModule.getVersions(IContext context,
IResourceDefinition resourceDefinition,
String reference)
Gets all the versions with the same reference within a specified
IWorkflow object. |
Collection<IVersion> |
IBaseDocumentModule.getVersions(IContext context,
ITask task)
Gets all the workflow instances of a specified
ITask object. |
Collection<? extends IVersion> |
IBaseDocumentModule.getVersions(IContext context,
IWorkflow workflow)
Gets all the versions of a specified
IWorkflow object. |
IView |
IBaseDocumentModule.getView(IContext context,
IResourceDefinition resourceDefinition,
String viewName)
Retrieves a view by its name.
|
IViewController |
IBaseDocumentModule.getViewController()
Gets a view controller to search
IResource objects through their properties. |
IViewController |
IBaseDocumentModule.getViewController(Class natureClass)
Gets a view controller to search
IResource objects through their properties. |
IViewController |
IBaseDocumentModule.getViewController(IContext context,
InputStream inputStream)
Gets a view controller to search
IResource objects through their properties. |
IViewController |
IBaseDocumentModule.getViewController(InputStream inputStream)
Gets a view controller to search
IResource objects through their properties. |
IWorkflow |
IBaseDocumentModule.getWorkflow(IContext context,
ICatalog catalog,
String name)
Retrieves a workflow within a
IWorkflow object and from its system name. |
IWorkflow |
IBaseDocumentModule.getWorkflow(IStorageKey key)
Gets a workflow object from its identifier.
|
IWorkflow |
IBaseDocumentModule.getWorkflow(ITask task)
Gets the associated workflow of a task.
|
IWorkflowContainer |
IBaseDocumentModule.getWorkflowContainer(IContext context,
ICatalog catalog,
String name)
Retrieves a
IWorkflowContainer within a ICatalog by its system name |
IWorkflowContainer |
IBaseDocumentModule.getWorkflowContainer(IWorkflow workflow)
Retrieves the workflow container of a
IWorkflow object. |
Collection<? extends IWorkflowContainer> |
IBaseDocumentModule.getWorkflowContainers(IContext context,
ICatalog catalog)
Retrieves a collection of
IWorkflowContainer objects within a ICatalog object. |
IWorkflowContainerViewTransformer |
IBaseDocumentModule.getWorkflowContainerViewTransformer()
Gets a workflow container view transformer to transform
IWorkflowContainer objects. |
Collection<? extends IWorkflow> |
IBaseDocumentModule.getWorkflows(IContext context,
ICatalog catalog)
|
Collection<? extends IWorkflow> |
IBaseDocumentModule.getWorkflows(IContext context,
IWorkflowContainer container)
Retrieves a collection of
IWorkflow objects within a IWorkflowContainer object. |
IWorkflowViewTransformer |
IBaseDocumentModule.getWorkflowViewTransformer()
Gets a workflow view transformer to transform
IWorkflow objects. |
boolean |
IBaseDocumentModule.isMemberOf(IUser user,
IRole role)
Checks if a specified user is member of a
IRole object. |
void |
IBaseDocumentModule.remind(IContext context,
ITaskInstance taskInstance,
String comment)
Allows to remind current operators of a specified task instance.
|
void |
IBaseDocumentModule.remind(IContext context,
IVersion version,
String comment)
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 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,
ITaskInstance instance,
IMailForm form,
String comment)
Sends a mail using a specified mail form.
|
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 a
IElement to a multiple selector property. |
void |
IBaseDocumentModule.setExternalFile(IResource resource,
String propertyName,
IFile file)
Sets a
IFile to a single selector property. |
void |
IBaseDocumentModule.setExternalFolder(IResource resource,
String propertyName,
IFolder folder)
Sets a
IFolder to a single selector property. |
void |
IBaseDocumentModule.setExternalGroup(IResource resource,
String propertyName,
IGroup group)
Sets a
IGroup to a single selector property. |
void |
IBaseDocumentModule.setExternalLibrary(IResource resource,
String propertyName,
ILibrary library)
Sets a
ILibrary to a single selector property. |
void |
IBaseDocumentModule.setExternalLocalization(IResource resource,
String propertyName,
ILocalization localization)
Sets a
ILocalization to a single selector property. |
void |
IBaseDocumentModule.setExternalOrganization(IResource resource,
String propertyName,
IOrganization organization)
Sets a
IOrganization to a single selector property. |
void |
IBaseDocumentModule.setExternalUser(IResource resource,
String propertyName,
IUser user)
Sets a
IUser 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 |
IBaseDocumentModule.setValue(IResource resource,
String propertyName,
Object value)
Sets a value to a property.
|
Copyright © 2022 Visiativ. All rights reserved.