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

Class WorkflowServiceInternalImpl

java.lang.Object

org.craftercms.studio.impl.v2.service.workflow.internal.WorkflowServiceInternalImpl

All Implemented Interfaces:

WorkflowServiceInternal

public class WorkflowServiceInternalImpl
extends Object
implements WorkflowServiceInternal

Constructor Summary

Constructors

Constructor	Description
WorkflowServiceInternalImpl(DependencyServiceInternal dependencyService, RetryingDatabaseOperationFacade retryingDatabaseOperationFacade, WorkflowDAO workflowDao)

Method Summary

Modifier and Type	Method	Description
void	deleteWorkflowEntries(String siteId, Collection<String> paths)	Delete workflow entries for given site and paths
void	deleteWorkflowEntries(String siteId, Collection<String> paths, String workflowState)	Delete workflow entries for given site and paths matching the workflow state
void	deleteWorkflowEntriesForSite(long siteId)	Delete workflow entries for given site
void	deleteWorkflowEntry(String siteId, String path)	Delete workflow entry for given site and path
void	deleteWorkflowPackages(String siteId, Collection<String> affectedPackages)	Delete workflow packages matching the affected package ids
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
Collection<String>	getWorkflowAffectedPaths(String siteId, String path)	Get workflow affected paths if content is edited
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
Collection<String>	getWorkflowHardDeps(String siteId, String path)	Get the path hard dependencies that are currently in workflow
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WorkflowServiceInternalImpl

@ConstructorProperties({"dependencyService","retryingDatabaseOperationFacade","workflowDao"})
public WorkflowServiceInternalImpl(DependencyServiceInternal dependencyService,
 RetryingDatabaseOperationFacade retryingDatabaseOperationFacade,
 WorkflowDAO workflowDao)

Method Details

getWorkflowItem

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

Specified by:

getWorkflowItem in interface WorkflowServiceInternal

getWorkflowEntry

public WorkflowItem getWorkflowEntry(String siteId,
 String path)

Description copied from interface: WorkflowServiceInternal

Get workflow entry

Specified by:

getWorkflowEntry in interface WorkflowServiceInternal

Parameters:

siteId -

path -

Returns:

getWorkflowEntryForApproval

public Workflow getWorkflowEntryForApproval(Long itemId)

Description copied from interface: WorkflowServiceInternal

Get workflow entry for approval

Specified by:

getWorkflowEntryForApproval in interface WorkflowServiceInternal

Parameters:

itemId - item identifier

Returns:

getWorkflowEntry

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

Description copied from interface: WorkflowServiceInternal

Get workflow entry

Specified by:

getWorkflowEntry in interface WorkflowServiceInternal

Parameters:

siteId -

path -

publishingPackageId -

Returns:

insertWorkflow

public void insertWorkflow(Workflow workflow)

Description copied from interface: WorkflowServiceInternal

insert new workflow entry

Specified by:

insertWorkflow in interface WorkflowServiceInternal

Parameters:

workflow - workflow entry

insertWorkflowEntries

public void insertWorkflowEntries(List<Workflow> workflowEntries)

Description copied from interface: WorkflowServiceInternal

insert new workflow entries

Specified by:

insertWorkflowEntries in interface WorkflowServiceInternal

Parameters:

workflowEntries - list of workflow entries

updateWorkflow

public void updateWorkflow(Workflow workflow)

Description copied from interface: WorkflowServiceInternal

Update new workflow entry

Specified by:

updateWorkflow in interface WorkflowServiceInternal

Parameters:

workflow - workflow entry

getSubmittedItems

public List<WorkflowItem> getSubmittedItems(String site)

Description copied from interface: WorkflowServiceInternal

Get submitted items for site

Specified by:

getSubmittedItems in interface WorkflowServiceInternal

Parameters:

site - site identifier

Returns:

deleteWorkflowEntries

public void deleteWorkflowEntries(String siteId,
 Collection<String> paths)

Description copied from interface: WorkflowServiceInternal

Delete workflow entries for given site and paths

Specified by:

deleteWorkflowEntries in interface WorkflowServiceInternal

Parameters:

siteId - site identifier

paths - list of paths to delete workflow

deleteWorkflowEntries

public void deleteWorkflowEntries(String siteId,
 Collection<String> paths,
 String workflowState)

Description copied from interface: WorkflowServiceInternal

Delete workflow entries for given site and paths matching the workflow state

Specified by:

deleteWorkflowEntries in interface WorkflowServiceInternal

Parameters:

siteId - site identifier

paths - list of paths to delete workflow

workflowState - workflow state to match

deleteWorkflowEntry

public void deleteWorkflowEntry(String siteId,
 String path)

Description copied from interface: WorkflowServiceInternal

Delete workflow entry for given site and path

Specified by:

deleteWorkflowEntry in interface WorkflowServiceInternal

Parameters:

siteId - site identifier

path - path to delete workflow

deleteWorkflowEntriesForSite

public void deleteWorkflowEntriesForSite(long siteId)

Description copied from interface: WorkflowServiceInternal

Delete workflow entries for given site

Specified by:

deleteWorkflowEntriesForSite in interface WorkflowServiceInternal

Parameters:

siteId - site id

getContentPendingApprovalTotal

public int getContentPendingApprovalTotal(String siteId)

Description copied from interface: WorkflowServiceInternal

Get total number of workflow packages pending approval

Specified by:

getContentPendingApprovalTotal in interface WorkflowServiceInternal

Parameters:

siteId - site identifier

Returns:

total number of workflow packages

getContentPendingApproval

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

Description copied from interface: WorkflowServiceInternal

Get workflow packages pending approval

Specified by:

getContentPendingApproval in interface WorkflowServiceInternal

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

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

Description copied from interface: WorkflowServiceInternal

Get items from workflow package pending approval

Specified by:

getContentPendingApprovalDetail in interface WorkflowServiceInternal

Parameters:

siteId - site identifier

packageId - workflow package identifier

Returns:

list of workflow entries

getWorkflowAffectedPaths

public Collection<String> getWorkflowAffectedPaths(String siteId,
 String path)
                                            throws ServiceLayerException

Description copied from interface: WorkflowServiceInternal

Get workflow affected paths if content is edited

Specified by:

getWorkflowAffectedPaths in interface WorkflowServiceInternal

Parameters:

siteId - site identifier

path - path of the content to be edited

Returns:

List of sandbox items that will be taken out of workflow after edit

Throws:

ServiceLayerException

getWorkflowHardDeps

public Collection<String> getWorkflowHardDeps(String siteId,
 String path)
                                       throws ServiceLayerException

Description copied from interface: WorkflowServiceInternal

Get the path hard dependencies that are currently in workflow

Specified by:

getWorkflowHardDeps in interface WorkflowServiceInternal

Parameters:

siteId - the site identifier

path - the path to get hard dependencies for

Returns:

collection of paths that are hard dependencies of path and are in workflow

Throws:

ServiceLayerException - if an error occurs while getting the hard dependencies

deleteWorkflowPackages

public void deleteWorkflowPackages(String siteId,
 Collection<String> affectedPackages)

Description copied from interface: WorkflowServiceInternal

Delete workflow packages matching the affected package ids

Specified by:

deleteWorkflowPackages in interface WorkflowServiceInternal

Parameters:

siteId - the site identifier

affectedPackages - the affected package ids to delete