Uses of Interface
com.axemble.vdoc.sdk.interfaces.IWorkflowInstance

Packages that use IWorkflowInstance

Package	Description
com.axemble.vdoc.sdk.connectors
com.axemble.vdoc.sdk.document.extensions
com.axemble.vdoc.sdk.document.fields.base
com.axemble.vdoc.sdk.interfaces
com.axemble.vdoc.sdk.link.extensions
com.axemble.vdoc.sdk.mail.extensions
com.axemble.vdoc.sdk.mapping.extensions
com.axemble.vdoc.sdk.modules
com.axemble.vdoc.sdk.view.extensions
com.axemble.vdoc.sdk.workflow.extensions

Uses of IWorkflowInstance in com.axemble.vdoc.sdk.connectors

Methods in com.axemble.vdoc.sdk.connectors with parameters of type IWorkflowInstance

Modifier and Type	Method and Description
abstract int	BaseTreatmentConnector.execute(IContext context, IWorkflowInstance workflowInstance, ITaskInstance taskInstance, Element customElement)

Uses of IWorkflowInstance in com.axemble.vdoc.sdk.document.extensions

Methods in com.axemble.vdoc.sdk.document.extensions that return IWorkflowInstance

Modifier and Type	Method and Description
IWorkflowInstance	BaseDocumentExtension.getWorkflowInstance() Retrieves the main workflow instance object.

Uses of IWorkflowInstance in com.axemble.vdoc.sdk.document.fields.base

Methods in com.axemble.vdoc.sdk.document.fields.base that return IWorkflowInstance

Modifier and Type	Method and Description
protected IWorkflowInstance	BaseWorkflowField.getWorkflowInstance()

Uses of IWorkflowInstance in com.axemble.vdoc.sdk.interfaces

Methods in com.axemble.vdoc.sdk.interfaces that return IWorkflowInstance

Modifier and Type	Method and Description
IWorkflowInstance	ITaskInstance.getEmbeddedWorkflowInstance() In embedded task instances, return the embedded instance
IWorkflowInstance	IWorkflowInstance.getParentContainerWorkflowInstance() In embedded workflow, return the parent workflow instance
IWorkflowInstance	IWorkflowInstance.getParentInstance() Gets the parent instance.
IWorkflowInstance	ILinkedResource.getParentInstance() Gets the parent instance.
IWorkflowInstance	ITaskInstance.getWorkflowInstance()

Methods in com.axemble.vdoc.sdk.interfaces that return types with arguments of type IWorkflowInstance

Modifier and Type	Method and Description
Collection<? extends IWorkflowInstance>	IWorkflowInstance.getEmbeddedWorkflowInstances() In embedded workflow, return all embedded workflow instances
Collection<? extends IWorkflowInstance>	IWorkflowInstance.getLinkedWorkflowInstances(String propertyName) Retrieves all the linked workflow instance of a linked table field.

Methods in com.axemble.vdoc.sdk.interfaces with parameters of type IWorkflowInstance

Modifier and Type	Method and Description
void	IDelegationController.addDelegation(IUser user, IUser substituteUser, IWorkflowInstance workflowInstance, ITask task) Add a delegation unit to a specific workflow instance for a user in the context of a task
boolean	IWorkflowInstance.addLinkedWorkflowInstance(String propertyName, IWorkflowInstance linkedWorkflowInstance) Allows to add a workflow instance object to a linked table field.
void	IDelegationController.breakDelegation(IUser user, IWorkflowInstance workflowInstance, ITask task) Break a delegation unit.
void	IWorkflowInstance.deleteLinkedWorkflowInstance(String propertyName, IWorkflowInstance linkedWorkflowInstance) Allows to remove the association between a workflow instance object and a linked table field.
void	IDelegationController.removeDelegation(IUser user, IWorkflowInstance workflowInstance, ITask task) Remove a delegation unit for a particular user and a specific task

Method parameters in com.axemble.vdoc.sdk.interfaces with type arguments of type IWorkflowInstance

Modifier and Type	Method and Description
boolean	IWorkflowInstance.addLinkedWorkflowInstances(String propertyName, Collection<? extends IWorkflowInstance> linkedWorkflowInstances) Allows to add an association between a workflow instance object and a linked table field.
IReport	IDelegationController.delegateResources(ICatalog catalog, Collection<? extends IOperatorRole> roles, Collection<? extends IWorkflowInstance> resources, IUser user, IUser substituteUser) Allow to replace a user for a specified set of workflow instances
IReport	IDelegationController.delegateRoles(ICatalog catalog, Collection<? extends IRole> roles, Collection<? extends IWorkflowInstance> resources, IUser user, IUser substituteUser) Deprecated. : use delegateOperatorRoles or delegateProfiles
void	IWorkflowInstance.deleteLinkedWorkflowInstances(String propertyName, Collection<? extends IWorkflowInstance> linkedWorkflowInstances) Allows to remove the associations between a collection of IWorkflowInstances objects and a linked table field.

