com.broadleafcommerce.enterprise.workflow.admin.service

Interface WorkflowManager

All Known Implementing Classes:

WorkflowManagerImpl

public interface WorkflowManager

High-level API for controlling the various workflow operations.

Author:

Jeff Fischer

See Also:

PromoteWorkflowManager, RejectWorkflowManager, RevertWorkflowManager, SyncWorkflowManager

Method Summary

Modifier and Type	Method and Description
Long	addSandboxItemChangesToExistingDeployment(Long deploymentId, Long[] ids, Long[] eventIds, String message) Adds changes to an existing deployment
Long	addSandboxItemChangesToNewDeployment(WorkflowDeploymentRecurrenceType recurrenceType, Date deploymentDate, Long[] ids, Long[] eventIds, String name, String message) Set up a time in the future (or now) to approve the changes.
Long	approveSandBoxItemChanges(Long targetSandBox, Long[] sandBoxItemIds, String msg) Promote changes forward (usually to production) that were previously promoted from a user's sandbox.
void	asyncPromoteSandBoxItemChanges(Long targetSandBox, Long[] sandBoxItemIds, boolean createEvent, String name, String msg, Boolean isCritical) Promote changes forward (usually to an approval sandbox) from a user's sandbox.
void	cancelDeployment(Long deploymentId) Cancel a previously scheduled deployment.
void	cancelEvents(Long[] events) Cancel one or more events that are part of a deployment.
void	createDeploymentItem(Long[] events, Date deployTime, String message, WorkflowDeploymentRecurrenceType recurrenceType, String deploymentName)
Boolean	getAutoProdPromote() Whether or not changes made by admin users are automatically promoted and approved to production immediately.
boolean	getAutoSync() Whether or not auto syncing is supported.
void	markEventsAsApproved(Long[] eventIds) Mark one or more events as Approved
void	promoteSandBoxItemChanges(Long targetSandBox, Long[] sandBoxItemIds, boolean createEvent, String name, String msg, boolean critical) Promote changes forward (usually to an approval sandbox) from a user's sandbox.
void	promoteSandBoxItemChanges(Long targetSandBox, Long[] sandBoxItemIds, Long eventId, String msg, boolean critical) Promote changes forward (usually to an approval sandbox) from a user's sandbox.
void	rejectSandBoxItemChanges(Long[] sandBoxItemIds, String msg) Reject changes back to the sandbox from which they originated
void	revertSandBoxItems(Long[] sandBoxItemIds) Revert changes from a user's sandbox - essentially negating the changes
Long	scheduleSandBoxItemChanges(Long[] events, String msg, Date deployTime, WorkflowDeploymentRecurrenceType recurrenceType, String deploymentName) Set up a time in the future (or now) to approve the changes.
void	setAutoProdPromote(Boolean autoProdPromote) Whether or not changes made by admin users are automatically promoted and approved to production immediately.
void	setAutoSync(boolean autoSync) Whether or not auto syncing is supported.
void	syncChanges(Long mySandBox, Long parentSandBox) Sync the parent sandbox to the current user sandbox
void	unsetAsyncPromote(Long eventId, Long[] sandBoxItemIds) Revert the setup for an asynchronous promotion.

Method Detail

approveSandBoxItemChanges

Long approveSandBoxItemChanges(Long targetSandBox,
                               Long[] sandBoxItemIds,
                               String msg)
                        throws com.broadleafcommerce.enterprise.common.exception.ReplayException

Promote changes forward (usually to production) that were previously promoted from a user's sandbox.

This method is not generally called directly. See PromoteWorkflowManager.promoteSandBoxItemChanges(Long, Long[], boolean, String, String) for more information.

Parameters:

targetSandBox - the sandbox receiving these changes (usually null, which represents production)

sandBoxItemIds - the ids for the WorkflowSandBoxItem instances to approve

msg - an accompanying message which is persisted and visible in history

Returns:

unique id marker for this promotion

Throws:

com.broadleafcommerce.enterprise.common.exception.ReplayException

See Also:

PromoteWorkflowManager

promoteSandBoxItemChanges

void promoteSandBoxItemChanges(Long targetSandBox,
                               Long[] sandBoxItemIds,
                               boolean createEvent,
                               String name,
                               String msg,
                               boolean critical)
                        throws com.broadleafcommerce.enterprise.common.exception.ReplayException

Promote changes forward (usually to an approval sandbox) from a user's sandbox.

This method is not generally called directly. See PromoteWorkflowManager.promoteSandBoxItemChanges(Long, Long[], boolean, String, String, boolean) for more information.

Parameters:

targetSandBox - the sandbox receiving these changes

sandBoxItemIds - the ids for the WorkflowSandBoxItem instances to promote

