Package org.broadleafcommerce.common.sandbox.service

Class SandBoxServiceImpl

java.lang.Object

org.broadleafcommerce.common.sandbox.service.SandBoxServiceImpl

All Implemented Interfaces:

SandBoxService

@Service("blSandBoxService")
public class SandBoxServiceImpl
extends Object
implements SandBoxService

Field Summary

Fields

Modifier and Type	Field	Description
protected SandBoxDao	sandBoxDao

Constructor Summary

Constructors

Constructor	Description
SandBoxServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	archiveChildSandboxes(Long parentSandBoxId)
boolean	checkForExistingApprovalSandboxWithName(String sandboxName)	Returns true if an existing sandboxName exists with the passed in name.
boolean	checkForExistingSandbox(SandBoxType sandBoxType, String sandboxName, Long authorId)
SandBox	createDefaultSandBox()
SandBox	createSandBox(String sandBoxName, SandBoxType sandBoxType)
Long	createUserSandBox(Long authorId, Long approvalSandbox)
SandBox	createUserSandBox(Long authorId, SandBox approvalSandBox)
List<SandBox>	retrieveAllSandBoxes()
List<SandBox>	retrieveAllUserSandBoxes(Long authorId)	Deprecated.
Map<Long,String>	retrieveAuthorNamesForSandBoxes(Set<Long> sandBoxIds)
List<SandBox>	retrieveChildSandBoxesByParentId(Long parentSandBoxId)
List<SandBox>	retrievePreviewSandBoxes(Long authorId)
SandBox	retrieveSandBox(String sandBoxName, SandBoxType sandBoxType)
SandBox	retrieveSandBoxById(Long sandboxId)
List<SandBox>	retrieveSandBoxesByType(SandBoxType type)
SandBox	retrieveSandBoxManagementById(Long sandBoxId)	Returns the SandBox by id but only if the SandBox is associated with the current site.
Map<Long,String>	retrieveSandboxNamesForSandBoxes(Set<Long> sandBoxIds)	Returns a map of SanboxId and Sandbox name
SandBox	retrieveUserSandBox(Long authorId, Long overrideSandBoxId, String sandBoxName)	Returns the sandbox currently associated with the passed in userId.
SandBox	retrieveUserSandBoxForParent(Long authorId, Long parentSandBoxId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

sandBoxDao

protected SandBoxDao sandBoxDao

Constructor Details

SandBoxServiceImpl

public SandBoxServiceImpl()

Method Details

retrieveSandBoxById

public SandBox retrieveSandBoxById(Long sandboxId)

Specified by:

retrieveSandBoxById in interface SandBoxService

retrieveAllSandBoxes

public List<SandBox> retrieveAllSandBoxes()

Specified by:

retrieveAllSandBoxes in interface SandBoxService

retrieveSandBoxesByType

public List<SandBox> retrieveSandBoxesByType(SandBoxType type)

Specified by:

retrieveSandBoxesByType in interface SandBoxService

retrieveUserSandBoxForParent

public SandBox retrieveUserSandBoxForParent(Long authorId,
 Long parentSandBoxId)

Specified by:

retrieveUserSandBoxForParent in interface SandBoxService

retrieveSandBoxManagementById

public SandBox retrieveSandBoxManagementById(Long sandBoxId)

Description copied from interface: SandBoxService

Returns the SandBox by id but only if the SandBox is associated with the current site.

Specified by:

retrieveSandBoxManagementById in interface SandBoxService

Returns:

retrievePreviewSandBoxes

public List<SandBox> retrievePreviewSandBoxes(Long authorId)

Specified by:

retrievePreviewSandBoxes in interface SandBoxService

retrieveUserSandBox

public SandBox retrieveUserSandBox(Long authorId,
 Long overrideSandBoxId,
 String sandBoxName)

Description copied from interface: SandBoxService

Returns the sandbox currently associated with the passed in userId. If one is not associated, it uses (or creates) a default user sandbox with the name: user:username.

Specified by:

retrieveUserSandBox in interface SandBoxService

Returns:

retrieveAuthorNamesForSandBoxes

public Map<Long,String> retrieveAuthorNamesForSandBoxes(Set<Long> sandBoxIds)

Specified by:

retrieveAuthorNamesForSandBoxes in interface SandBoxService

retrieveSandboxNamesForSandBoxes

public Map<Long,String> retrieveSandboxNamesForSandBoxes(Set<Long> sandBoxIds)

Description copied from interface: SandBoxService

Returns a map of SanboxId and Sandbox name

Specified by:

retrieveSandboxNamesForSandBoxes in interface SandBoxService

Returns:

createSandBox

public SandBox createSandBox(String sandBoxName,
 SandBoxType sandBoxType)

Specified by:

createSandBox in interface SandBoxService

createUserSandBox

public SandBox createUserSandBox(Long authorId,
 SandBox approvalSandBox)

Specified by:

createUserSandBox in interface SandBoxService

createUserSandBox

public Long createUserSandBox(Long authorId,
 Long approvalSandbox)

Specified by:

createUserSandBox in interface SandBoxService

createDefaultSandBox

public SandBox createDefaultSandBox()

Specified by:

createDefaultSandBox in interface SandBoxService

retrieveSandBox

public SandBox retrieveSandBox(String sandBoxName,
 SandBoxType sandBoxType)

Specified by:

retrieveSandBox in interface SandBoxService

retrieveAllUserSandBoxes

@Deprecated
public List<SandBox> retrieveAllUserSandBoxes(Long authorId)

Deprecated.

Specified by:

retrieveAllUserSandBoxes in interface SandBoxService

Returns:

a list of SandBox belonging to the user

archiveChildSandboxes

@Transactional("blTransactionManager")
public void archiveChildSandboxes(Long parentSandBoxId)

Specified by:

archiveChildSandboxes in interface SandBoxService

retrieveChildSandBoxesByParentId

public List<SandBox> retrieveChildSandBoxesByParentId(Long parentSandBoxId)

Specified by:

retrieveChildSandBoxesByParentId in interface SandBoxService

checkForExistingApprovalSandboxWithName

public boolean checkForExistingApprovalSandboxWithName(String sandboxName)

Description copied from interface: SandBoxService

Returns true if an existing sandboxName exists with the passed in name.

Specified by:

checkForExistingApprovalSandboxWithName in interface SandBoxService

Returns:

checkForExistingSandbox

public boolean checkForExistingSandbox(SandBoxType sandBoxType,
 String sandboxName,
 Long authorId)

Specified by:

checkForExistingSandbox in interface SandBoxService