com.axemble.vdoc.sdk.modules

Interface IWorkflowModule

All Superinterfaces:

IBaseWorkflowModule, IModule, Remote

public interface IWorkflowModule
extends IBaseWorkflowModule

The IWorkflowModule interface is the main entry point from where most of the methods to manipulate the full set of work-flow document objects are made available.

Code sample :

 // creation of a workflow module object
 IWorkflowModule workflowModule = Modules.getWorkflowModule();
 try
 {
 }
 finally
 {
  // uninitialize the module
        Modules.releaseModule(workflowModule);
 }
 

Author:

vlygeros

Method Summary

Modifier and Type	Method and Description
IResourceController	getController(IResource resource) Gets the resource controller object.
com.axemble.vdoc.sdk.interfaces.ui.definitions.IDefinitionsFactory	getDefinitionsFactory() Gets access to all available definitions.
IResourceController	getResourceController(IResource resource) Gets the resource controller object.
boolean	isLockBySDK(IContext context, IWorkflowInstance workflowInstance) Checks if a specified workflow instance is locked by the SDK
boolean	isLocked(IContext context, IWorkflowInstance workflowInstance) Checks if a specified workflow instance is locked
void	lock(IContext context, IWorkflowInstance workflowInstance, int delay) Allows to lock workflow instance.
Collection<IUser>	lockedBy(IContext context, IWorkflowInstance workflowInstance) Retrieve the users who locked the workflow instance.
void	unlock(IContext context, IWorkflowInstance workflowInstance) Allows to unlock workflow instance.

Methods inherited from interface com.axemble.vdoc.sdk.modules.IBaseWorkflowModule

abort, addAttachment, addAttachment, addAttachment, addAttachment, addChild, addMember, buildMailMessage, buildMailMessage, createCatalog, createCatalog, createDynamicLocalizationsWrapper, createGenericResource, createLinkedResource, createListOption, createOperatorRole, createProfile, createRole, createStorageResource, createStorageResource, createWorkflow, createWorkflowContainer, createWorkflowInstance, createWorkflowInstance, end, end, evaluatedHtml, evaluatedHtml, execute, execute, generateChrono, generateReference, generateReference, generateReference, generateReference, generateReference, getAbortedTaskInstances, getAction, getAction, getActions, getAgent, getAllCatalogs, getArchivingController, getAttachment, getAttachments, getCatalog, getCatalog, getCatalog, getCatalog, getCatalog, getCatalog, getCatalog, getCatalogs, getCatalogs, getCatalogs, getCatalogs, getCatalogViewTransformer, getConfiguration, getDataSourceReference, getDefaultDataSourceReference, getDelegationController, getElementByProtocolURI, getEndedTaskInstances, getExternalElements, getExternalFile, getExternalFolder, getExternalGroup, getExternalLibrary, getExternalLocalization, getExternalOrganization, getExternalUser, getForm, getForm, getForm, getForm, getGenericViewTransformer, getGroupByName, getJdbcReference, getJdbcReferences, getLinkedResources, getList, getList, getLists, getMailForm, getMailForms, getMailForms, getManualTaskInstances, getOneTaskInstance, getOperator, getOperator, getOperatorByLogin, getOperatorRole, getOperatorRole, getOperatorRoles, getOperators, getParentInstance, getParentInstance, getProfile, getProfile, getProfiles, getProperties, getProperty, getProperty, getResource, getResource, getResource, getResourceDefinition, getResourceDefinition, getResourceDefinitions, getResources, getResources, getResourceViewTransformer, getRole, getRole, getRoles, getSearchController, getSearchController, getSearchController, getSearchController, getSearchViewTransformer, getSecurityController, getStartedTaskInstances, getSubForm, getTask, getTask, getTask, getTaskInstance, getTaskInstance, getTaskInstance, getTaskInstances, getTaskInstances, getTaskInstanceTransformer, getTaskViewTransformer, getTransformer, getUser, getUser, getUserByLogin, getValue, getView, getView, getView, getViewController, getViewController, getViewController, getViewController, getViewController, getViewController, getViews, getViews, getViews, getWorkflow, getWorkflow, getWorkflow, getWorkflow, getWorkflowContainer, getWorkflowContainer, getWorkflowContainer, getWorkflowContainers, getWorkflowContainerViewTransformer, getWorkflowInstance, getWorkflowInstance, getWorkflowInstance, getWorkflowInstances, getWorkflowInstances, getWorkflowInstances, getWorkflowInstances, getWorkflowInstances, getWorkflows, getWorkflows, getWorkflowViewTransformer, isMemberOf, isMemberOf, remind, remind, send, send, send, send, send, send, send, send, send, setDynamicLocalizationsWrapperMessageForLanguage, setExternalElements, setExternalFile, setExternalFolder, setExternalGroup, setExternalLibrary, setExternalLocalization, setExternalOrganization, setExternalUser, setList, setValue

