Package com.axemble.vdoc.sdk.impl

Class ProcessWorkflowInstance

java.lang.Object

com.axemble.vdoc.sdk.impl.AbstractElement

com.axemble.vdoc.sdk.impl.ProcessElement

com.axemble.vdoc.sdk.impl.ProcessResource

com.axemble.vdoc.sdk.impl.ProcessWorkflowInstance

All Implemented Interfaces:

IElement, ILocalizationScope, IResource, IWorkflowInstance, SDKWrapper, IDelegationSupport, IDeletionSupport, ILockSupport, IProtocolSupport, ISearchSupport, ISecuritySupport, IUriSupport, com.axemble.vdp.resource.interfaces.InternalResource, Serializable

public class ProcessWorkflowInstance
extends ProcessResource
implements IWorkflowInstance

Workflow instance for Process SDK

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.axemble.vdoc.sdk.interfaces.IWorkflowInstance

IWorkflowInstance.IStatus

Field Summary

Fields inherited from class com.axemble.vdoc.sdk.impl.ProcessResource

document

Fields inherited from class com.axemble.vdoc.sdk.impl.AbstractElement

module

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ProcessWorkflowInstance(IModule module, com.axemble.vdp.ui.core.document.CoreDocument document)

Method Summary

Modifier and Type	Method	Description
boolean	addLinkedWorkflowInstance(String propertyName, IWorkflowInstance workflowInstance)	Allows to add a workflow instance object to a linked table field.
boolean	addLinkedWorkflowInstance(String propertyName, IWorkflowInstance linkedWorkflowInstance, boolean withSubscription)	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.
boolean	addLinkedWorkflowInstances(String propertyName, Collection<? extends IWorkflowInstance> linkedWorkflowInstances, boolean withSubscription)	Allows to add an association between a workflow instance object and a linked table field.
void	delete(IContext context)	Deletes the IElement object.
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 IWorkflowInstance objects and a linked table field.
IUser	getCreatedBy()	Gets the creator of the resource.
Date	getCreatedDate()	Gets the created date.
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.
IStorageKey	getId()	Gets the identifier object.
Collection<? extends IWorkflowInstance>	getLinkedWorkflowInstances(String propertyName)	Retrieves all the linked workflow instance of a linked table field.
IUser	getModifiedBy()	Gets the last user who modified the resource.
com.axemble.vdoc.core.domain.BaseDomain	getNativeDomain()
Object	getNativeObject()	Gets the native object underneath.
IWorkflowInstance	getParentContainerWorkflowInstance()	In embedded workflow, return the parent workflow instance
IWorkflowInstance	getParentInstance()	Gets the parent instance.
IWorkflowInstance	getParentInstanceInFormulaContext()	Gets the parent instance with the rights of its creator.
int	getStatus()	Gets the system status
String	getURI()	Gets the URI of the object supporting this interface
IWorkflow	getWorkflow()	Gets the associated workflow.
boolean	isLockBySDK(IContext context)	Is resource SDK by lock
boolean	isLockBySDK(IContext context, boolean cleanSessionLock)	Is resource SDK by lock ( try to unlock resource before).
boolean	isLocked(IContext context)	Is resource locked
boolean	isLocked(IContext context, boolean cleanSessionLock)	Is resource locked ( try to unlock resource before ).
void	lock(IContext context, int delay)	Lock a resource
Collection<IUser>	lockedBy(IContext context)	Retrieve the users who locked the resource.
Collection<IUser>	lockedBy(IContext context, boolean cleanSessionLock)	Retrieve the users who locked the resource ( try to unlock resource before).
void	resume()	Allows cross-transition actions.
void	setCreatedBy(IUser user)	Sets the creator of the resource.
void	setCreatedDate(Date date)	Sets the created date.
void	setEndedDate(Date date)
void	setModifiedBy(IUser user)	Sets last user who modified the resource.
void	suspend()	Denies any cross-transition actions.
void	unlock(IContext context)	Unlock a resource

Methods inherited from class com.axemble.vdoc.sdk.impl.ProcessResource

