org.broadleafcommerce.common.sandbox.domain

Interface SandBox

All Superinterfaces:

Serializable, Status

All Known Implementing Classes:

SandBoxImpl

public interface SandBox
extends Serializable, Status

Method Summary

Modifier and Type	Method and Description
Character	getArchived()
Long	getAuthor()
List<SandBox>	getChildSandBoxes()
String	getColor()
Date	getGoLiveDate()
Long	getId()
boolean	getIsInDefaultHierarchy()
String	getName() The name of the sandbox.
SandBox	getParentSandBox()
List<Long>	getSandBoxIdsForUpwardHierarchy(boolean includeInherited)
List<Long>	getSandBoxIdsForUpwardHierarchy(boolean includeInherited, boolean includeCurrent)
SandBoxType	getSandBoxType()
boolean	isActive()
void	setArchived(Character archived)
void	setAuthor(Long author)
void	setChildSandBoxes(List<SandBox> childSandBoxes)
void	setColor(String color)
void	setGoLiveDate(Date goLiveDate)
void	setId(Long id)
void	setName(String name)
void	setParentSandBox(SandBox parentSandBox)
void	setSandBoxType(SandBoxType sandBoxType)

Method Detail

getId

Long getId()

setId

void setId(Long id)

getName

String getName()

The name of the sandbox. Certain sandbox names are reserved in the system. User created sandboxes cannot start with "", "approve_", or "deploy_".

Returns:

String sandbox name

setName

void setName(String name)

getSandBoxType

SandBoxType getSandBoxType()

setSandBoxType

void setSandBoxType(SandBoxType sandBoxType)

getAuthor

Long getAuthor()

setAuthor

void setAuthor(Long author)

getParentSandBox

SandBox getParentSandBox()

setParentSandBox

void setParentSandBox(SandBox parentSandBox)

getColor

String getColor()

setColor

void setColor(String color)

getGoLiveDate

Date getGoLiveDate()

setGoLiveDate

void setGoLiveDate(Date goLiveDate)

getSandBoxIdsForUpwardHierarchy

List<Long> getSandBoxIdsForUpwardHierarchy(boolean includeInherited)

getSandBoxIdsForUpwardHierarchy

List<Long> getSandBoxIdsForUpwardHierarchy(boolean includeInherited,
                                           boolean includeCurrent)

getChildSandBoxes

List<SandBox> getChildSandBoxes()

setChildSandBoxes

void setChildSandBoxes(List<SandBox> childSandBoxes)

getIsInDefaultHierarchy

boolean getIsInDefaultHierarchy()

Returns:

whether or not this sandbox, or any of its parent sandboxes, has type DEFAULT.

setArchived

void setArchived(Character archived)

Specified by:

setArchived in interface Status

getArchived

Character getArchived()

Specified by:

getArchived in interface Status

isActive

boolean isActive()

Specified by:

isActive in interface Status