org.broadleafcommerce.openadmin.server.domain
Interface SandBox

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

SandBoxImpl

public interface SandBox
extends java.io.Serializable

Method Summary

java.util.Set<AdminRole>	getAllowedRoles() Supports who can access this sandbox.
java.lang.Long	getAuthor()
java.lang.Long	getId()
java.lang.String	getName() The name of the sandbox.
java.util.List<SandBoxItem>	getSandBoxItems()
void	setAllowedRoles(java.util.Set<AdminRole> allowedRoles)
void	setAuthor(java.lang.Long author)
void	setId(java.lang.Long id)
void	setName(java.lang.String name)
void	setSandBoxItems(java.util.List<SandBoxItem> sandBoxItems)

Method Detail

getId

java.lang.Long getId()

setId

void setId(java.lang.Long id)

getName

java.lang.String getName()

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

Returns:

String sandbox name

setName

void setName(java.lang.String name)

getSandBoxItems

java.util.List<SandBoxItem> getSandBoxItems()

setSandBoxItems

void setSandBoxItems(java.util.List<SandBoxItem> sandBoxItems)

getAuthor

java.lang.Long getAuthor()

setAuthor

void setAuthor(java.lang.Long author)

getAllowedRoles

java.util.Set<AdminRole> getAllowedRoles()

Supports who can access this sandbox. Sandboxes can be accessed by convention. For example: Sandboxes with the "user_" prefix can only be modified by the corresponding user. Sandboxes with the "approve_" prefix can only be viewed/modified by users with the CONTENT_APPROVER role. the sandbox. Sandboxes with the "deploy_" prefix can only be viewed/deployed by users with the CONTENT_DEPLOYER role.

Returns:

Set Set of admin roles that can edit this sandbox.

setAllowedRoles

void setAllowedRoles(java.util.Set<AdminRole> allowedRoles)