Package org.craftercms.studio.api.v1.service.workflow

Interface WorkflowService

All Known Implementing Classes:

WorkflowServiceImpl

public interface WorkflowService

Method Summary

Modifier and Type	Method	Description
boolean	cleanWorkflow(String url, String site)
void	fillQueue(String site, GoLiveQueue goLiveQueue, GoLiveQueue inProcessQueue)
Map<String,Object>	getGoLiveItems(String site, String sort, boolean ascending)
Map<String,Object>	getInProgressItems(String site, String sort, boolean ascending, boolean inProgressOnly)
ResultTO	goDelete(String site, String request)	approve workflows and schedule them as specified in the request
ResultTO	goLive(String site, String request)	approve workflows and schedule them as specified in the request
Map<ZonedDateTime,List<DmDependencyTO>>	groupByDate(List<DmDependencyTO> submittedItems, ZonedDateTime now)
boolean	isRescheduleRequest(DmDependencyTO dependencyTO, String site)
List<String>	preDelete(Set<String> urisToDelete, GoLiveContext context, Set<String> rescheduledUris)
void	preScheduleDelete(Set<String> uris, ZonedDateTime _date, GoLiveContext context)
ResultTO	reject(String site, String request)
boolean	removeFromWorkflow(String site, String path, boolean cancelWorkflow)	cancel the workflow pending on the given item.
ResultTO	submitToGoLive(String site, String username, String request)

Method Details

submitToGoLive

ResultTO submitToGoLive(String site,
 String username,
 String request)

getGoLiveItems

Map<String,Object> getGoLiveItems(String site,
 String sort,
 boolean ascending)
                           throws ServiceLayerException

Throws:

ServiceLayerException

getInProgressItems

Map<String,Object> getInProgressItems(String site,
 String sort,
 boolean ascending,
 boolean inProgressOnly)

removeFromWorkflow

boolean removeFromWorkflow(String site,
 String path,
 boolean cancelWorkflow)
                    throws ServiceLayerException,
UserNotFoundException

cancel the workflow pending on the given item.

Parameters:

site - site identifier

path - path of the content

cancelWorkflow - cancel the pending workflow instance this content belongs to?

Returns:

true if success, otherwise false

Throws:

ServiceLayerException - general service error

UserNotFoundException

goDelete

ResultTO goDelete(String site,
 String request)

approve workflows and schedule them as specified in the request

Parameters:

site - site identifier

request - request body

Returns:

call result

groupByDate

Map<ZonedDateTime,List<DmDependencyTO>> groupByDate(List<DmDependencyTO> submittedItems,
 ZonedDateTime now)

preScheduleDelete

void preScheduleDelete(Set<String> uris,
 ZonedDateTime _date,
 GoLiveContext context)

preDelete

List<String> preDelete(Set<String> urisToDelete,
 GoLiveContext context,
 Set<String> rescheduledUris)
                throws ServiceLayerException,
UserNotFoundException

Throws:

ServiceLayerException

UserNotFoundException

isRescheduleRequest

boolean isRescheduleRequest(DmDependencyTO dependencyTO,
 String site)

goLive

ResultTO goLive(String site,
 String request)
         throws ServiceLayerException

approve workflows and schedule them as specified in the request

Parameters:

site - site identifier

request - request body

Returns:

call result

Throws:

ServiceLayerException - general service error

reject

ResultTO reject(String site,
 String request)
         throws ServiceLayerException

Throws:

ServiceLayerException

fillQueue

void fillQueue(String site,
 GoLiveQueue goLiveQueue,
 GoLiveQueue inProcessQueue)

cleanWorkflow

boolean cleanWorkflow(String url,
 String site)
               throws ServiceLayerException,
UserNotFoundException

Throws:

ServiceLayerException

UserNotFoundException