public interface IWorkflowModule extends IBaseWorkflowModule
Code sample :
// creation of a workflow module object
IWorkflowModule workflowModule = Modules.getWorkflowModule();
try
{
}
finally
{
// uninitialize the module
Modules.releaseModule(workflowModule);
}
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.
|
String |
getListLabel(ICatalog catalog,
String listName,
String key,
String language)
get translated value of a list
|
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.
|
abort, addAttachment, addAttachment, addAttachment, addAttachment, addChild, addMember, buildMailMessage, buildMailMessage, canDeleteDiscussionMessage, canModifyDiscussionMessage, createCatalog, createCatalog, createDiscussionMessage, createDynamicLocalizationsWrapper, createGenericResource, createLinkedResource, createListOption, createOperatorRole, createProfile, createRole, createStorageResource, createStorageResource, createWorkflow, createWorkflowContainer, createWorkflowInstance, createWorkflowInstance, deleteDiscussionMessage, end, end, evaluatedHtml, evaluatedHtml, execute, execute, findStorageResourceByReference, 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, getDiscussionMessagesOrderByCreationDateDesc, 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, getManualTaskInstancesByStatus, getManualTaskInstancesModifiedSince, 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, hasDiscussionThread, isMemberOf, isMemberOf, remind, remind, send, send, send, send, send, send, send, send, send, setDynamicLocalizationsWrapperMessageForLanguage, setExternalElements, setExternalFile, setExternalFolder, setExternalGroup, setExternalLibrary, setExternalLocalization, setExternalOrganization, setExternalUser, setList, setValue, updateDiscussionMessage
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
IResourceController getResourceController(IResource resource) throws WorkflowModuleException
resource
- The main resource to work on.IResourceController
object.WorkflowModuleException
- default module exception.IResourceController getController(IResource resource) throws WorkflowModuleException
resource
- The main resource to work on.IResourceController
object.WorkflowModuleException
- default module exception.com.axemble.vdoc.sdk.interfaces.ui.definitions.IDefinitionsFactory getDefinitionsFactory()
IDefinitionsFactory
object.void lock(IContext context, IWorkflowInstance workflowInstance, int delay) throws WorkflowModuleException
context
- The IContext
execution context.workflowInstance
- The IWorkflowInstance
object.delay
- lock delay in secondWorkflowModuleException
- default module exception.void unlock(IContext context, IWorkflowInstance workflowInstance) throws WorkflowModuleException
context
- The IContext
execution context.workflowInstance
- The IWorkflowInstance
object.WorkflowModuleException
- default module exception.boolean isLocked(IContext context, IWorkflowInstance workflowInstance) throws WorkflowModuleException
context
- The IContext
execution context.workflowInstance
- The IWorkflowInstance
object.WorkflowModuleException
- default module exception.Collection<IUser> lockedBy(IContext context, IWorkflowInstance workflowInstance) throws WorkflowModuleException
context
- The IContext
execution context.workflowInstance
- The IWorkflowInstance
object.IUser
users.WorkflowModuleException
- default module exception.boolean isLockBySDK(IContext context, IWorkflowInstance workflowInstance) throws WorkflowModuleException
context
- The IContext
execution context.workflowInstance
- The IWorkflowInstance
object.WorkflowModuleException
- default module exception.String getListLabel(ICatalog catalog, String listName, String key, String language) throws WorkflowModuleException
catalog
- The ICatalog
link to the listlistName
- list namekey
- key of the valuelanguage
- languageWorkflowModuleException
- when list is missingCopyright © 2024 Visiativ. All rights reserved.