|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@StableMinor(version="4.1", sinceVersion="4.0") public interface IWorkflowManager
Interface for Workflow Manager.
Field Summary | |
---|---|
static String |
ASSIGNED_TO_KEEP_SAME_VALUE
The value used by some methods to indicate that the current assigned to value must be kept. |
Method Summary | |
---|---|
boolean |
autoArchivePublishedContent(String metaDataId,
ITransaction transaction)
Used for the automatic content archiving process. |
boolean |
contentMayBePublished(SessionConfig sessionConfig,
String itemId,
String serviceInstanceId,
String sourceId,
ITransaction transaction)
|
void |
createNewContentWorkflowMetaData(SessionConfig sessionConfig,
String itemId,
String serviceInstanceId,
String sourceId,
String assignedTo,
ITransaction transaction)
Creates the content workflow metadata for a new content. |
void |
deleteAllContentWorkflowMetaData(SessionConfig sessionConfig,
String serviceInstanceId,
ITransaction transaction)
Deletes all the workflow metadata that is assocated to a specified service instance. |
void |
deleteContentWorkflowMetaData(SessionConfig sessionConfig,
String itemId,
String serviceInstanceId,
String sourceId,
ITransaction transaction)
Deletes the content workflow metadata of the given content. |
void |
destroyServiceInstanceWorkflow(SessionConfig sessionConfig,
String serviceInstanceId,
ITransaction transaction)
Destroys the service instance workflow, so that the service instance can be correctly removed. |
void |
executeAction(SessionConfig sessionConfig,
String itemId,
String serviceInstanceId,
String sourceId,
String performedTransitionId,
String newAssignedTo,
ITransaction transaction)
Executes an action on a content's workflow. |
Collection<WorkflowStateConfig> |
getAccessibleStates(SessionConfig sessionConfig,
String serviceInstanceId,
boolean includeScopeAll,
boolean includeScopeAssignedTo,
ITransaction transaction)
Returns a collection of workflow's accessible states. |
Collection<WorkflowTransitionConfig> |
getAccessibleTransitions(SessionConfig sessionConfig,
String itemId,
String serviceInstanceId,
String sourceId,
ITransaction transaction)
Returns the transitions that are accessible by the sessionConfig 's user for a specified content. |
Collection<WorkflowConfig> |
getAllWorkflows(SessionConfig sessionConfig,
ITransaction transaction)
Returns all registered workflows. |
ContentWorkflowMetaData |
getContentWorkflowMetaData(SessionConfig sessionConfig,
String metaDataId,
ITransaction transaction)
Returns the content workflow metadata for a metadata id. |
ContentWorkflowMetaData |
getContentWorkflowMetaData(SessionConfig sessionConfig,
String itemId,
String serviceInstanceId,
String sourceId,
ITransaction transaction)
Returns the content workflow metadata for a content. |
Collection<String> |
getPossibleAssignedToForAction(SessionConfig sessionConfig,
String itemId,
String serviceInstanceId,
String sourceId,
String transitionId,
ITransaction transaction)
Returns the possible assignedTo values for a workflow transition. |
WorkflowConfig |
getServiceInstanceWorkflow(SessionConfig sessionConfig,
String serviceInstanceId,
ITransaction transaction)
Returns the workflow of a service instance. |
WorkflowStateConfig |
getState(SessionConfig sessionConfig,
String workflowId,
String stateId,
ITransaction transaction)
Returns a workflow state. |
WorkflowTransitionConfig |
getTransition(SessionConfig sessionConfig,
String workflowId,
String transitionId,
ITransaction transaction)
Returns a workflow transition. |
List<WorkflowTransitionConfig> |
getTransitionsByStateId(SessionConfig sessionConfig,
String workflowId,
String stateId,
ITransaction transaction)
Returns the transitions for a workflow state. |
WorkflowConfig |
getWorkflow(SessionConfig sessionConfig,
String workflowId,
ITransaction transaction)
Returns a workflow. |
Collection<WorkflowPermission> |
getWorkflowPermissions(SessionConfig sessionConfig,
String serviceInstanceId,
ITransaction transaction)
Returns the permissions set for a workflow in a service instance. |
boolean |
hasEditPermission(SessionConfig sessionConfig,
String itemId,
String serviceInstanceId,
String sourceId,
ITransaction transaction)
Returns true if the sessionConfig's user has edit permission to the specified item, according to the workflow's definition, state and assigned to. |
void |
register(SessionConfig sessionConfig,
String workflowConfigPath,
ITransaction transaction)
Register a workflow. |
void |
setServiceInstanceWorkflow(SessionConfig sessionConfig,
String serviceInstanceId,
String workflowId,
ITransaction transaction)
Sets the workflow to be used in a service instance. |
void |
setWorkflowPermissions(SessionConfig sessionConfig,
String serviceInstanceId,
Collection<WorkflowPermission> permissions,
ITransaction transaction)
Updates the workflow permissions in a service instance. |
void |
unregister(SessionConfig sessionConfig,
String workflowId,
ITransaction transaction)
Removes a workflow from the register. |
void |
updateRegister(SessionConfig sessionConfig,
String workflowId,
ITransaction transaction)
Updates the register of a workflow. |
Field Detail |
---|
static final String ASSIGNED_TO_KEEP_SAME_VALUE
Method Detail |
---|
void register(SessionConfig sessionConfig, String workflowConfigPath, ITransaction transaction) throws PortalException
sessionConfig
- the user session information.workflowConfigPath
- the path, relative to the definition directory,
to the directory with the workflow's definition.transaction
- the transaction for persistence access.
PortalException
void updateRegister(SessionConfig sessionConfig, String workflowId, ITransaction transaction) throws PortalException
sessionConfig
- the user session information.workflowId
- the workflow id.transaction
- the transaction for persistence access.
PortalException
void unregister(SessionConfig sessionConfig, String workflowId, ITransaction transaction) throws PortalException
sessionConfig
- the user session information.workflowId
- the workflow's identifier.transaction
- the transaction for persistence access.
PortalException
WorkflowConfig getWorkflow(SessionConfig sessionConfig, String workflowId, ITransaction transaction) throws PortalException
sessionConfig
- the user session information.workflowId
- the workflow's identifier.transaction
- the transaction for persistence access.
PortalException
WorkflowStateConfig getState(SessionConfig sessionConfig, String workflowId, String stateId, ITransaction transaction) throws PortalException
sessionConfig
- the user session information.workflowId
- the identifier of the state's workflow.stateId
- the state's identifier.transaction
- the transaction for persistence access.
PortalException
WorkflowTransitionConfig getTransition(SessionConfig sessionConfig, String workflowId, String transitionId, ITransaction transaction) throws PortalException
sessionConfig
- the user session information.workflowId
- the identifier of the state's workflow.transitionId
- the transition's identifier.transaction
- the transaction for persistence access.
PortalException
List<WorkflowTransitionConfig> getTransitionsByStateId(SessionConfig sessionConfig, String workflowId, String stateId, ITransaction transaction) throws PortalException
sessionConfig
- the user session information.workflowId
- the identifier of the state's workflow.stateId
- the state's identifier.transaction
- the transaction for persistence access.
PortalException
Collection<WorkflowTransitionConfig> getAccessibleTransitions(SessionConfig sessionConfig, String itemId, String serviceInstanceId, String sourceId, ITransaction transaction) throws PortalException
sessionConfig
's user for a specified content.
sessionConfig
- the user session information.itemId
- the content's itemId.serviceInstanceId
- the content's service instance identifier.sourceId
- the content's source identifier.transaction
- the transaction for persistence access.
PortalException
Collection<WorkflowStateConfig> getAccessibleStates(SessionConfig sessionConfig, String serviceInstanceId, boolean includeScopeAll, boolean includeScopeAssignedTo, ITransaction transaction) throws PortalException
sessionConfig
- user session information.serviceInstanceId
- the content service instance id.includeScopeAll
- if the states with permission scope all are to be included.includeScopeAssignedTo
- if the states with permission scope assigned to are to be included.transaction
- the transaction for persistence acecess.
PortalException
WorkflowConfig getServiceInstanceWorkflow(SessionConfig sessionConfig, String serviceInstanceId, ITransaction transaction) throws PortalException
sessionConfig
- user session information.serviceInstanceId
- the service instance's id.transaction
- the transaction for persistence access.
PortalException
void setServiceInstanceWorkflow(SessionConfig sessionConfig, String serviceInstanceId, String workflowId, ITransaction transaction) throws PortalException
sessionConfig
- user session information.serviceInstanceId
- the service instance's id.workflowId
- the workflow's id.transaction
- the transaction for persistence access.
PortalException
void destroyServiceInstanceWorkflow(SessionConfig sessionConfig, String serviceInstanceId, ITransaction transaction) throws PortalException
sessionConfig
- user session information.serviceInstanceId
- the service instance's id.transaction
- the transaction for persistence access.
PortalException
void deleteAllContentWorkflowMetaData(SessionConfig sessionConfig, String serviceInstanceId, ITransaction transaction) throws PortalException
sessionConfig
- the user session information.serviceInstanceId
- the service instance identifier.transaction
- the transaction for persistence access.
PortalException
Collection<WorkflowConfig> getAllWorkflows(SessionConfig sessionConfig, ITransaction transaction) throws PortalException
sessionConfig
- the user session information.transaction
- the transaction for persistence access.
PortalException
Collection<WorkflowPermission> getWorkflowPermissions(SessionConfig sessionConfig, String serviceInstanceId, ITransaction transaction) throws PortalException
sessionConfig
- user session information.serviceInstanceId
- the service instance's id.transaction
- the transaction for persistence access.
PortalException
void setWorkflowPermissions(SessionConfig sessionConfig, String serviceInstanceId, Collection<WorkflowPermission> permissions, ITransaction transaction) throws PortalException
sessionConfig
- user session information.serviceInstanceId
- the service instance's id.permissions
- the set of permissions to be set in the service instance. All
previous permissions will be deleted.transaction
- the transaction for persistence access.
PortalException
ContentWorkflowMetaData getContentWorkflowMetaData(SessionConfig sessionConfig, String metaDataId, ITransaction transaction) throws PortalException
sessionConfig
- user session information.metaDataId
- the metadata's id.transaction
- the transaction for persistence access.
PortalException
ContentWorkflowMetaData getContentWorkflowMetaData(SessionConfig sessionConfig, String itemId, String serviceInstanceId, String sourceId, ITransaction transaction) throws PortalException
sessionConfig
- user session information.itemId
- the content's item id.serviceInstanceId
- the content's service instance id.sourceId
- the content's source id.transaction
- the transaction for persistence access.
PortalException
void createNewContentWorkflowMetaData(SessionConfig sessionConfig, String itemId, String serviceInstanceId, String sourceId, String assignedTo, ITransaction transaction) throws PortalException
sessionConfig
- user session information.itemId
- the content's item id.serviceInstanceId
- the content's service instance id.sourceId
- the content's source id.assignedTo
- transaction
- the transaction for persistence access.
PortalException
void deleteContentWorkflowMetaData(SessionConfig sessionConfig, String itemId, String serviceInstanceId, String sourceId, ITransaction transaction) throws PortalException
sessionConfig
- user session information.itemId
- the content's item id.serviceInstanceId
- the content's service instance id.sourceId
- the content's source id.transaction
- the transaction for persistence access.
PortalException
void executeAction(SessionConfig sessionConfig, String itemId, String serviceInstanceId, String sourceId, String performedTransitionId, String newAssignedTo, ITransaction transaction) throws PortalException
sessionConfig
- user session information.itemId
- the content's item id.serviceInstanceId
- the content's service instance id.sourceId
- the content's source id.performedTransitionId
- the transition action performed. If null, no transition is
performed.newAssignedTo
- the new assigned to principal id.transaction
- the transaction for persistence access.
PortalException
boolean hasEditPermission(SessionConfig sessionConfig, String itemId, String serviceInstanceId, String sourceId, ITransaction transaction) throws PortalException
If there is no workflow, or no content workflow metadata, true is returned.
sessionConfig
- user session information.itemId
- the content's item id.serviceInstanceId
- the content's service instance id.sourceId
- the content's source id.transaction
- the transaction for persistence access.
PortalException
Collection<String> getPossibleAssignedToForAction(SessionConfig sessionConfig, String itemId, String serviceInstanceId, String sourceId, String transitionId, ITransaction transaction) throws PortalException
sessionConfig
- user session information.serviceInstanceId
- the content's service instance id.sourceId
- the content's source id.transitionId
- the workflow's transition id.transaction
- the transaction for persistence access.
PortalException
boolean contentMayBePublished(SessionConfig sessionConfig, String itemId, String serviceInstanceId, String sourceId, ITransaction transaction) throws PortalException
sessionConfig
- user session information.itemId
- the content's item id.serviceInstanceId
- the content's service instance id.sourceId
- the content's source id.transaction
- the transaction for persistence access.
PortalException
boolean autoArchivePublishedContent(String metaDataId, ITransaction transaction) throws PortalException
metaDataId
- the content's metadata id.transaction
- the transaction for persistence access.
PortalException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |