com.axemble.vdoc.sdk.interfaces

Interface IWorkflowInstance

All Superinterfaces:

IDelegationSupport, IDeletionSupport, IElement, ILocalizationScope, ILockSupport, IProtocolSupport, IResource, ISearchSupport, ISecuritySupport, IUriSupport, Serializable

public interface IWorkflowInstance
extends IResource, IDeletionSupport, ISearchSupport, IUriSupport, IDelegationSupport, ILocalizationScope, ILockSupport

This class represents a process document.

Since:

1.0, 15/04/2008

Author:

vlygeros

See Also:

ITaskInstance, IResource, IWorkflow, ICatalog

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IWorkflowInstance.IStatus Available status for the workflow instance.

Method Summary

Modifier and Type	Method and Description
boolean	addLinkedWorkflowInstance(String propertyName, IWorkflowInstance linkedWorkflowInstance) Allows to add a workflow instance object to a linked table field.
boolean	addLinkedWorkflowInstances(String propertyName, Collection<? extends IWorkflowInstance> linkedWorkflowInstances) Allows to add an association between a workflow instance object and a linked table field.
void	deleteLinkedWorkflowInstance(String propertyName, IWorkflowInstance linkedWorkflowInstance) Allows to remove the association between a workflow instance object and a linked table field.
void	deleteLinkedWorkflowInstances(String propertyName, Collection<? extends IWorkflowInstance> linkedWorkflowInstances) Allows to remove the associations between a collection of IWorkflowInstances objects and a linked table field.
ICatalog	getCatalog() Gets the catalog.
ITaskInstance	getCurrentTaskInstance(IContext context) Gets the current task instance.
Collection<? extends IWorkflowInstance>	getEmbeddedWorkflowInstances() In embedded workflow, return all embedded workflow instances
Date	getEndedDate() Gets the ended date.
Collection<? extends IWorkflowInstance>	getLinkedWorkflowInstances(String propertyName) Retrieves all the linked workflow instance of a linked table field.
IWorkflowInstance	getParentContainerWorkflowInstance() In embedded workflow, return the parent workflow instance
IWorkflowInstance	getParentInstance() Gets the parent instance.
int	getStatus() Gets the system status
IWorkflow	getWorkflow() Gets the associated workflow.
void	resume() Deprecated. : use unlock() method instead.
void	suspend() Deprecated. : use lock() method instead.

Methods inherited from interface com.axemble.vdoc.sdk.supports.IUriSupport

getURI

Methods inherited from interface com.axemble.vdoc.sdk.supports.ILockSupport

isLockBySDK, isLockBySDK, isLocked, isLocked, lock, lockedBy, lockedBy, unlock

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IResource

addLinkedResource, addLinkedResources, allowEvents, createLinkedResource, deleteLinkedResource, deleteLinkedResources, denyEvents, exists, getCreatedBy, getCreatedDate, getDefinition, getHistory, getLinkedResources, getList, getModifiedBy, getModifiedDate, getName, getText, getValue, refresh, refresh, save, save, setCreatedBy, setCreatedDate, setList, setModifiedBy, setModifiedDate, setValue, setValueNoEvents

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IElement

getId, getModule, getNativeObject, getPath, save

Method Detail

getEndedDate

Date getEndedDate()

Gets the ended date.

Returns:

a Date object.

getWorkflow

IWorkflow getWorkflow()

Gets the associated workflow.

Returns:

a IWorkflow object.

getCatalog

ICatalog getCatalog()

Gets the catalog.

Returns:

a ICatalog object.

getCurrentTaskInstance

ITaskInstance getCurrentTaskInstance(IContext context)

Gets the current task instance.

Parameters:

context - The execution context.

Returns:

a ITaskInstance object.

getParentInstance

IWorkflowInstance getParentInstance()

Gets the parent instance.

Returns:

a IWorkflowInstance object.

addLinkedWorkflowInstance

boolean addLinkedWorkflowInstance(String propertyName,
                                  IWorkflowInstance linkedWorkflowInstance)

Allows to add a workflow instance object to a linked table field.

Parameters:

propertyName - The system property of the field.

linkedWorkflowInstance - The IWorkflowIntance to add.

Returns:

true if succeed, false otherwise.

addLinkedWorkflowInstances

boolean addLinkedWorkflowInstances(String propertyName,
                                   Collection<? extends IWorkflowInstance> linkedWorkflowInstances)

Allows to add an association between a workflow instance object and a linked table field.

Parameters:

propertyName - The system property of the field.

linkedWorkflowInstances - A collection of IWorkflowIntance objects to add.

Returns:

true if succeed, false otherwise.

getLinkedWorkflowInstances

Collection<? extends IWorkflowInstance> getLinkedWorkflowInstances(String propertyName)

Retrieves all the linked workflow instance of a linked table field.

Parameters:

propertyName - The system property of the field.

Returns:

a collection of IWorkflowIntance objects.

deleteLinkedWorkflowInstance

void deleteLinkedWorkflowInstance(String propertyName,
                                  IWorkflowInstance linkedWorkflowInstance)

Allows to remove the association between a workflow instance object and a linked table field.

Parameters:

propertyName - The system property of the field.

linkedWorkflowInstance - The IWorkflowIntance to remove.

deleteLinkedWorkflowInstances

void deleteLinkedWorkflowInstances(String propertyName,
                                   Collection<? extends IWorkflowInstance> linkedWorkflowInstances)

Allows to remove the associations between a collection of IWorkflowInstances objects and a linked table field.

Parameters:

propertyName - The system property of the field.

linkedWorkflowInstances - The collection of IWorkflowInstance objects.

suspend

@Deprecated
void suspend()

Deprecated. : use lock() method instead.

Denies any cross-transition actions.

resume

@Deprecated
void resume()

Deprecated. : use unlock() method instead.

Allows cross-transition actions.

getStatus

int getStatus()

Gets the system status

Returns:

Returns one of the IWorkflowInstance.IStatus values.

getParentContainerWorkflowInstance

IWorkflowInstance getParentContainerWorkflowInstance()

In embedded workflow, return the parent workflow instance

Returns:

the parent workflowinstance that started the workflow

getEmbeddedWorkflowInstances

Collection<? extends IWorkflowInstance> getEmbeddedWorkflowInstances()

In embedded workflow, return all embedded workflow instances

Returns:

all embedded workflow instances