createEvent - whether or not to create an WorkflowEvent instance and tie these sandbox items to it

name - the name for the event (optional)

msg - the message for the event (optional)

Throws:

com.broadleafcommerce.enterprise.common.exception.ReplayException

See Also:

PromoteWorkflowManager

promoteSandBoxItemChanges

void promoteSandBoxItemChanges(Long targetSandBox,
                               Long[] sandBoxItemIds,
                               Long eventId,
                               String msg,
                               boolean critical)
                        throws com.broadleafcommerce.enterprise.common.exception.ReplayException

Promote changes forward (usually to an approval sandbox) from a user's sandbox.

This method is not generally called directly. See PromoteWorkflowManager.promoteSandBoxItemChanges(Long, Long[], boolean, String, String, boolean) for more information.

Parameters:

targetSandBox - the sandbox receiving these changes

sandBoxItemIds - the ids for the WorkflowSandBoxItem instances to promote

eventId - the id of the pre-existing event

msg - the message for the approval (optional)

critical -

Throws:

com.broadleafcommerce.enterprise.common.exception.ReplayException

unsetAsyncPromote

void unsetAsyncPromote(Long eventId,
                       Long[] sandBoxItemIds)

Revert the setup for an asynchronous promotion. This includes archiving the empty event and unmarking all the sandbox items so that they are once again visible for promotion.

Parameters:

eventId -

sandBoxItemIds -

Throws:

com.broadleafcommerce.enterprise.common.exception.ReplayException

asyncPromoteSandBoxItemChanges

void asyncPromoteSandBoxItemChanges(Long targetSandBox,
                                    Long[] sandBoxItemIds,
                                    boolean createEvent,
                                    String name,
                                    String msg,
                                    Boolean isCritical)
                             throws com.broadleafcommerce.enterprise.common.exception.ReplayException

Promote changes forward (usually to an approval sandbox) from a user's sandbox. Executes asynchronously by sending a system event. See PromotionSystemEventConsumer for event consumption details.

Parameters:

targetSandBox - the sandbox receiving these changes

sandBoxItemIds - the ids for the WorkflowSandBoxItem instances to promote

createEvent - whether or not to create an WorkflowEvent instance and tie these sandbox items to it

name - the name for the event (optional)

msg - the message for the event (optional)

isCritical -

Throws:

com.broadleafcommerce.enterprise.common.exception.ReplayException

See Also:

PromoteWorkflowManager

scheduleSandBoxItemChanges

Long scheduleSandBoxItemChanges(Long[] events,
                                String msg,
                                Date deployTime,
                                WorkflowDeploymentRecurrenceType recurrenceType,
                                String deploymentName)
                         throws com.broadleafcommerce.enterprise.common.exception.ReplayException

Set up a time in the future (or now) to approve the changes. This is an asynchronous operation that

1. Sets up a job to fire at the deploy time 2. When the job fires, an event is created for deployment 3. The event is consumed and approveSandBoxItemChanges(Long, Long[], String) is called

Parameters:

deploymentType -

events - the ids for the WorkflowEvent instances to approve

msg - the message for the approval (optional)

deployTime - the time in the future (or now) when the deployment will take place

recurrenceType -

deploymentName -

Returns:

the id of the WorkflowDeployment instance created for this schedule

Throws:

com.broadleafcommerce.enterprise.common.exception.ReplayException

See Also:

PromoteWorkflowManager, ScheduledDeploySystemEventConsumer

rejectSandBoxItemChanges

void rejectSandBoxItemChanges(Long[] sandBoxItemIds,
                              String msg)
                       throws com.broadleafcommerce.enterprise.common.exception.ReplayException

Reject changes back to the sandbox from which they originated

Parameters:

sandBoxItemIds - the ids for the WorkflowSandBoxItem instances to reject

msg - a rejection message (optional)

Throws:

com.broadleafcommerce.enterprise.common.exception.ReplayException

See Also:

RejectWorkflowManager

revertSandBoxItems

void revertSandBoxItems(Long[] sandBoxItemIds)
                 throws com.broadleafcommerce.enterprise.common.exception.ReplayException

Revert changes from a user's sandbox - essentially negating the changes

Parameters:

sandBoxItemIds - the ids for the WorkflowSandBoxItem instances to revert

Throws:

com.broadleafcommerce.enterprise.common.exception.ReplayException

See Also:

RevertWorkflowManager

syncChanges

void syncChanges(Long mySandBox,
                 Long parentSandBox)
          throws com.broadleafcommerce.enterprise.common.exception.ReplayException

Sync the parent sandbox to the current user sandbox

Parameters:

mySandBox - the current user sandbox

