Interface CMSWorkflowFacade
- All Known Implementing Classes:
DefaultCMSWorkflowFacade
public interface CMSWorkflowFacade
Facade interface which deals with methods to manage workflows with CmsItems attached to them.
-
Method Summary
Modifier and TypeMethodDescriptioncreateAndStartWorkflow(CMSWorkflowData workflowData) Creates and starts a workflow in the given catalog version with the workflow data provided.editWorkflow(String workflowCode, CMSWorkflowData workflowData) Updates the workflow with the provided data.findAllWorkflows(CMSWorkflowData workflowData, PageableData pageableData) Finds all workflows containing the given attachment for the specified workflow statuses.getSessionUserEditableItems(List<String> itemUids) Returns a list ofCMSWorkflowEditableItemDatathat informs whether each item is editable or not by the session user.getWorkflowForCode(String workflowCode) Returns the workflow by its code.performOperation(String workflowCode, CMSWorkflowOperationData cmsWorkflowOperationData) Performs different operations defined byCMSWorkflowOperationon the workflow.
-
Method Details
-
createAndStartWorkflow
Creates and starts a workflow in the given catalog version with the workflow data provided.- Parameters:
workflowData- - the data used to create the workflow.- Returns:
- The data of the newly created and started workflow
-
performOperation
CMSWorkflowData performOperation(String workflowCode, CMSWorkflowOperationData cmsWorkflowOperationData) Performs different operations defined byCMSWorkflowOperationon the workflow.- Parameters:
workflowCode- - the code corresponding to theWorkflowModelcmsWorkflowOperationData- - the DTO object containing all the information about operation to be performed- Returns:
- The data of the modified workflow.
- Throws:
UnknownIdentifierException- if a workflow cannot be found for the provided workflowCode.
-
findAllWorkflows
SearchResult<CMSWorkflowData> findAllWorkflows(CMSWorkflowData workflowData, PageableData pageableData) Finds all workflows containing the given attachment for the specified workflow statuses.- Parameters:
workflowData- - the workflow dto containing the attachment uuid and the workflow statuses that will be used to filter the result set.pageableData- - the pageable dto determining the page size and index.- Returns:
- the paginated result of workflow data
-
editWorkflow
Updates the workflow with the provided data.- Parameters:
workflowCode- - the code corresponding to theWorkflowModelworkflowData- - the workflow dto to be updated.- Returns:
- the updated workflow data.
- Throws:
UnknownIdentifierException- if a workflow cannot be found for the provided workflowCode.
-
getWorkflowForCode
Returns the workflow by its code.- Parameters:
workflowCode- - the workflow code- Returns:
- the workflow data
- Throws:
UnknownIdentifierException- if a workflow cannot be found for the provided workflowCode.
-
getSessionUserEditableItems
Returns a list ofCMSWorkflowEditableItemDatathat informs whether each item is editable or not by the session user.- Parameters:
itemUids- the list of item uids to verify.- Returns:
- the list of
CMSWorkflowEditableItemData
-