Package org.craftercms.studio.api.v2.dal
Interface WorkflowDAO
-
public interface WorkflowDAO
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
deleteWorkflowEntries(String siteId, List<String> paths)
Delete workflow entriesvoid
deleteWorkflowEntriesForSite(long siteId)
Delete workflow entries for sitevoid
deleteWorkflowEntry(String siteId, String path)
Delete workflow entryvoid
deleteWorkflowEntryById(long id)
Delete workflow entryList<DashboardPublishingPackage>
getContentPendingApproval(String siteId, String openedState, int offset, int limit)
Get workflow packages pending approvalList<Workflow>
getContentPendingApprovalDetail(String siteId, String packageId)
Get content pending approval for given workflow package idOptional<Integer>
getContentPendingApprovalTotal(String siteId, String openedState)
Get total number of workflow packages pending approvalList<WorkflowItem>
getSubmittedItems(String site, String stateOpened)
Get submitted itemsWorkflow
getWorkflowEntry(String siteId, String path, String publishingPackageId)
Get workflow entryWorkflow
getWorkflowEntryForApproval(Long itemId, String stateOpened)
Get workflow entry for approvalWorkflowItem
getWorkflowEntryOpened(String siteId, String path, String stateOpened)
Get workflow entryvoid
insertWorkflowEntries(List<Workflow> workflowEntries)
Insert workflow entriesvoid
insertWorkflowEntry(Workflow workflow)
Insert workflow entryvoid
updateWorkflowEntry(Workflow workflow)
Update workflow entry
-
-
-
Method Detail
-
getWorkflowEntryOpened
WorkflowItem getWorkflowEntryOpened(@Param("siteId") String siteId, @Param("path") String path, @Param("stateOpened") String stateOpened)
Get workflow entry- Parameters:
siteId
- site identifierpath
- path of the itemstateOpened
- state opened- Returns:
-
getWorkflowEntryForApproval
Workflow getWorkflowEntryForApproval(@Param("itemId") Long itemId, @Param("stateOpened") String stateOpened)
Get workflow entry for approval- Parameters:
itemId
- item identifierstateOpened
- state opened- Returns:
-
getWorkflowEntry
Workflow getWorkflowEntry(@Param("siteId") String siteId, @Param("path") String path, @Param("publishingPackageId") String publishingPackageId)
Get workflow entry- Parameters:
siteId
- site identifierpath
-publishingPackageId
-- Returns:
-
deleteWorkflowEntryById
void deleteWorkflowEntryById(@Param("id") long id)
Delete workflow entry- Parameters:
id
- entry id
-
insertWorkflowEntry
void insertWorkflowEntry(@Param("workflow") Workflow workflow)
Insert workflow entry- Parameters:
workflow
- workflow entry
-
insertWorkflowEntries
void insertWorkflowEntries(@Param("workflowEntries") List<Workflow> workflowEntries)
Insert workflow entries- Parameters:
workflowEntries
- list of workflow entries
-
updateWorkflowEntry
void updateWorkflowEntry(Workflow workflow)
Update workflow entry- Parameters:
workflow
- workflow entry
-
getSubmittedItems
List<WorkflowItem> getSubmittedItems(@Param("siteId") String site, @Param("state") String stateOpened)
Get submitted items- Parameters:
site
- site identifierstateOpened
- state opened- Returns:
-
deleteWorkflowEntries
void deleteWorkflowEntries(@Param("siteId") String siteId, @Param("paths") List<String> paths)
Delete workflow entries- Parameters:
siteId
- site identifierpaths
- list of paths
-
deleteWorkflowEntry
void deleteWorkflowEntry(@Param("siteId") String siteId, @Param("path") String path)
Delete workflow entry- Parameters:
siteId
- site identifierpath
- path
-
deleteWorkflowEntriesForSite
void deleteWorkflowEntriesForSite(long siteId)
Delete workflow entries for site- Parameters:
siteId
- site id
-
getContentPendingApprovalTotal
Optional<Integer> getContentPendingApprovalTotal(@Param("siteId") String siteId, @Param("state") String openedState)
Get total number of workflow packages pending approval- Parameters:
siteId
- site identifieropenedState
- value for OPENED state- Returns:
- total number of workflow packages pending approval
-
getContentPendingApproval
List<DashboardPublishingPackage> getContentPendingApproval(@Param("siteId") String siteId, @Param("state") String openedState, @Param("offset") int offset, @Param("limit") int limit)
Get workflow packages pending approval- Parameters:
siteId
- site identifieropenedState
- value for OPENED stateoffset
- offset of the first record in the resultlimit
- limit number of results- Returns:
- list of workflow packages pending approval
-
getContentPendingApprovalDetail
List<Workflow> getContentPendingApprovalDetail(@Param("siteId") String siteId, @Param("packageId") String packageId)
Get content pending approval for given workflow package id- Parameters:
siteId
- site identifierpackageId
- workflow package identifier- Returns:
- List of workflow entries
-
-