com.broadleafcommerce.enterprise.common.domain

Interface SandBoxDiscriminator

All Superinterfaces:

SandBoxable, Serializable

public interface SandBoxDiscriminator
extends SandBoxable

Represents entities that require special treatment during editing in the admin. The system is capable of segregating changes made to SandBoxDiscriminator entities such that the changes can be promoted through an approval workflow before being eventually applied to production. Fields of SandBoxDiscriminator entities are used to limit visibility of the change to the correct sandbox such that admin screens and site preview screens are rendered correctly with the changes for the sandbox in question, while production screens for actual customers do not show these same changes until eventual deployment of those changes.

Author:

Jeff Fischer

Method Summary

Modifier and Type	Method and Description
Long	getCatalogFlag()
Long	getOriginalItemId() If this instance is a sandbox clone of a production record, this id points to that production record
Long	getOriginalRecordId()
Long	getSandBox() The sandbox identifier
Boolean	getSandBoxArchivedFlag() Whether or not this instance is archived.
Boolean	getSandBoxDeletedFlag() Whether or not this instance represents a deletion.
Long	getTemplateRecordId()
Long	getTier() Denotes how many promotion steps have taken place for this record.
void	setCatalogFlag(Long catalogFlag)
void	setOriginalItemId(Long originalItemId) If this instance is a sandbox clone of a production record, this id points to that production record
void	setOriginalRecordId(Long originalRecordId)
void	setSandBox(Long sandbox) The sandbox identifier
void	setSandBoxArchivedFlag(Boolean sandBoxArchivedFlag) Whether or not this instance is archived.
void	setSandBoxDeletedFlag(Boolean sandBoxDeletedFlag) Whether or not this instance represents a deletion.
void	setTemplateRecordId(Long templateRecordId)
void	setTier(Long tier) Denotes how many promotion steps have taken place for this record.

Method Detail

getSandBoxArchivedFlag

Boolean getSandBoxArchivedFlag()

Whether or not this instance is archived. Archived items do not show up in lists and are not retrieved in queries. Archivals usually occur as the result of reverting a change or completion of promotion of a change.

Returns:

archived status

setSandBoxArchivedFlag

void setSandBoxArchivedFlag(Boolean sandBoxArchivedFlag)

Whether or not this instance is archived. Archived items do not show up in lists and are not retrieved in queries. Archivals usually occur as the result of reverting a change or completion of promotion of a change.

Parameters:

sandBoxArchivedFlag - archived status

getSandBoxDeletedFlag

Boolean getSandBoxDeletedFlag()

Whether or not this instance represents a deletion. Deleted items do not show up in lists and are not generally retrieved in queries.

Returns:

sandbox delete status

setSandBoxDeletedFlag

void setSandBoxDeletedFlag(Boolean sandBoxDeletedFlag)

Whether or not this instance represents a deletion. Deleted items do not show up in lists and are not generally retrieved in queries.

Parameters:

sandBoxDeletedFlag - sandbox delete status

getOriginalItemId

Long getOriginalItemId()

If this instance is a sandbox clone of a production record, this id points to that production record

Returns:

the original production record, if any (will be null for add operations)

setOriginalItemId

void setOriginalItemId(Long originalItemId)

If this instance is a sandbox clone of a production record, this id points to that production record

Parameters:

originalItemId - the original production record

getSandBox

Long getSandBox()

The sandbox identifier

Returns:

the sandbox identifier

setSandBox

void setSandBox(Long sandbox)

The sandbox identifier

Parameters:

sandbox - the sandbox identifier

getTier

Long getTier()

Denotes how many promotion steps have taken place for this record. Tier 1 edits are for a user's sandbox. Tier 2 edits are for approval sandboxes.

Returns:

the number of promotion that have occurred to achieve this record

setTier

void setTier(Long tier)

Denotes how many promotion steps have taken place for this record. Tier 1 edits are for a user's sandbox. Tier 2 edits are for approval sandboxes.

Parameters:

tier - the number of promotion that have occurred to achieve this record

getTemplateRecordId

Long getTemplateRecordId()

setTemplateRecordId

void setTemplateRecordId(Long templateRecordId)

getOriginalRecordId

Long getOriginalRecordId()

setOriginalRecordId

void setOriginalRecordId(Long originalRecordId)

getCatalogFlag

Long getCatalogFlag()

setCatalogFlag

void setCatalogFlag(Long catalogFlag)