Methods inherited from interface com.axemble.vdoc.sdk.modules.IModule

beginTransaction, beginTransaction, commitTransaction, commitTransaction, convertId, findNativeClass, generateSystemName, getAnonymous, getAnonymousContext, getContext, getContext, getContextByLogin, getElementFromExternalElement, getExternalElement, getExternalElement, getLoggedOnUser, getLoggedOnUserContext, getLoggedOnUserLanguage, getProtocolPath, getProtocolPath, getProtocolURI, getProtocolURI, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getSysadmin, getSysadminContext, getTranslation, getTranslationForLanguage, getTranslationKey, initialize, isTransactionActive, rollbackTransaction, rollbackTransaction, setTransactionTimeout, unInitialize

Method Detail

getResourceController

IResourceController getResourceController(IResource resource)
                                   throws WorkflowModuleException

Gets the resource controller object.

Parameters:

resource - The main resource to work on.

Returns:

A IResourceController object.

Throws:

WorkflowModuleException - default module exception.

getController

IResourceController getController(IResource resource)
                           throws WorkflowModuleException

Gets the resource controller object.

Parameters:

resource - The main resource to work on.

Returns:

A IResourceController object.

Throws:

WorkflowModuleException - default module exception.

getDefinitionsFactory

com.axemble.vdoc.sdk.interfaces.ui.definitions.IDefinitionsFactory getDefinitionsFactory()

Gets access to all available definitions.

Returns:

IDefinitionsFactory object.

lock

void lock(IContext context,
          IWorkflowInstance workflowInstance,
          int delay)
   throws WorkflowModuleException

Allows to lock workflow instance.

Parameters:

context - The IContext execution context.

workflowInstance - The IWorkflowInstance object.

delay - lock delay in second

Throws:

WorkflowModuleException - default module exception.

unlock

void unlock(IContext context,
            IWorkflowInstance workflowInstance)
     throws WorkflowModuleException

Allows to unlock workflow instance.

Parameters:

context - The IContext execution context.

workflowInstance - The IWorkflowInstance object.

Throws:

WorkflowModuleException - default module exception.

isLocked

boolean isLocked(IContext context,
                 IWorkflowInstance workflowInstance)
          throws WorkflowModuleException

Checks if a specified workflow instance is locked

Parameters:

context - The IContext execution context.

workflowInstance - The IWorkflowInstance object.

Returns:

true if the resource has been locked, false otherwise.

Throws:

WorkflowModuleException - default module exception.

lockedBy

Collection<IUser> lockedBy(IContext context,
                           IWorkflowInstance workflowInstance)
                    throws WorkflowModuleException

Retrieve the users who locked the workflow instance.

Parameters:

context - The IContext execution context.

workflowInstance - The IWorkflowInstance object.

Returns:

a list of IUser users.

Throws:

WorkflowModuleException - default module exception.

isLockBySDK

boolean isLockBySDK(IContext context,
                    IWorkflowInstance workflowInstance)
             throws WorkflowModuleException

Checks if a specified workflow instance is locked by the SDK

Parameters:

context - The IContext execution context.

workflowInstance - The IWorkflowInstance object.

Returns:

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

Throws:

WorkflowModuleException - default module exception.