Interface WorkflowService
-
- All Known Implementing Classes:
WorkflowServiceImpl
public interface WorkflowService
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
approve(String siteId, List<String> paths, List<String> optionalDependencies, String publishingTarget, ZonedDateTime schedule, String comment)
Approve request for publishvoid
delete(String siteId, List<String> paths, List<String> optionalDependencies, String comment)
Delete content itemsList<SandboxItem>
getItemStates(String siteId, String path, Long states, int offset, int limit)
Get item states for given filters by path regex and states maskint
getItemStatesTotal(String siteId, String path, Long states)
Get total number of item states records for given filters by path regex and states maskList<SandboxItem>
getWorkflowAffectedPaths(String siteId, String path)
Get workflow affected paths if content is editedvoid
publish(String siteId, List<String> paths, List<String> optionalDependencies, String publishingTarget, ZonedDateTime schedule, String comment)
Direct publish contentvoid
reject(String siteId, List<String> paths, String comment)
Reject request for publishvoid
requestPublish(String siteId, List<String> paths, List<String> optionalDependencies, String publishingTarget, ZonedDateTime schedule, String comment, boolean sendEmailNotifications)
Request approval for content to be publishedvoid
updateItemStates(String siteId, List<String> paths, boolean clearSystemProcessing, boolean clearUserLocked, Boolean live, Boolean staged, Boolean isNew, Boolean modified)
Update item state flags for given itemsvoid
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 Detail
-
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 identifierpath
- path regex to filter itemsstates
- 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 identifierpath
- path regex to filter itemsstates
- states mask to filter items by stateoffset
- offset for the first record in result setlimit
- 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 identifierpaths
- item pathsclearSystemProcessing
- if true clear system processing flag, otherwise ignoreclearUserLocked
- if true clear user locked flag, otherwise ignorelive
- if true set live flag, otherwise reset itstaged
- if true set staged flag, otherwise reset itisNew
- value to set the 'new' flag to, or null if the flag should not changemodified
- 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 identifierpath
- path regex to identify itemsclearSystemProcessing
- if true clear system processing flag, otherwise ignoreclearUserLocked
- if true clear user locked flag, otherwise ignorelive
- if true set live flag, otherwise reset itstaged
- if true set staged flag, otherwise reset itisNew
- value to set the 'new' flag to, or null if the flag should not changemodified
- 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 identifierpath
- 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 identifierpaths
- list of paths for content itemsoptionalDependencies
- list of paths soft dependenciespublishingTarget
- publishing targetschedule
- schedule when to publish contentcomment
- submission commentsendEmailNotifications
- 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 identifierpaths
- list of paths for content items to publishoptionalDependencies
- list of paths soft dependenciespublishingTarget
- publishing targetschedule
- schedule when to publish contentcomment
- 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 identifierpaths
- list of paths for content item that author requested publishoptionalDependencies
- list of paths soft dependenciespublishingTarget
- publishing targetschedule
- schedule when to publish contentcomment
- 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 identifierpaths
- list of paths for content items that author requested publishcomment
- 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 identifierpaths
- list of paths for content items to be deletedoptionalDependencies
- list of paths soft dependenciescomment
- deletion comment- Throws:
DeploymentException
ServiceLayerException
UserNotFoundException
-
-