Package org.craftercms.studio.api.v2.service.workflow.internal

Interface WorkflowServiceInternal

All Known Implementing Classes:

WorkflowServiceInternalImpl

public interface WorkflowServiceInternal

Method Summary

Modifier and Type	Method	Description
void	deleteWorkflowEntries(String site, List<String> paths)	Delete workflow entries for given site and paths
void	deleteWorkflowEntriesForSite(long siteId)	Delete workflow entries for given site
void	deleteWorkflowEntry(String site, String path)	Delete workflow entry for given site and path
List<DashboardPublishingPackage>	getContentPendingApproval(String siteId, int offset, int limit)	Get workflow packages pending approval
List<Workflow>	getContentPendingApprovalDetail(String siteId, String packageId)	Get items from workflow package pending approval
int	getContentPendingApprovalTotal(String siteId)	Get total number of workflow packages pending approval
List<WorkflowItem>	getSubmittedItems(String site)	Get submitted items for site
WorkflowItem	getWorkflowEntry(String siteId, String path)	Get workflow entry
Workflow	getWorkflowEntry(String siteId, String path, String publishingPackageId)	Get workflow entry
Workflow	getWorkflowEntryForApproval(Long itemId)	Get workflow entry for approval
WorkflowItem	getWorkflowItem(String siteId, String path, String state)
void	insertWorkflow(Workflow workflow)	insert new workflow entry
void	insertWorkflowEntries(List<Workflow> workflowEntries)	insert new workflow entries
void	updateWorkflow(Workflow workflow)	Update new workflow entry

Method Detail

getWorkflowItem

WorkflowItem getWorkflowItem(String siteId,
                             String path,
                             String state)

getWorkflowEntry

WorkflowItem getWorkflowEntry(String siteId,
                              String path)

Get workflow entry

Parameters:

siteId -

path -

Returns:

getWorkflowEntryForApproval

Workflow getWorkflowEntryForApproval(Long itemId)

Get workflow entry for approval

Parameters:

itemId - item identifier

Returns:

getWorkflowEntry

Workflow getWorkflowEntry(String siteId,
                          String path,
                          String publishingPackageId)

Get workflow entry

Parameters:

siteId -

path -

publishingPackageId -

Returns:

insertWorkflow

void insertWorkflow(Workflow workflow)

insert new workflow entry

Parameters:

workflow - workflow entry

insertWorkflowEntries

void insertWorkflowEntries(List<Workflow> workflowEntries)

insert new workflow entries

Parameters:

workflowEntries - list of workflow entries

updateWorkflow

void updateWorkflow(Workflow workflow)

Update new workflow entry

Parameters:

workflow - workflow entry

getSubmittedItems

List<WorkflowItem> getSubmittedItems(String site)

Get submitted items for site

Parameters:

site - site identifier

Returns:

deleteWorkflowEntries

void deleteWorkflowEntries(String site,
                           List<String> paths)

Delete workflow entries for given site and paths

Parameters:

site - site identifier

paths - list of paths to delete workflow

deleteWorkflowEntry

void deleteWorkflowEntry(String site,
                         String path)

Delete workflow entry for given site and path

Parameters:

site - site identifier

path - path to delete workflow

deleteWorkflowEntriesForSite

void deleteWorkflowEntriesForSite(long siteId)

Delete workflow entries for given site

Parameters:

siteId - site id

getContentPendingApprovalTotal

int getContentPendingApprovalTotal(String siteId)

Get total number of workflow packages pending approval

Parameters:

siteId - site identifier

Returns:

total number of workflow packages

getContentPendingApproval

List<DashboardPublishingPackage> getContentPendingApproval(String siteId,
                                                           int offset,
                                                           int limit)

Get workflow packages pending approval

Parameters:

siteId - site identifier

offset - offset of the first record in the result

limit - limit number of records in the result

Returns:

list of workflow packages

getContentPendingApprovalDetail

List<Workflow> getContentPendingApprovalDetail(String siteId,
                                               String packageId)

Get items from workflow package pending approval

Parameters:

siteId - site identifier

packageId - workflow package identifier

Returns:

list of workflow entries