addLinkedResource, addLinkedResources, allowEvents, createLinkedResource, deleteLinkedResource, deleteLinkedResources, denyEvents, exists, getCatalog, getDefinition, getDocument, getFields, getHistory, getLinkedResources, getList, getModifiedDate, getName, getText, getValue, getValues, refresh, refresh, save, save, save, saveNoEvents, setList, setModifiedDate, setValue, setValueNoEvents

Methods inherited from class com.axemble.vdoc.sdk.impl.ProcessElement

getPath, getProtocolURI, getProtocolURI, getWorkflowModule

Methods inherited from class com.axemble.vdoc.sdk.impl.AbstractElement

getModule

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getModule, getPath, save

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

getProtocolURI, getProtocolURI

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

addLinkedResource, addLinkedResources, allowEvents, createLinkedResource, deleteLinkedResource, deleteLinkedResources, denyEvents, exists, getDefinition, getHistory, getLinkedResources, getList, getModifiedDate, getName, getText, getValue, refresh, refresh, save, save, setList, setModifiedDate, setValue, setValueNoEvents

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

getCatalog

Constructor Details

ProcessWorkflowInstance

protected ProcessWorkflowInstance(IModule module,
 com.axemble.vdp.ui.core.document.CoreDocument document)

Method Details

getId

public IStorageKey getId()

Description copied from interface: IElement

Gets the identifier object.

Specified by:

getId in interface IElement

Overrides:

getId in class ProcessResource

Returns:

a IStorageKey object.

getNativeObject

public Object getNativeObject()

Description copied from interface: IElement

Gets the native object underneath.

Specified by:

getNativeObject in interface IElement

Overrides:

getNativeObject in class ProcessResource

Returns:

an object.

getNativeDomain

public com.axemble.vdoc.core.domain.BaseDomain getNativeDomain()

Specified by:

getNativeDomain in interface SDKWrapper

Overrides:

getNativeDomain in class ProcessResource

getURI

public String getURI()

Description copied from interface: IUriSupport

Gets the URI of the object supporting this interface

Specified by:

getURI in interface IUriSupport

Returns:

A String object.

getCreatedDate

public Date getCreatedDate()

Description copied from interface: IResource

Gets the created date.

Specified by:

getCreatedDate in interface IResource

Overrides:

getCreatedDate in class ProcessResource

Returns:

a Date object.

setCreatedDate

public void setCreatedDate(Date date)

Description copied from interface: IResource

Sets the created date.

Specified by:

setCreatedDate in interface IResource

Overrides:

setCreatedDate in class ProcessResource

Parameters:

date - The Date to set.

getEndedDate

public Date getEndedDate()

Description copied from interface: IWorkflowInstance

Gets the ended date.

Specified by:

getEndedDate in interface IWorkflowInstance

Returns:

a Date object.

setEndedDate

public void setEndedDate(Date date)

setCreatedBy

public void setCreatedBy(IUser user)

Description copied from interface: IResource

Sets the creator of the resource. Can only be set if the resource has not been created yet

Specified by:

setCreatedBy in interface IResource

Overrides:

setCreatedBy in class ProcessResource

Parameters:

user - The creator IUser of the resource.

getCreatedBy

public IUser getCreatedBy()

Description copied from interface: IResource

Gets the creator of the resource.

Specified by:

getCreatedBy in interface IResource

Overrides:

getCreatedBy in class ProcessResource

Returns:

a IUser object.

setModifiedBy

public void setModifiedBy(IUser user)

Description copied from interface: IResource

Sets last user who modified the resource.

Specified by:

setModifiedBy in interface IResource

Overrides:

setModifiedBy in class ProcessResource

Parameters:

user - The last IUser who modified the resource.

getModifiedBy

public IUser getModifiedBy()

Description copied from interface: IResource

Gets the last user who modified the resource.

Specified by:

getModifiedBy in interface IResource

Overrides:

getModifiedBy in class ProcessResource

Returns:

a IUser object.

getWorkflow

public IWorkflow getWorkflow()

