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

Interface WorkflowService

All Known Implementing Classes:

WorkflowServiceImpl

public interface WorkflowService

Method Summary

Modifier and Type	Method	Description
void	approve(String siteId, List<String> paths, List<String> optionalDependencies, String publishingTarget, ZonedDateTime schedule, String comment)	Approve request for publish
void	delete(String siteId, List<String> paths, List<String> optionalDependencies, String comment)	Delete content items
List<SandboxItem>	getItemStates(String siteId, String path, Long states, int offset, int limit)	Get item states for given filters by path regex and states mask
int	getItemStatesTotal(String siteId, String path, Long states)	Get total number of item states records for given filters by path regex and states mask
List<SandboxItem>	getWorkflowAffectedPaths(String siteId, String path)	Get workflow affected paths if content is edited
void	publish(String siteId, List<String> paths, List<String> optionalDependencies, String publishingTarget, ZonedDateTime schedule, String comment)	Direct publish content
void	reject(String siteId, List<String> paths, String comment)	Reject request for publish
void	requestPublish(String siteId, List<String> paths, List<String> optionalDependencies, String publishingTarget, ZonedDateTime schedule, String comment, boolean sendEmailNotifications)	Request approval for content to be published
void	updateItemStates(String siteId, List<String> paths, boolean clearSystemProcessing, boolean clearUserLocked, Boolean live, Boolean staged, Boolean isNew, Boolean modified)	Update item state flags for given items
void	updateItemStatesByQuery(String siteId, String path, Long states, boolean clearSystemProcessing, boolean clearUserLocked, Boolean live, Boolean staged, Boolean isNew, Boolean modified)	Update item state flags for given path query

Method Details

getItemStatesTotal

int getItemStatesTotal(String siteId,
 String path,
 Long states)
                throws SiteNotFoundException

Get total number of item states records for given filters by path regex and states mask

Parameters:

siteId - site identifier

path - path regex to filter items

states - states mask to filter items by state

Returns:

number of records

Throws:

SiteNotFoundException

getItemStates

List<SandboxItem> getItemStates(String siteId,
 String path,
 Long states,
 int offset,
 int limit)
                         throws SiteNotFoundException

Get item states for given filters by path regex and states mask

Parameters:

siteId - site identifier

path - path regex to filter items

states - states mask to filter items by state

offset - offset for the first record in result set

limit - number of item states records to return

Returns:

list of sandbox items

Throws:

SiteNotFoundException

updateItemStates

void updateItemStates(String siteId,
 List<String> paths,
 boolean clearSystemProcessing,
 boolean clearUserLocked,
 Boolean live,
 Boolean staged,
 Boolean isNew,
 Boolean modified)
               throws SiteNotFoundException

Update item state flags for given items

Parameters:

siteId - site identifier

paths - item paths

clearSystemProcessing - if true clear system processing flag, otherwise ignore

clearUserLocked - if true clear user locked flag, otherwise ignore

live - if true set live flag, otherwise reset it

staged - if true set staged flag, otherwise reset it

isNew - value to set the 'new' flag to, or null if the flag should not change

modified - value to set the 'modified' flag to, or null if the flag should not change

Throws:

SiteNotFoundException

updateItemStatesByQuery

void updateItemStatesByQuery(String siteId,
 String path,
 Long states,
 boolean clearSystemProcessing,
 boolean clearUserLocked,
 Boolean live,
 Boolean staged,
 Boolean isNew,
 Boolean modified)
                      throws SiteNotFoundException

Update item state flags for given path query

Parameters:

siteId - site identifier

path - path regex to identify items

clearSystemProcessing - if true clear system processing flag, otherwise ignore

clearUserLocked - if true clear user locked flag, otherwise ignore

live - if true set live flag, otherwise reset it

staged - if true set staged flag, otherwise reset it

isNew - value to set the 'new' flag to, or null if the flag should not change

modified - value to set the 'modified' flag to, or null if the flag should not change

Throws:

SiteNotFoundException

getWorkflowAffectedPaths

List<SandboxItem> getWorkflowAffectedPaths(String siteId,
 String path)
                                    throws UserNotFoundException,
ServiceLayerException

Get workflow affected paths if content is edited

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:

UserNotFoundException

ServiceLayerException

requestPublish

void requestPublish(String siteId,
 List<String> paths,
 List<String> optionalDependencies,
 String publishingTarget,
 ZonedDateTime schedule,
 String comment,
 boolean sendEmailNotifications)
             throws ServiceLayerException,
UserNotFoundException,
DeploymentException

Request approval for content to be published

Parameters:

siteId - site identifier

paths - list of paths for content items

optionalDependencies - list of paths soft dependencies

publishingTarget - publishing target

schedule - schedule when to publish content

comment - submission comment

sendEmailNotifications - if true send email notifications

Throws:

ServiceLayerException

UserNotFoundException

DeploymentException

publish

void publish(String siteId,
 List<String> paths,
 List<String> optionalDependencies,
 String publishingTarget,
 ZonedDateTime schedule,
 String comment)
      throws ServiceLayerException,
UserNotFoundException,
DeploymentException

Direct publish content

Parameters:

siteId - site identifier

paths - list of paths for content items to publish

optionalDependencies - list of paths soft dependencies

publishingTarget - publishing target

schedule - schedule when to publish content

comment - publishing comment

Throws:

ServiceLayerException

UserNotFoundException

DeploymentException

approve

void approve(String siteId,
 List<String> paths,
 List<String> optionalDependencies,
 String publishingTarget,
 ZonedDateTime schedule,
 String comment)
      throws UserNotFoundException,
ServiceLayerException,
DeploymentException

Approve request for publish

Parameters:

siteId - site identifier

paths - list of paths for content item that author requested publish

optionalDependencies - list of paths soft dependencies

publishingTarget - publishing target

schedule - schedule when to publish content

comment - approval comment

Throws:

UserNotFoundException

ServiceLayerException

DeploymentException

reject

void reject(String siteId,
 List<String> paths,
 String comment)
     throws ServiceLayerException,
DeploymentException,
UserNotFoundException

Reject request for publish

Parameters:

siteId - site identifier

paths - list of paths for content items that author requested publish

comment - rejection comment

Throws:

ServiceLayerException

DeploymentException

UserNotFoundException

delete

void delete(String siteId,
 List<String> paths,
 List<String> optionalDependencies,
 String comment)
     throws DeploymentException,
ServiceLayerException,
UserNotFoundException

Delete content items

Parameters:

siteId - site identifier

paths - list of paths for content items to be deleted

optionalDependencies - list of paths soft dependencies

comment - deletion comment

Throws:

DeploymentException

ServiceLayerException

UserNotFoundException