Package org.broadleafcommerce.common.sandbox.service

Interface SandBoxService

All Known Implementing Classes:
SandBoxServiceImpl
public interface SandBoxService

  • Method Details

    • retrieveSandBoxById

      SandBox retrieveSandBoxById(Long id)

    • retrieveAllSandBoxes

      List<SandBox> retrieveAllSandBoxes()

    • retrieveUserSandBox

      SandBox retrieveUserSandBox(Long authorId, Long overrideSandBoxId, String sandBoxName)
      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.
      Parameters:
      authorId -
      overrideSandBoxId -
      sandBoxName -
      Returns:

    • retrieveUserSandBoxForParent

      SandBox retrieveUserSandBoxForParent(Long authorId, Long parentSandBoxId)

    • retrieveSandBoxManagementById

      SandBox retrieveSandBoxManagementById(Long sandBoxId)
      Returns the SandBox by id but only if the SandBox is associated with the current site.
      Parameters:
      sandBoxId -
      Returns:

    • retrievePreviewSandBoxes

      List<SandBox> retrievePreviewSandBoxes(Long authorId)

    • retrieveSandBoxesByType

      List<SandBox> retrieveSandBoxesByType(SandBoxType type)

    • retrieveAuthorNamesForSandBoxes

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

    • retrieveSandboxNamesForSandBoxes

      Map<Long,String> retrieveSandboxNamesForSandBoxes(Set<Long> sandBoxIds)
      Returns a map of SanboxId and Sandbox name
      Parameters:
      sandBoxIds -
      Returns:

    • createSandBox

      SandBox createSandBox(String sandBoxName, SandBoxType sandBoxType) throws Exception
      Throws:
      Exception

    • createUserSandBox

      SandBox createUserSandBox(Long authorId, SandBox approvalSandBox)

    • createUserSandBox

      Long createUserSandBox(Long authorId, Long approvalSandbox)

    • retrieveSandBox

      SandBox retrieveSandBox(String sandBoxName, SandBoxType sandBoxType)

    • createDefaultSandBox

      SandBox createDefaultSandBox()

    • checkForExistingApprovalSandboxWithName

      boolean checkForExistingApprovalSandboxWithName(String sandboxName)
      Returns true if an existing sandboxName exists with the passed in name.
      Parameters:
      sandboxName -
      Returns:

    • retrieveAllUserSandBoxes

      List<SandBox> retrieveAllUserSandBoxes(Long authorId)
      Deprecated.
      Not used in BLC. May return incorrect results in MT installations. 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

    • archiveChildSandboxes

      void archiveChildSandboxes(Long parentSandBoxId)

    • retrieveChildSandBoxesByParentId

      List<SandBox> retrieveChildSandBoxesByParentId(Long parentSandBoxId)

    • checkForExistingSandbox

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