Description copied from interface: IWorkflowInstance

Gets the associated workflow.

Specified by:

getWorkflow in interface IWorkflowInstance

Returns:

a IWorkflow object.

getCurrentTaskInstance

public ITaskInstance getCurrentTaskInstance(IContext context)

Description copied from interface: IWorkflowInstance

Gets the current task instance.

Specified by:

getCurrentTaskInstance in interface IWorkflowInstance

Parameters:

context - The execution context.

Returns:

a ITaskInstance object.

getParentInstance

public IWorkflowInstance getParentInstance()

Description copied from interface: IWorkflowInstance

Gets the parent instance.

Specified by:

getParentInstance in interface IWorkflowInstance

Returns:

a IWorkflowInstance object.

getParentInstanceInFormulaContext

public IWorkflowInstance getParentInstanceInFormulaContext()

Description copied from interface: IWorkflowInstance

Gets the parent instance with the rights of its creator. Is only used in the formulas

Specified by:

getParentInstanceInFormulaContext in interface IWorkflowInstance

Returns:

a IWorkflowInstance object.

delete

public void delete(IContext context)

Description copied from interface: IDeletionSupport

Deletes the IElement object.

Specified by:

delete in interface IDeletionSupport

Overrides:

delete in class ProcessResource

Parameters:

context - The Execution context.

addLinkedWorkflowInstance

public boolean addLinkedWorkflowInstance(String propertyName,
 IWorkflowInstance workflowInstance)

Description copied from interface: IWorkflowInstance

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

Specified by:

addLinkedWorkflowInstance in interface IWorkflowInstance

Parameters:

propertyName - The system property of the field.

workflowInstance - The IWorkflowInstance to add.

Returns:

true if successful,

invalid @link

{@link false

} otherwise.

addLinkedWorkflowInstances

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

Description copied from interface: IWorkflowInstance

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

Specified by:

addLinkedWorkflowInstances in interface IWorkflowInstance

Parameters:

propertyName - The system property of the field.

linkedWorkflowInstances - A collection of IWorkflowInstance objects to add.

Returns:

true if successful,

invalid @link

{@link false

} otherwise.

addLinkedWorkflowInstance

public boolean addLinkedWorkflowInstance(String propertyName,
 IWorkflowInstance linkedWorkflowInstance,
 boolean withSubscription)

Description copied from interface: IWorkflowInstance

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

Specified by:

addLinkedWorkflowInstance in interface IWorkflowInstance

Parameters:

propertyName - The system property of the field.

linkedWorkflowInstance - The IWorkflowInstance to add.

withSubscription -

invalid @link

{@link true

} to apply inter-resources subscription rules.

Returns:

true if successful,

invalid @link

{@link false

} otherwise.

addLinkedWorkflowInstances

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

Description copied from interface: IWorkflowInstance

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

Specified by:

addLinkedWorkflowInstances in interface IWorkflowInstance

Parameters:

propertyName - The system property of the field.

linkedWorkflowInstances - A collection of IWorkflowInstance objects to add.

withSubscription -

invalid @link

{@link true

} to apply inter-resources subscription rules.

Returns:

true if successful,

invalid @link

{@link false

} otherwise.

getLinkedWorkflowInstances

public Collection<? extends IWorkflowInstance> getLinkedWorkflowInstances(String propertyName)

Description copied from interface: IWorkflowInstance

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

Specified by:

getLinkedWorkflowInstances in interface IWorkflowInstance

Parameters:

propertyName - The system property of the field.

Returns:

a collection of IWorkflowInstance objects.

deleteLinkedWorkflowInstance

public void deleteLinkedWorkflowInstance(String propertyName,
 IWorkflowInstance linkedWorkflowInstance)

Description copied from interface: IWorkflowInstance

Allows to remove the association between a workflow instance object and a linked table field. Warning, unlinking a child with a strong link with the parent document will delete it permanently.

Specified by:

deleteLinkedWorkflowInstance in interface IWorkflowInstance

Parameters:

propertyName - The system property of the field.

