All Known Implementing Classes:: DefaultTransitionRequestManager

public interface TransitionRequestManager

Service responsible for managing workflow state transitions. This includes ChangeSummary, ChangeSummaryGroup, and ChangeDeploy state, as well as sending out TransitionRequests to the various other microservices in order to cause them to update the sandbox workflow status of any Trackable entities under their purview related to the changes.

Note: if vendor processing is enabled, results should be filtered by the current authentication's vendor restrictions. This also means vendor-related fields should be initialized on domains.

Author:: Jeff Fischer

Method Summary

Modifier and Type

Method

Description

void

approve(ChangeSummaryGroups approveGroups, String sandbox)

Deprecated.
since 1.3, replaced by approve(ChangeSummaryGroups, String, ContextInfo)

void

approve(ChangeSummaryGroups approveGroups, String sandbox, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Moves the ChangeSummaryGroup instances identified by the approveGroups param into the ChangeState.APPROVED state.

void

clearDeployment(String changeDeployId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Accepts an ID for a ChangeDeploy that previously failed and starts the process of clearing the error state of the deployment.

void

deploy(ChangeSummaryGroups scheduleGroups, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String sandbox, int level)

Moves the ChangeSummaryGroup instances identified by the scheduleGroups param into the ChangeStatusType.DEPLOYING status.

ChangeSummaryGroup

findExistingChangeGroup(List<ChangeSummary> changeSummaries)

Deprecated.
since 1.3, replaced by findExistingChangeGroup(List, ContextInfo)

ChangeSummaryGroup

findExistingChangeGroup(List<ChangeSummary> changeSummaries, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Retrieve the common ChangeSummaryGroup for a list of summaries

void

promote(PromoteSummaries summaries, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String sandbox)

Moves the ChangeSummaries identified by the PromoteSummaries.getChangeSummaries() into the PROMOTING status and notifies all interested microservices managing matching Trackable entities that they should perform a promotion for each of said entities.

void

promoteDeploy(PromoteSummaries summaries, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String sandbox)

Moves the ChangeSummaries identified by the PromoteSummaries.getChangeSummaries() into the Deploying status and notifies all interested microservices managing matching Trackable entities that they should perform a deployment for each of said entities.

void

rebase(ChangeSummaries summaries, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String sandbox)

Moves the ChangeSummaries identified by the ChangeSummaries.getChangeSummaryIds() into the REBASING status and notifies all interested microservices that manage matching Trackable entities that they should perform a rebase for each of the said entities.

void

reject(ChangeSummaryGroups changeSummaryGroups, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String sandbox)

Moves the ChangeSummaries identified as part of the ChangeSummaryGroups identified by ChangeSummaryGroups.getChangeSummaryGroupIds() into the REJECTING status and notifies all interested microservices that manage matching Trackable entities that they should perform a rejection for each of the said entities.

void

rejectApproved(ChangeSummaryGroups changeSummaryGroups, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String sandbox)

Moves the ChangeSummaries identified as part of the ChangeSummaryGroups identified by ChangeSummaryGroups.getChangeSummaryGroupIds() into the REJECTING status and notifies all interested microservices that manage matching Trackable entities that they should perform a rejection for each of the said entities.

void

rejectPromoted(ChangeSummaryGroups changeSummaryGroups, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String sandbox)

Moves the ChangeSummaries identified as part of the ChangeSummaryGroups identified by ChangeSummaryGroups.getChangeSummaryGroupIds() into the REJECTING status and notifies all interested microservices that manage matching Trackable entities that they should perform a rejection for each of the said entities.

ChangeSummaryRemovalResponse

remove(ChangeSummaryRemovalRequest changeSummaryRemovalRequest)

Deprecated.
since 1.3, replaced by remove(ChangeSummaryRemovalRequest, ContextInfo)

ChangeSummaryRemovalResponse

remove(ChangeSummaryRemovalRequest changeSummaryRemovalRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Remove the ChangeSummaries of the provided ids from their ChangeSummaryGroup and add them to a new one.

void

revert(ChangeSummaries summaries, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String sandbox)

Moves the ChangeSummaries identified by the ChangeSummaries.getChangeSummaryIds() into the REVERTING status and notifies all interested microservices that manage matching Trackable entities that they should perform a reversion for each of the said entities.

void

scheduleDeployment(ChangeSummaryGroups scheduleGroups, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String sandbox, Instant deployTime, int level)

Moves the ChangeSummaryGroup instances identified by the scheduleGroups param into the ChangeStatusType.SCHEDULING status.

void

unscheduleDeployment(String changeDeployId)

Deprecated.
since 1.3, replaced by unscheduleDeployment(String, ContextInfo)

void

unscheduleDeployment(String changeDeployId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Accepts an ID for a ChangeDeploy that was previously scheduled and starts the process of unscheduling the deployment.

Method Details
- approve
  
  @Deprecated void approve(@NonNull ChangeSummaryGroups approveGroups, @NonNull String sandbox)
  
  Deprecated.
  since 1.3, replaced by approve(ChangeSummaryGroups, String, ContextInfo)
  
  Moves the ChangeSummaryGroup instances identified by the approveGroups param into the ChangeState.APPROVED state. Also, moves any ChangeSummary instances identified by ChangeSummaryGroup.getChangeSummaryIds() into the ChangeState.APPROVED state as well.
  This transition should be performed in a multi-user safe way so that multiple requests for transitions on the same ChangeSummaryGroup instances cannot happen concurrently.
  A QualifiedStateException can be thrown for any id values determined to be in an incorrect state from that expected to perform a transition operation. For example, if a ChangeSummaryGroup was in an APPROVED state, but a reject was requested on it, this exception would be thrown because the expected state for a reject is PROMOTED.
  
  Parameters:
  
  approveGroups - Construct that identifies one or more ChangeSummaryGroup instances
  
  sandbox - the sandbox to filter the search on
  
  Throws:
  
  QualifiedStateException - Thrown for any id values determined to be in an incorrect state from that expected to perform a transition operation
- approve
  
  void approve(@NonNull ChangeSummaryGroups approveGroups, @NonNull String sandbox, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
  
  Moves the ChangeSummaryGroup instances identified by the approveGroups param into the ChangeState.APPROVED state. Also, moves any ChangeSummary instances identified by ChangeSummaryGroup.getChangeSummaryIds() into the ChangeState.APPROVED state as well.
  This transition should be performed in a multi-user safe way so that multiple requests for transitions on the same ChangeSummaryGroup instances cannot happen concurrently.
  A QualifiedStateException can be thrown for any id values determined to be in an incorrect state from that expected to perform a transition operation. For example, if a ChangeSummaryGroup was in an APPROVED state, but a reject was requested on it, this exception would be thrown because the expected state for a reject is PROMOTED.
  
  Parameters:
  
  approveGroups - Construct that identifies one or more ChangeSummaryGroup instances
  
  sandbox - the sandbox to filter the search on
  
  contextInfo - context information surrounding sandboxing and multitenant state
  
  Throws:
  
  QualifiedStateException - Thrown for any id values determined to be in an incorrect state from that expected to perform a transition operation
- promote
  
  void promote(@NonNull PromoteSummaries summaries, @NonNull com.broadleafcommerce.data.tracking.core.context.ContextInfo context, @NonNull String sandbox)
  
  Moves the ChangeSummaries identified by the PromoteSummaries.getChangeSummaries() into the PROMOTING status and notifies all interested microservices managing matching Trackable entities that they should perform a promotion for each of said entities. This notification is performed via a WorkflowPromoteRequest.
  When ChangeSummaries.isAllChangeSummaries() is true, this operation will promote all items owned by the current user in the USER state. If ChangeSummaries.isAllChangeSummaries() is false, then only the items specified in ChangeSummaries.getChangeSummaryIds() are promoted. ChangeSummaries.isAllChangeSummaries() is false by default.
  Finally, if any of the requested change summaries are diverged, then this promotion is cancelled and a DivergedChangeException is thrown. A summary can be diverged when it has not absorbed all ChangeDetail entries produced by another ChangeSummary for the same entity but promoted by another author. Meaning, the current ChangeSummary is unaware of some changes already promoted in advance and, thus, is considered diverged. Diverged ChangeSummaries must be rebased before they are allowed to promote (see rebase(ChangeSummaries, ContextInfo, String)).
  
  Parameters:
  
  summaries - Construct that identifies one or more ChangeSummary instances.
  
  context - Request context information identifying the user
  
  sandbox - the sandbox to filter the search on
  
  Throws:
  
  com.broadleafcommerce.data.tracking.core.exception.EntityMissingException - Thrown when any of the items specified in ChangeSummaries.getChangeSummaryIds() are not owned by the author identified in ContextInfo.getAuthor()
  
  DivergedChangeException - Thrown when any of the requested ChangeSummaries are diverged. A summary can be diverged when it has not absorbed all ChangeDetail entries produced by another ChangeSummary for the same entity but promoted by another author. Meaning, the current ChangeSummary is unaware of some changes already promoted in advance and, thus, is considered diverged. Diverged ChangeSummaries must be rebased before they are allowed to promote (see rebase(ChangeSummaries, ContextInfo, String)).
  
  QualifiedStateException - Thrown for any id values determined to be in an incorrect state from that expected to perform a transition operation
  
  ChangeSummariesNotFoundException - Thrown if the change summaries cannot be found
- promoteDeploy
  
  void promoteDeploy(@NonNull PromoteSummaries summaries, @NonNull com.broadleafcommerce.data.tracking.core.context.ContextInfo context, @NonNull String sandbox)
  
  Moves the ChangeSummaries identified by the PromoteSummaries.getChangeSummaries() into the Deploying status and notifies all interested microservices managing matching Trackable entities that they should perform a deployment for each of said entities. This notification is performed via a WorkflowDeployRequest.
  When ChangeSummaries.isAllChangeSummaries() is true, this operation will deploy all items owned by the current user in the USER state. If ChangeSummaries.isAllChangeSummaries() is false, then only the items specified in ChangeSummaries.getChangeSummaryIds() are deployed. ChangeSummaries.isAllChangeSummaries() is false by default.
  Finally, if any of the requested change summaries are diverged, then this promotion is cancelled and a DivergedChangeException is thrown. A summary can be diverged when it has not absorbed all ChangeDetail entries produced by another ChangeSummary for the same entity but promoted by another author. Meaning, the current ChangeSummary is unaware of some changes already promoted in advance and, thus, is considered diverged. Diverged ChangeSummaries must be rebased before they are allowed to promote (see rebase(ChangeSummaries, ContextInfo, String)).
  
  Parameters:
  
  summaries - Construct that identifies on or more ChangeSummary instances.
  
  context - Request context information identifying the user
  
  sandbox - the sandbox to filter the search on
  
  Throws:
  
  com.broadleafcommerce.data.tracking.core.exception.EntityMissingException - Thrown when any of the items specified in ChangeSummaries.getChangeSummaryIds() are not owned by the author identified in ContextInfo.getAuthor()
  
  DivergedChangeException - Thrown when any of the requested ChangeSummaries are diverged. A summary can be diverged when it has not absorbed all ChangeDetail entries produced by another ChangeSummary for the same entity but promoted by another author. Meaning, the current ChangeSummary is unaware of some changes already promoted in advance and, thus, is considered diverged. Diverged ChangeSummaries must be rebased before they are allowed to promote (see rebase(ChangeSummaries, ContextInfo, String)).
  
  QualifiedStateException - Thrown for any id values determined to be in an incorrect state from that expected to perform a transition operation
  
  ChangeSummariesNotFoundException - Thrown if the change summaries cannot be found
- rebase
  
  void rebase(@NonNull ChangeSummaries summaries, @NonNull com.broadleafcommerce.data.tracking.core.context.ContextInfo context, @NonNull String sandbox)
  
  Moves the ChangeSummaries identified by the ChangeSummaries.getChangeSummaryIds() into the REBASING status and notifies all interested microservices that manage matching Trackable entities that they should perform a rebase for each of the said entities. This notification is performed via a WorkflowRebaseRequest.
  When ChangeSummaries.isAllChangeSummaries() is true, this operation will rebase all items owned by the current user in the USER state. If ChangeSummaries.isAllChangeSummaries() is false, then only the items specified in ChangeSummaries.getChangeSummaryIds() are rebased. ChangeSummaries.isAllChangeSummaries() is false by default.
  If any of the items contained by a ChangeSummary identified in the ChangeSummaries are not owned by the author identified by ContextInfo.getAuthor(), then an EntityMissingException is thrown.
  
  Parameters:
  
  summaries - Construct that identifies on or more ChangeSummary instances.
  
  context - Request context information identifying user, sandbox, etc...
  
  sandbox - the sandbox to filter the search on
  
  Throws:
  
  com.broadleafcommerce.data.tracking.core.exception.EntityMissingException - Thrown when any of the items specified in ChangeSummaries.getChangeSummaryIds() are not owned by the author identified in ContextInfo.getAuthor()
  
  QualifiedStateException - Thrown for any id values determined to be in an incorrect state from that expected to perform a transition operation
  
  ChangeSummariesNotFoundException - Thrown if the change summaries cannot be found
- reject
  
  void reject(@NonNull ChangeSummaryGroups changeSummaryGroups, @NonNull com.broadleafcommerce.data.tracking.core.context.ContextInfo context, @NonNull String sandbox)
  
  Moves the ChangeSummaries identified as part of the ChangeSummaryGroups identified by ChangeSummaryGroups.getChangeSummaryGroupIds() into the REJECTING status and notifies all interested microservices that manage matching Trackable entities that they should perform a rejection for each of the said entities. This notification is performed via a WorkflowRejectRequest. A reason message for the rejection is also saved to the ChangeSummaries.
  If any of the items contained by a ChangeSummary identified in the ChangeSummaryGroups are not owned by the author identified by ContextInfo.getAuthor(), then an EntityMissingException is thrown.
  This operation will only work if the summaries and summary groups currently have a state of ChangeState.PROMOTED and a status in ChangeStatusType.restingPromoted(ChangeStatusType...).
  
  Parameters:
  
  changeSummaryGroups - Construct that identifies on or more ChangeSummaryGroup instances for rejection.
  
  context - Request context information identifying user, sandbox, etc...
  
  sandbox - the Sandbox.getId() on which to filter the search
  
  Throws:
  
  com.broadleafcommerce.data.tracking.core.exception.EntityMissingException - Thrown when any of the items specified in ChangeSummaryGroups.getChangeSummaryGroupIds() ()} are not owned by the author identified in ContextInfo.getAuthor()
  
  QualifiedStateException - Thrown for any id values determined to be in an incorrect state from that expected to perform a transition operation
  
  ChangeSummariesNotFoundException - Thrown if the change summaries cannot be found
- rejectPromoted
  
  void rejectPromoted(@NonNull ChangeSummaryGroups changeSummaryGroups, @NonNull com.broadleafcommerce.data.tracking.core.context.ContextInfo context, @NonNull String sandbox)
  
  Moves the ChangeSummaries identified as part of the ChangeSummaryGroups identified by ChangeSummaryGroups.getChangeSummaryGroupIds() into the REJECTING status and notifies all interested microservices that manage matching Trackable entities that they should perform a rejection for each of the said entities. This notification is performed via a WorkflowRejectRequest. A reason message for the rejection is also saved to the ChangeSummaries.
  If any of the items contained by a ChangeSummary identified in the ChangeSummaryGroups are not owned by the author identified by ContextInfo.getAuthor(), then an EntityMissingException is thrown.
  This operation will only work if the summaries and summary groups currently have a state of ChangeState.PROMOTED and a status in ChangeStatusType.restingPromoted(ChangeStatusType...).
  
  Parameters:
  
  changeSummaryGroups - Construct that identifies on or more ChangeSummaryGroup instances for rejection.
  
  context - Request context information identifying user, sandbox, etc...
  
  sandbox - the Sandbox.getId() on which to filter the search
  
  Throws:
  
  com.broadleafcommerce.data.tracking.core.exception.EntityMissingException - Thrown when any of the items specified in ChangeSummaryGroups.getChangeSummaryGroupIds() ()} are not owned by the author identified in ContextInfo.getAuthor()
  
  QualifiedStateException - Thrown for any id values determined to be in an incorrect state from that expected to perform a transition operation
  
  ChangeSummariesNotFoundException - Thrown if the change summaries cannot be found
- rejectApproved
  
  void rejectApproved(@NonNull ChangeSummaryGroups changeSummaryGroups, @NonNull com.broadleafcommerce.data.tracking.core.context.ContextInfo context, @NonNull String sandbox)
  
  Moves the ChangeSummaries identified as part of the ChangeSummaryGroups identified by ChangeSummaryGroups.getChangeSummaryGroupIds() into the REJECTING status and notifies all interested microservices that manage matching Trackable entities that they should perform a rejection for each of the said entities. This notification is performed via a WorkflowRejectRequest. A reason message for the rejection is also saved to the ChangeSummaries.
  If any of the items contained by a ChangeSummary identified in the ChangeSummaryGroups are not owned by the author identified by ContextInfo.getAuthor(), then an EntityMissingException is thrown.
  This operation will only work if the summaries and summary groups currently have a state of ChangeState.APPROVED and a status in ChangeStatusType.restingApproved(ChangeStatusType...).
  
  Parameters:
  
  changeSummaryGroups - Construct that identifies on or more ChangeSummaryGroup instances for rejection.
  
  context - Request context information identifying user, sandbox, etc...
  
  sandbox - the Sandbox.getId() on which to filter the search
  
  Throws:
  
  com.broadleafcommerce.data.tracking.core.exception.EntityMissingException - Thrown when any of the items specified in ChangeSummaryGroups.getChangeSummaryGroupIds() ()} are not owned by the author identified in ContextInfo.getAuthor()
  
  QualifiedStateException - Thrown for any id values determined to be in an incorrect state from that expected to perform a transition operation
  
  ChangeSummariesNotFoundException - Thrown if the change summaries cannot be found
- revert
  
  void revert(@NonNull ChangeSummaries summaries, @NonNull com.broadleafcommerce.data.tracking.core.context.ContextInfo context, @NonNull String sandbox)
  
  Moves the ChangeSummaries identified by the ChangeSummaries.getChangeSummaryIds() into the REVERTING status and notifies all interested microservices that manage matching Trackable entities that they should perform a reversion for each of the said entities. This notification is performed via a WorkflowRevertRequest.
  When ChangeSummaries.isAllChangeSummaries() is true, this operation will rebase all items owned by the current user in the USER state. If ChangeSummaries.isAllChangeSummaries() is false, then only the items specified in ChangeSummaries.getChangeSummaryIds() are rebased. ChangeSummaries.isAllChangeSummaries() is false by default.
  If any of the items contained by a ChangeSummary identified in the ChangeSummaries are not owned by the author identified by ContextInfo.getAuthor(), then an EntityMissingException is thrown.
  
  Parameters:
  
  summaries - Construct that identifies on or more ChangeSummary instances.
  
  context - Request context information identifying user, sandbox, etc...
  
  sandbox - the Sandbox.getId() on which to filter the search
  
  Throws:
  
  com.broadleafcommerce.data.tracking.core.exception.EntityMissingException - Thrown when any of the items specified in ChangeSummaries.getChangeSummaryIds() are not owned by the author identified in ContextInfo.getAuthor()
  
  QualifiedStateException - Thrown for any id values determined to be in an incorrect state from that expected to perform a transition operation
  
  ChangeSummariesNotFoundException - Thrown if the change summaries cannot be found
- deploy
  
  void deploy(@NonNull ChangeSummaryGroups scheduleGroups, @NonNull com.broadleafcommerce.data.tracking.core.context.ContextInfo context, @NonNull String sandbox, int level)
  
  Moves the ChangeSummaryGroup instances identified by the scheduleGroups param into the ChangeStatusType.DEPLOYING status. Also, moves any ChangeSummary instances identified by ChangeSummaryGroup.getChangeSummaryIds() into the same status. Finally, this will create a new ChangeDeploy that is scheduled to deploy immediately.
  When ChangeSummaryGroups.isAllChangeSummaryGroups() is true, this operation will deploy all groups owned by the current user in the APPROVED state. Otherwise, only the items specified in ChangeSummaryGroups.getChangeSummaryGroupIds() are deployed. ChangeSummaryGroups.isAllChangeSummaryGroups() is false by default.
  A QualifiedStateException can be thrown for any id values determined to be in an incorrect state from that expected to perform a transition operation. For example, if a ChangeSummaryGroup was in a DEPLOYED state already, but a deployment was requested for it, this exception would be thrown because the expected state for a deployment is APPROVED.
  
  Parameters:
  
  scheduleGroups - Construct that identifies one or more ChangeSummaryGroup instances to be scheduled for a future deployment.
  
  context - Information about the deploy request containing the ID of the request's author.
  
  sandbox - The sandbox ID upon which to filter searches on when retrieving the group instances and their summaries.
  
  level - The tracking level from which to perform the deployment (see TrackingLevel)
  
  Throws:
  
  QualifiedStateException - Thrown for any id values determined to be in an incorrect state from that expected to perform a transition operation
  
  ChangeSummariesNotFoundException - Thrown if the change summaries cannot be found
- scheduleDeployment
  
  void scheduleDeployment(@NonNull ChangeSummaryGroups scheduleGroups, @NonNull com.broadleafcommerce.data.tracking.core.context.ContextInfo context, @NonNull String sandbox, @NonNull Instant deployTime, int level)
  
  Moves the ChangeSummaryGroup instances identified by the scheduleGroups param into the ChangeStatusType.SCHEDULING status. Also, moves any ChangeSummary instances identified by ChangeSummaryGroup.getChangeSummaryIds() into the same status. Finally, this will create a new ChangeDeploy that is scheduled to deploy at the specified deployTime.
  When ChangeSummaryGroups.isAllChangeSummaryGroups() is true, this operation will schedule all groups owned by the current user in the APPROVED state. Otherwise, only the items specified in ChangeSummaryGroups.getChangeSummaryGroupIds() are deployed. ChangeSummaryGroups.isAllChangeSummaryGroups() is false by default.
  A QualifiedStateException can be thrown for any id values determined to be in an incorrect state from that expected to perform a transition operation. For example, if a ChangeSummaryGroup was in a DEPLOYED state already, but a scheduling was requested for it, this exception would be thrown because the expected state for a scheduling is APPROVED.
  
  Parameters:
  
  scheduleGroups - Construct that identifies one or more ChangeSummaryGroup instances to be scheduled for a future deployment.
  
  context - Information about the deploy request containing the ID of the request's author.
  
  sandbox - The sandbox ID upon which to filter searches on when retrieving the group instances and their summaries.
  
  level - The tracking level from which to perform the deployment (see TrackingLevel)
  
  Throws:
  
  QualifiedStateException - Thrown for any id values determined to be in an incorrect state from that expected to perform a transition operation
- unscheduleDeployment
  
  @Deprecated void unscheduleDeployment(@NonNull String changeDeployId)
  
  Deprecated.
  since 1.3, replaced by unscheduleDeployment(String, ContextInfo)
  
  Accepts an ID for a ChangeDeploy that was previously scheduled and starts the process of unscheduling the deployment. The deployment, its groups, and their associated summaries have their statuses updated to ChangeStatusType.UNSCHEDULING, and a WorkflowJobUnschedulingRequest is published to actually unschedule the job.
  Parameters:
  
  changeDeployId - the ID of the previously scheduled ChangeDeploy which should be unscheduled
  
  Throws:
  
  QualifiedStateException - for any values determined to be in an incorrect state from what is expected to perform an unschedule operation
  
  See Also:
  
  DeploymentJobUnschedulingRequestCompletionHandler
- unscheduleDeployment
  
  void unscheduleDeployment(@NonNull String changeDeployId, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
  
  Accepts an ID for a ChangeDeploy that was previously scheduled and starts the process of unscheduling the deployment. The deployment, its groups, and their associated summaries have their statuses updated to ChangeStatusType.UNSCHEDULING, and a WorkflowJobUnschedulingRequest is published to actually unschedule the job.
  Parameters:
  
  changeDeployId - the ID of the previously scheduled ChangeDeploy which should be unscheduled
  
  contextInfo - context information about sandboxing and multitenant state
  
  Throws:
  
  QualifiedStateException - for any values determined to be in an incorrect state from what is expected to perform an unschedule operation
  
  See Also:
  
  DeploymentJobUnschedulingRequestCompletionHandler
- clearDeployment
  
  void clearDeployment(@NonNull String changeDeployId, @NonNull com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
  
  Accepts an ID for a ChangeDeploy that previously failed and starts the process of clearing the error state of the deployment. This includes notifying (via special deployment case) all resource tier services with impacted entities. The resource tier service is responsible for rectifying the ChangeDetail state to obsolete for deployment version matches in the tracking information for affected entities.
  
  Parameters:
  
  changeDeployId - The ID of the previously failed deployment
  
  contextInfo - context information about sandboxing and multitenant state
- remove
  
  @NonNull @Deprecated ChangeSummaryRemovalResponse remove(@NonNull ChangeSummaryRemovalRequest changeSummaryRemovalRequest)
  
  Deprecated.
  since 1.3, replaced by remove(ChangeSummaryRemovalRequest, ContextInfo)
  
  Remove the ChangeSummaries of the provided ids from their ChangeSummaryGroup and add them to a new one.
  
  Parameters:
  
  changeSummaryRemovalRequest - Construct that indicates which ChangeSummaries to remove, given their ids. Also indicates what the name of the new ChangeSummaryGroup should be.
  
  Returns:
  
  Remove the ChangeSummaries of the provided ids from their ChangeSummaryGroup and into a new one
  
  Throws:
  
  ChangeSummaryRemovalException - Thrown after creating the new ChangeSummaryGroup when all provided summary ids fail during transfer from the old group to the new one
- remove
  
  @NonNull ChangeSummaryRemovalResponse remove(@NonNull ChangeSummaryRemovalRequest changeSummaryRemovalRequest, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
  
  Remove the ChangeSummaries of the provided ids from their ChangeSummaryGroup and add them to a new one.
  
  Parameters:
  
  changeSummaryRemovalRequest - Construct that indicates which ChangeSummaries to remove, given their ids. Also indicates what the name of the new ChangeSummaryGroup should be.
  
  contextInfo - context information about sandboxing and multitenant state
  
  Returns:
  
  Remove the ChangeSummaries of the provided ids from their ChangeSummaryGroup and into a new one
  
  Throws:
  
  ChangeSummaryRemovalException - Thrown after creating the new ChangeSummaryGroup when all provided summary ids fail during transfer from the old group to the new one
- findExistingChangeGroup
  
  @Nullable @Deprecated ChangeSummaryGroup findExistingChangeGroup(@NonNull List<ChangeSummary> changeSummaries)
  
  Deprecated.
  since 1.3, replaced by findExistingChangeGroup(List, ContextInfo)
  
  Retrieve the common ChangeSummaryGroup for a list of summaries
  
  Parameters:
  
  changeSummaries - The summaries sharing a common group
  
  Returns:
  
  The group containing the requested summaries
- findExistingChangeGroup
  
  @Nullable ChangeSummaryGroup findExistingChangeGroup(@NonNull List<ChangeSummary> changeSummaries, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
  
  Retrieve the common ChangeSummaryGroup for a list of summaries
  
  Parameters:
  
  changeSummaries - The summaries sharing a common group
  
  contextInfo - context information about sandboxing and multitenant state
  
  Returns:
  
  The group containing the requested summaries

Interface TransitionRequestManager

Method Summary

Method Details

approve

approve

promote

promoteDeploy

rebase

reject

rejectPromoted

rejectApproved

revert

deploy

scheduleDeployment

unscheduleDeployment

unscheduleDeployment

clearDeployment

remove

remove

findExistingChangeGroup

findExistingChangeGroup