Uses of IWorkflowInstance in com.axemble.vdoc.sdk.link.extensions

Methods in com.axemble.vdoc.sdk.link.extensions with parameters of type IWorkflowInstance

Modifier and Type	Method and Description
abstract boolean	BaseLinkExtension.onCreate(IWorkflowInstance workflowInstance, IResource resource)

Uses of IWorkflowInstance in com.axemble.vdoc.sdk.mail.extensions

Methods in com.axemble.vdoc.sdk.mail.extensions that return IWorkflowInstance

Modifier and Type	Method and Description
protected IWorkflowInstance	BaseMailExtension.getWorkflowInstance()

Uses of IWorkflowInstance in com.axemble.vdoc.sdk.mapping.extensions

Methods in com.axemble.vdoc.sdk.mapping.extensions that return IWorkflowInstance

Modifier and Type	Method and Description
protected IWorkflowInstance	BaseMappingExtension.getWorkflowInstance()

Uses of IWorkflowInstance in com.axemble.vdoc.sdk.modules

Methods in com.axemble.vdoc.sdk.modules that return IWorkflowInstance

Modifier and Type	Method and Description
IWorkflowInstance	IBaseWorkflowModule.createWorkflowInstance(IContext context, IWorkflow workflow, String reference) Creates a workflow instance object by specifying the IWorkflow object, its reference.
IWorkflowInstance	IBaseWorkflowModule.createWorkflowInstance(IContext context, IWorkflow workflow, String reference, String label) Creates a workflow instance object by specifying the IWorkflow object, its reference, and its label.
IWorkflowInstance	IBaseWorkflowModule.getParentInstance(ILinkedResource linkedResource) Gets the parent instance of a linked resource.
IWorkflowInstance	IBaseWorkflowModule.getParentInstance(IWorkflowInstance instance) Gets the parent instance of a specified IWorkflowInstanceobject.
IWorkflowInstance	IBaseWorkflowModule.getWorkflowInstance(IStorageKey key) Gets a workflow instance object from its identifier.
IWorkflowInstance	IBaseWorkflowModule.getWorkflowInstance(Object object) Gets a IWorkflowInstance object from an object.
IWorkflowInstance	IBaseWorkflowModule.getWorkflowInstance(String id) Deprecated. Use getWorkflowInstance( IStorageKey key ) method instead.

Methods in com.axemble.vdoc.sdk.modules that return types with arguments of type IWorkflowInstance

Modifier and Type	Method and Description
Collection<? extends IWorkflowInstance>	IBaseWorkflowModule.getWorkflowInstances(IContext context, ICatalog catalog) Gets all the workflow instances of a specified ICatalog object.
Collection<? extends IWorkflowInstance>	IBaseWorkflowModule.getWorkflowInstances(IContext context, ICatalog catalog, String reference) Gets all the workflow instances with the same reference within a specified ICatalog object.
Collection<? extends IWorkflowInstance>	IBaseWorkflowModule.getWorkflowInstances(IContext context, ITask task) Gets all the workflow instances of a specified ITask object.
Collection<? extends IWorkflowInstance>	IBaseWorkflowModule.getWorkflowInstances(IContext context, IWorkflow workflow) Gets all the workflow instances of a specified IWorkflow object.
Collection<? extends IWorkflowInstance>	IBaseWorkflowModule.getWorkflowInstances(IContext context, IWorkflow workflow, String reference) Gets all the workflow instances with the same reference within a specified IWorkflow object.

Methods in com.axemble.vdoc.sdk.modules with parameters of type IWorkflowInstance