linkedWorkflowInstance - The IWorkflowInstance to remove.

deleteLinkedWorkflowInstances

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

Description copied from interface: IWorkflowInstance

Allows to remove the associations between a collection of IWorkflowInstance objects and a linked table field. Warning, unlinking a child with a strong link with the parent document will delete it permanently.

Specified by:

deleteLinkedWorkflowInstances in interface IWorkflowInstance

Parameters:

propertyName - The system property of the field.

linkedWorkflowInstances - The collection of IWorkflowInstance objects.

resume

public void resume()

Description copied from interface: IWorkflowInstance

Allows cross-transition actions.

Specified by:

resume in interface IWorkflowInstance

suspend

public void suspend()

Description copied from interface: IWorkflowInstance

Denies any cross-transition actions.

Specified by:

suspend in interface IWorkflowInstance

getStatus

public int getStatus()

Description copied from interface: IWorkflowInstance

Gets the system status

Specified by:

getStatus in interface IWorkflowInstance

Returns:

Returns one of the IWorkflowInstance.IStatus values.

getParentContainerWorkflowInstance

public IWorkflowInstance getParentContainerWorkflowInstance()

Description copied from interface: IWorkflowInstance

In embedded workflow, return the parent workflow instance

Specified by:

getParentContainerWorkflowInstance in interface IWorkflowInstance

Returns:

the parent workflowinstance that started the workflow

getEmbeddedWorkflowInstances

public Collection<? extends IWorkflowInstance> getEmbeddedWorkflowInstances()

Description copied from interface: IWorkflowInstance

In embedded workflow, return all embedded workflow instances

Specified by:

getEmbeddedWorkflowInstances in interface IWorkflowInstance

Returns:

all embedded workflow instances

lock

public void lock(IContext context,
 int delay)

Description copied from interface: ILockSupport

Lock a resource

Specified by:

lock in interface ILockSupport

Parameters:

context - The execution context.

delay - lock delay in second

unlock

public void unlock(IContext context)

Description copied from interface: ILockSupport

Unlock a resource

Specified by:

unlock in interface ILockSupport

Parameters:

context - The execution context.

isLocked

public boolean isLocked(IContext context)

Description copied from interface: ILockSupport

Is resource locked

Specified by:

isLocked in interface ILockSupport

Parameters:

context - The execution context.

Returns:

true if the resource has been locked, false otherwise.

lockedBy

public Collection<IUser> lockedBy(IContext context)

Description copied from interface: ILockSupport

Retrieve the users who locked the resource.

Specified by:

lockedBy in interface ILockSupport

Parameters:

context - The execution context.

Returns:

a list of IUser users.

isLockBySDK

public boolean isLockBySDK(IContext context)

Description copied from interface: ILockSupport

Is resource SDK by lock

Specified by:

isLockBySDK in interface ILockSupport

Parameters:

context - The execution context.

Returns:

true if the resource has been locked by SDK, false otherwise.

isLocked

public boolean isLocked(IContext context,
 boolean cleanSessionLock)

Description copied from interface: ILockSupport

Is resource locked ( try to unlock resource before ).

Specified by:

isLocked in interface ILockSupport

Parameters:

context - The execution context.

cleanSessionLock - try to unlock resource before

Returns:

true if the resource has been locked, false otherwise.

lockedBy

public Collection<IUser> lockedBy(IContext context,
 boolean cleanSessionLock)

Description copied from interface: ILockSupport

Retrieve the users who locked the resource ( try to unlock resource before).

Specified by:

lockedBy in interface ILockSupport

Parameters:

context - The execution context.

cleanSessionLock - try to unlock resource before

Returns:

a list of IUser users.

isLockBySDK

public boolean isLockBySDK(IContext context,
 boolean cleanSessionLock)

Description copied from interface: ILockSupport

Is resource SDK by lock ( try to unlock resource before).

Specified by:

isLockBySDK in interface ILockSupport

Parameters:

context - The execution context.

cleanSessionLock - try to unlock resource before

Returns:

true if the resource has been locked by SDK, false otherwise.