parentSandBox - the parent sandbox

Throws:

com.broadleafcommerce.enterprise.common.exception.ReplayException

See Also:

VersionManager, SyncWorkflowManager

getAutoSync

boolean getAutoSync()

Whether or not auto syncing is supported. If so, when a user's sandbox is detected to be out of sync with the parent during promotion, the user's sandbox will be automatically synced. False by default.

Returns:

whether or not to auto sync

setAutoSync

void setAutoSync(boolean autoSync)

Whether or not auto syncing is supported. If so, when a user's sandbox is detected to be out of sync with the parent during promotion, the user's sandbox will be automatically synced. False by default.

Parameters:

autoSync - whether or not to auto sync

getAutoProdPromote

Boolean getAutoProdPromote()

Whether or not changes made by admin users are automatically promoted and approved to production immediately. This setting can be used to avoid the workflow process altogether, while still maintaing the audit trail history on changes. False by default.

Returns:

Whether or not to immediately deploy changes to production without the workflow steps

setAutoProdPromote

void setAutoProdPromote(Boolean autoProdPromote)

Whether or not changes made by admin users are automatically promoted and approved to production immediately. This setting can be used to avoid the workflow process altogether, while still maintaing the audit trail history on changes. False by default.

Parameters:

autoProdPromote - Whether or not to immediately deploy changes to production without the workflow steps

createDeploymentItem

void createDeploymentItem(Long[] events,
                          Date deployTime,
                          String message,
                          WorkflowDeploymentRecurrenceType recurrenceType,
                          String deploymentName)
                   throws com.broadleafcommerce.enterprise.common.exception.ReplayException

Parameters:

events -

deployTime -

message -

recurrenceType -

deploymentName -

Throws:

com.broadleafcommerce.enterprise.common.exception.ReplayException

cancelDeployment

void cancelDeployment(Long deploymentId)
               throws com.broadleafcommerce.enterprise.common.exception.ReplayException

Cancel a previously scheduled deployment. The deployment must not have already taken place. The cancelled items will be returned to the approval sandbox from which they were deployed.

Parameters:

deploymentId - the id of the WorkflowDeployment

Throws:

com.broadleafcommerce.enterprise.common.exception.ReplayException

cancelEvents

void cancelEvents(Long[] events)
           throws com.broadleafcommerce.enterprise.common.exception.ReplayException

Cancel one or more events that are part of a deployment. This allows for partial deployment cancellation, while leaving the remaining items in the deployment intact and still scheduled.

Parameters:

events - the event ids belonging to the WorkflowDeployment to cancel

Throws:

com.broadleafcommerce.enterprise.common.exception.ReplayException

markEventsAsApproved

void markEventsAsApproved(Long[] eventIds)

Mark one or more events as Approved

Parameters:

eventIds - the event ids to approve

addSandboxItemChangesToNewDeployment

Long addSandboxItemChangesToNewDeployment(WorkflowDeploymentRecurrenceType recurrenceType,
                                          Date deploymentDate,
                                          Long[] ids,
                                          Long[] eventIds,
                                          String name,
                                          String message)
                                   throws com.broadleafcommerce.enterprise.common.exception.ReplayException

Set up a time in the future (or now) to approve the changes. This is an asynchronous operation that

1. Sets up a job to fire at the deploy time 2. When the job fires, an event is created for deployment 3. The event is consumed and approveSandBoxItemChanges(Long, Long[], String) is called

Parameters:

recurrenceType - the recurrence type for the WorkflowDeployment

deploymentDate - the time in the future (or now) when the deployment will take place

ids - the ids for the WorkflowSandBoxItem instances to approve

eventIds - the ids for the WorkflowEvent instances to approve

message - the message for the approval (optional)

Returns:

the id of the WorkflowDeployment instance created for this schedule

Throws:

com.broadleafcommerce.enterprise.common.exception.ReplayException

See Also:

PromoteWorkflowManager, ScheduledDeploySystemEventConsumer

addSandboxItemChangesToExistingDeployment

Long addSandboxItemChangesToExistingDeployment(Long deploymentId,
                                               Long[] ids,
                                               Long[] eventIds,
                                               String message)
                                        throws com.broadleafcommerce.enterprise.common.exception.ReplayException

Adds changes to an existing deployment

Parameters:

ids - the ids for the WorkflowSandBoxItem instances to approve

eventIds - the ids for the WorkflowEvent instances to approve

message - the message for the approval (optional)

Returns:

the id of the WorkflowDeployment instance created for this schedule

Throws:

com.broadleafcommerce.enterprise.common.exception.ReplayException

See Also:

PromoteWorkflowManager, ScheduledDeploySystemEventConsumer