Modifier and Type	Method and Description
void	IBaseWorkflowModule.abort(IContext context, IWorkflowInstance instance, String comment) Allows to abort workflow instance.
IWorkflowInstanceDiscussionMessage	IBaseWorkflowModule.createDiscussionMessage(IContext context, IWorkflowInstance iWorkflowInstance, String content, Collection<IAttachment> attachments, String visibility, Collection<IUser> recipients, IOrganization visibilityOrganization) Create and add a new message for an IWorkflowInstance.
void	IBaseWorkflowModule.deleteDiscussionMessage(IContext context, IWorkflowInstanceDiscussionMessage iWorkflowInstanceDiscussionMessage, IWorkflowInstance iWorkflowInstance) Delete an IWorkflowInstanceDiscussionMessage for an IWorkflowInstance.
Collection<? extends ITaskInstance>	IBaseWorkflowModule.getAbortedTaskInstances(IContext context, IWorkflowInstance instance) Retrieves all the aborted task instances of a workflow instance.
Collection<IWorkflowInstanceDiscussionMessage>	IBaseWorkflowModule.getDiscussionMessagesOrderByCreationDateDesc(IContext context, IWorkflowInstance workflowInstance) Retrieve IWorkflowInstance's message
Collection<? extends ITaskInstance>	IBaseWorkflowModule.getEndedTaskInstances(IContext context, IWorkflowInstance instance) Retrieves all the ended task instances of a workflow instance.
Collection<? extends ITaskInstance>	IBaseWorkflowModule.getManualTaskInstances(IContext context, IWorkflowInstance instance) Retrieves all the manual task instances of a workflow instance.
ITaskInstance	IBaseWorkflowModule.getOneTaskInstance(IContext context, IWorkflowInstance instance) Gets one of the task instances (any).
IWorkflowInstance	IBaseWorkflowModule.getParentInstance(IWorkflowInstance instance) Gets the parent instance of a specified IWorkflowInstanceobject.
Collection<? extends ITaskInstance>	IBaseWorkflowModule.getStartedTaskInstances(IContext context, IWorkflowInstance instance) Retrieves all the started task instances of a workflow instance.
ITaskInstance	IBaseWorkflowModule.getTaskInstance(IContext context, IWorkflowInstance instance, String name) Gets the started task instance associated with a specified task name.
Collection<? extends ITaskInstance>	IBaseWorkflowModule.getTaskInstances(IContext context, IWorkflowInstance instance) Retrieves all the task instances of a specified workflow instance.
Collection<? extends ITaskInstance>	IBaseWorkflowModule.getTaskInstances(IContext context, IWorkflowInstance instance, String name) Retrieves all the task instances of a specified workflow instance filtered by the name of a ITask.
boolean	IBaseWorkflowModule.hasDiscussionThread(IContext context, IWorkflowInstance iWorkflowInstance) Allows knowing if an IWorkflowInstance has a discussion thread or not
boolean	IWorkflowModule.isLockBySDK(IContext context, IWorkflowInstance workflowInstance) Checks if a specified workflow instance is locked by the SDK
boolean	IWorkflowModule.isLocked(IContext context, IWorkflowInstance workflowInstance) Checks if a specified workflow instance is locked
void	IWorkflowModule.lock(IContext context, IWorkflowInstance workflowInstance, int delay) Allows to lock workflow instance.
Collection<IUser>	IWorkflowModule.lockedBy(IContext context, IWorkflowInstance workflowInstance) Retrieve the users who locked the workflow instance.
void	IBaseWorkflowModule.remind(IContext context, IWorkflowInstance instance, String comment) Allows to remind current operators of a workflow instance.
void	IBaseWorkflowModule.send(IContext context, IWorkflowInstance workflowInstance, String formName, Collection<?> entries) Deprecated. use send( IContext context, IResource resource, IMailForm mailForm, Collection mail_to, String comment )
void	IWorkflowModule.unlock(IContext context, IWorkflowInstance workflowInstance) Allows to unlock workflow instance.

Uses of IWorkflowInstance in com.axemble.vdoc.sdk.view.extensions

Methods in com.axemble.vdoc.sdk.view.extensions that return IWorkflowInstance

Modifier and Type	Method and Description
protected IWorkflowInstance	BaseViewExtension.getWorkflowInstance() Retrieves the container workflow instance object.

Uses of IWorkflowInstance in com.axemble.vdoc.sdk.workflow.extensions

Methods in com.axemble.vdoc.sdk.workflow.extensions with parameters of type IWorkflowInstance

Modifier and Type	Method and Description
com.axemble.vdp.runtime.classes.IResult	BaseWorkflowExtension.onAbortWorkflowInstance(IWorkflowInstance workflowInstance, com.axemble.vdp.runtime.classes.IResult result) This method is called each time the abort method is used.
void	BaseWorkflowExtension.onCreateEmbeddedWorkflowInstance(ITaskInstance parentTaskInstance, IWorkflowInstance parentWorkflowInstance, IWorkflowInstance embeddedWorkflowInstance) This method is called on a parent workflow before creating an embedded workflow instance.
com.axemble.vdp.runtime.classes.IResult	BaseWorkflowExtension.onRemindWorkflowInstance(IWorkflowInstance workflowInstance, IUser fulfiller, com.axemble.vdp.runtime.classes.IResult result) This method is called each time a user sends a reminder.
void	BaseWorkflowExtension.onStartRemovingWorkflowInstance(IWorkflowInstance workflowInstance, IUser fulfiller) This method is called each time a user removes a workflow instance.