public interface WorkflowSandBoxItem extends Serializable
SandBoxDiscriminator
implementing
entity. WorkflowSandBoxItem allows the system to keep track of changes for promotion/reject/delete. It also serves as a
history of changes for audit purposes. It also keeps track of versions for SandBoxDiscriminator implementing entities so
that optimistic versioning and conflict resolution can be achieved for multi-user teams where concurrent editing on the
same item can take place.Modifier and Type | Method and Description |
---|---|
void |
addChild(WorkflowSandBoxItem child)
Add a new child.
|
Boolean |
getArchivedFlag()
Whether or not this item has been archived.
|
Map<String,WorkflowSandBoxItemAttribute> |
getAttributes()
Retrieve additional, arbitrary descriptive information
|
Boolean |
getCascade()
Whether or not this instance was created as part of a cascade promote.
|
List<WorkflowSandBoxItem> |
getChildItems()
WorkflowSandBoxItems are broken into two types: containers and children.
|
WorkflowSandBoxItem |
getContainer()
WorkflowSandBoxItems are broken into two types: containers and children.
|
Long |
getCreationSandBoxId()
The sandbox that originated the change.
|
Boolean |
getDenyPropagationFlag()
Whether or not this item should be allowed to propagate in multitenant scenarios.
|
List<WorkflowSandBoxItem> |
getDependentItems()
Other changes that this change depends on in some way.
|
String |
getDescription()
Describes the target sandboxable entity and property (if applicable) being edited.
|
Long |
getEntityItemId()
Link to the details of the change (actual changed property values, etc...)
|
List<WorkflowEventWorkflowItemXref> |
getEvents()
The event groups to which this item belongs.
|
String |
getGroupDescription()
Describes the top-level entity to which this change belongs.
|
Boolean |
getHasArchivedDependency()
Whether or not one or more of the items this item depends on are archived.
|
Boolean |
getHasError()
Whether or not an error occurred while trying to perform a workflow operation on this item.
|
Long |
getId() |
Long |
getInheritedVersion()
When a sync is performed, the inherited version is updated to denote the latest version the current sandbox
has absorbed.
|
Boolean |
getIsComplete()
Whether or not promotion replay for this instance is complete.
|
String |
getItemName()
A descriptive name taken from the changed entity (e.g.
|
String |
getNodeId()
Return an tag that identifies the jobs and events cluster node on which this instance was created.
|
Long |
getOriginalItemId()
If this was a change to a production record, this will be the id of the production record.
|
Long |
getOriginalSandBoxId()
If this change record resulted from a promotion, this id points to that earlier WorkflowSandBoxItem instance.
|
Long |
getOriginalWorkflowItemId()
During a promote/reject/revert a new WorkflowSandBoxItem is created to represent the new state based on the previous
state.
|
List<WorkflowSandBoxItem> |
getParentItems()
The reverse of
getDependentItems() . |
Long |
getProcessMarker()
During a production deployment, this item is marked with an identifier (along with all other items in that same
deployment) denoting that specific deployment event.
|
Long |
getPromotionMarker()
Identifies the
WorkflowEvent instance associated during a
promote (not an approve). |
String |
getPromotionMessage()
A descriptive message accompanying a promotion from a user's sandbox.
|
String |
getRejectionMessage()
A descriptive message accompanying a rejected promotion from a user's sandbox.
|
Long |
getSandBoxId()
The sandbox in which this change took place
|
SandBoxOperationOrigin |
getSandBoxOperationOrigin()
The way in which this item was generated
|
SandBoxOperationType |
getSandBoxOperationType()
The action that describes the general purpose for this change
|
Date |
getScheduledDate()
The date/time for deployment to production if this item is part of a
WorkflowDeployment |
List<WorkflowSandBoxItem> |
getUnfilteredChildItems()
Returns an unfiltered list of child
WorkflowSandBoxItem with maps and collection items first. |
Long |
getVersion()
The version of the target entity for which this change applies.
|
List<WorkflowSandboxItemError> |
getWorkflowSandboxItemErrors()
Allows us to access one or more errors associated with a sandbox operation.
|
void |
setArchivedFlag(Boolean archivedFlag)
Whether or not this item has been archived.
|
void |
setAttributes(Map<String,WorkflowSandBoxItemAttribute> attributes) |
void |
setCascade(Boolean cascade) |
void |
setChildItems(List<WorkflowSandBoxItem> childItems)
WorkflowSandBoxItems are broken into two types: containers and children.
|
void |
setContainer(WorkflowSandBoxItem container)
WorkflowSandBoxItems are broken into two types: containers and children.
|
void |
setCreationSandBoxId(Long creationSandBoxId)
The sandbox that originated the change.
|
void |
setDenyPropagationFlag(Boolean allowPropagationFlag)
Whether or not this item should be allowed to propagate in multitenant scenarios.
|
void |
setDependentItems(List<WorkflowSandBoxItem> dependentItems)
Other changes that this change depends on in some way.
|
void |
setDescription(String description)
Describes the target sandboxable entity and property (if applicable) being edited.
|
void |
setEntityItemId(Long entityItemId)
Link to the details of the change (actual changed property values, etc...)
|
void |
setEvents(List<WorkflowEventWorkflowItemXref> events)
The event groups to which this item belongs.
|
void |
setGroupDescription(String groupDescription)
Describes the top-level entity to which this change belongs.
|
void |
setHasArchivedDependency(Boolean hasArchivedDependency)
Whether or not one or more of the items this item depends on are archived.
|
void |
setHasError(Boolean hasError)
Whether or not an error occurred while trying to perform a workflow operation on this item.
|
void |
setId(Long id) |
void |
setInheritedVersion(Long parentVersion)
When a sync is performed, the inherited version is updated to denote the latest version the current sandbox
has absorbed.
|
void |
setIsComplete(Boolean isComplete) |
void |
setItemName(String itemName)
A descriptive name taken from the changed entity (e.g.
|
void |
setNodeId(String nodeId) |
void |
setOriginalItemId(Long itemIdentifer)
If this was a change to a production record, this will be the id of the production record.
|
void |
setOriginalSandBoxId(Long originalSandBoxId)
If this change record resulted from a promotion, this id points to that earlier WorkflowSandBoxItem instance.
|
void |
setOriginalWorkflowItemId(Long originalWorkflowItemId)
During a promote/reject/revert a new WorkflowSandBoxItem is created to represent the new state based on the previous
state.
|
void |
setParentItems(List<WorkflowSandBoxItem> parentItems)
The reverse of
getDependentItems() . |
void |
setProcessMarker(Long processMarker)
During a production deployment, this item is marked with an identifier (along with all other items in that same
deployment) denoting that specific deployment event.
|
void |
setPromotionMarker(Long promotionMarker) |
void |
setPromotionMessage(String promotionMessage)
A descriptive message accompanying a promotion from a user's sandbox.
|
void |
setRejectionMessage(String rejectionMessage)
A descriptive message accompanying a rejected promotion from a user's sandbox.
|
void |
setSandBoxId(Long sandBoxId)
The sandbox in which this change took place
|
void |
setSandBoxOperationOrigin(SandBoxOperationOrigin sandboxOperationOrigin)
The way in which this item was generated
|
void |
setSandBoxOperationType(SandBoxOperationType sandboxOperationType)
The action that describes the general purpose for this change
|
void |
setScheduledDate(Date scheduledDate)
The date/time for deployment to production if this item is part of a
WorkflowDeployment |
void |
setVersion(Long version)
The version of the target entity for which this change applies.
|
void |
setWorkflowSandboxItemErrors(List<WorkflowSandboxItemError> errors)
Allows us to set one or more errors associated with a sandbox operation.
|
Long getId()
void setId(Long id)
Long getSandBoxId()
void setSandBoxId(Long sandBoxId)
sandBoxId
- the sandboxLong getOriginalSandBoxId()
void setOriginalSandBoxId(Long originalSandBoxId)
originalSandBoxId
- the WorkflowSandBoxItem that this record was promoted fromvoid setSandBoxOperationOrigin(SandBoxOperationOrigin sandboxOperationOrigin)
sandboxOperationOrigin
- The way in which this item was generatedSandBoxOperationOrigin getSandBoxOperationOrigin()
SandBoxOperationType getSandBoxOperationType()
void setSandBoxOperationType(SandBoxOperationType sandboxOperationType)
sandboxOperationType
- the action typeString getDescription()
SandBoxDescriptor
void setDescription(String description)
description
- describes the changed entitySandBoxDescriptor
String getItemName()
void setItemName(String itemName)
itemName
- the name for the changed entityLong getOriginalItemId()
void setOriginalItemId(Long itemIdentifer)
itemIdentifer
- the production record this change was againstLong getEntityItemId()
EntityItem
EntityItem
void setEntityItemId(Long entityItemId)
entityItemId
- the id for the EntityItem
EntityItem
Boolean getArchivedFlag()
void setArchivedFlag(Boolean archivedFlag)
archivedFlag
- archived statusBoolean getDenyPropagationFlag()
void setDenyPropagationFlag(Boolean allowPropagationFlag)
allowPropagationFlag
- whether propagation is allowedString getGroupDescription()
SandBoxDescriptor
void setGroupDescription(String groupDescription)
groupDescription
- top-level entity descriptionSandBoxDescriptor
Long getVersion()
void setVersion(Long version)
version
- the current version for the change based on the target change entityLong getCreationSandBoxId()
void setCreationSandBoxId(Long creationSandBoxId)
creationSandBoxId
- the user's sandbox that originated the change.Long getInheritedVersion()
void setInheritedVersion(Long parentVersion)
parentVersion
- the latest version absorbed for the changed entity.String getPromotionMessage()
void setPromotionMessage(String promotionMessage)
promotionMessage
- the descriptive promotion messageString getRejectionMessage()
void setRejectionMessage(String rejectionMessage)
rejectionMessage
- the descriptive promotion rejection messageList<WorkflowSandBoxItem> getDependentItems()
void setDependentItems(List<WorkflowSandBoxItem> dependentItems)
dependentItems
- Other changes that this change depends on in some wayLong getOriginalWorkflowItemId()
void setOriginalWorkflowItemId(Long originalWorkflowItemId)
originalWorkflowItemId
- the originating WorkflowSandBoxItem.Long getProcessMarker()
void setProcessMarker(Long processMarker)
processMarker
- deployment identifierList<WorkflowEventWorkflowItemXref> getEvents()
void setEvents(List<WorkflowEventWorkflowItemXref> events)
events
- the event groups in the approval sandboxBoolean getHasError()
void setHasError(Boolean hasError)
hasError
- whether or not there was an errorList<WorkflowSandBoxItem> getParentItems()
getDependentItems()
. Find items that depend on this item.void setParentItems(List<WorkflowSandBoxItem> parentItems)
getDependentItems()
. Find items that depend on this item.parentItems
- items that depend on this item.Boolean getHasArchivedDependency()
void setHasArchivedDependency(Boolean hasArchivedDependency)
hasArchivedDependency
- Whether or not one or more of the items this item depends on are archived.Date getScheduledDate()
WorkflowDeployment
void setScheduledDate(Date scheduledDate)
WorkflowDeployment
scheduledDate
- target date for deployment to productionWorkflowSandBoxItem getContainer()
void setContainer(WorkflowSandBoxItem container)
container
- the WorkflowSandBoxItem instance for which this item is a child. Will be null if this item is a container.List<WorkflowSandBoxItem> getChildItems()
List<WorkflowSandBoxItem> getUnfilteredChildItems()
WorkflowSandBoxItem
with maps and collection items first. When iterating and
executing operations like cloning on these the items it will prevent breaking dependencies existing on the parent item as these
collections will be processed first.void setChildItems(List<WorkflowSandBoxItem> childItems)
childItems
- the WorkflowSandBoxItem instances that belong to this container. Will be empty if this item is a child.void addChild(WorkflowSandBoxItem child)
child
- the WorkflowSandBoxItem instance that belongs to this container.Boolean getCascade()
void setCascade(Boolean cascade)
Map<String,WorkflowSandBoxItemAttribute> getAttributes()
void setAttributes(Map<String,WorkflowSandBoxItemAttribute> attributes)
void setWorkflowSandboxItemErrors(List<WorkflowSandboxItemError> errors)
errors
- List<WorkflowSandboxItemError> getWorkflowSandboxItemErrors()
String getNodeId()
DatabaseSystemEventNode
void setNodeId(String nodeId)
Boolean getIsComplete()
void setIsComplete(Boolean isComplete)
Long getPromotionMarker()
WorkflowEvent
instance associated during a
promote (not an approve).void setPromotionMarker(Long promotionMarker)
Copyright © 2019. All rights reserved.