org.broadleafcommerce.common.sandbox.dao

Interface SandBoxDao

All Known Implementing Classes:

SandBoxDaoImpl

public interface SandBoxDao

Method Summary

Modifier and Type	Method and Description
SandBox	createDefaultSandBox()
SandBox	createSandBox(String sandBoxName, SandBoxType sandBoxType)
SandBox	createUserSandBox(Long authorId, SandBox approvalSandBox)
SandBox	merge(SandBox userSandBox)
SandBox	persist(SandBox entity)
SandBox	retrieve(Long id)
List<SandBox>	retrieveAllSandBoxes()
List<SandBox>	retrieveAllUserSandBoxes(Long authorId) Deprecated. Not used in BLC. In a Multi-site context, may return results outside of a given tenant. Reads all SandBoxes that are of type SandBoxType.USER and belong to the given user.
Map<Long,String>	retrieveAuthorNamesForSandBoxes(Set<Long> sandBoxIds)
List<SandBox>	retrieveChildSandBoxesByParentId(Long parentSandBoxId)
SandBox	retrieveNamedSandBox(SandBoxType sandboxType, String sandboxName)
SandBox	retrieveNamedSandBox(SandBoxType sandBoxType, String sandboxName, Long authorId)
List<SandBox>	retrieveSandBoxesByType(SandBoxType sandboxType)
List<SandBox>	retrieveSandBoxesForAuthor(Long authorId)
List<SandBox>	retrieveSandBoxesForAuthor(Long authorId, SandBoxType sandBoxType)
SandBox	retrieveSandBoxManagementById(Long sandBoxId)
Map<Long,String>	retrieveSandboxNamesForSandBoxes(Set<Long> sandBoxIds)
SandBox	retrieveUserSandBoxForParent(Long authorId, Long parentSandBoxId)

Method Detail

retrieve

SandBox retrieve(Long id)

retrieveAllSandBoxes

List<SandBox> retrieveAllSandBoxes()

retrieveSandBoxesByType

List<SandBox> retrieveSandBoxesByType(SandBoxType sandboxType)

retrieveSandBoxesForAuthor

List<SandBox> retrieveSandBoxesForAuthor(Long authorId)

retrieveUserSandBoxForParent

SandBox retrieveUserSandBoxForParent(Long authorId,
                                     Long parentSandBoxId)

retrieveSandBoxManagementById

SandBox retrieveSandBoxManagementById(Long sandBoxId)

retrieveNamedSandBox

SandBox retrieveNamedSandBox(SandBoxType sandboxType,
                             String sandboxName)

retrieveAuthorNamesForSandBoxes

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

retrieveSandboxNamesForSandBoxes

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

retrieveSandBoxesForAuthor

List<SandBox> retrieveSandBoxesForAuthor(Long authorId,
                                         SandBoxType sandBoxType)

persist

SandBox persist(SandBox entity)

createSandBox

SandBox createSandBox(String sandBoxName,
                      SandBoxType sandBoxType)

createUserSandBox

SandBox createUserSandBox(Long authorId,
                          SandBox approvalSandBox)

createDefaultSandBox

SandBox createDefaultSandBox()

retrieveAllUserSandBoxes

@Deprecated
List<SandBox> retrieveAllUserSandBoxes(Long authorId)

Deprecated. Not used in BLC. In a Multi-site context, may return results outside of a given tenant. Reads all SandBoxes that are of type SandBoxType.USER and belong to the given user.

Parameters:

authorId -

Returns:

a list of SandBox belonging to the user

merge

SandBox merge(SandBox userSandBox)

retrieveChildSandBoxesByParentId

List<SandBox> retrieveChildSandBoxesByParentId(Long parentSandBoxId)

retrieveNamedSandBox

SandBox retrieveNamedSandBox(SandBoxType sandBoxType,
                             String sandboxName,
                             Long authorId)