org.broadleafcommerce.common.sandbox

Interface SandBoxHelper

All Known Implementing Classes:

DefaultSandBoxHelper

public interface SandBoxHelper

Utility class for working with sandboxable entities. The functionality provided by DefaultSandBoxHelper in core is generally innocuous, with more interesting sandbox related functionality being provided in the commercial enterprise module.

Author:

Jeff Fischer

See Also:

DefaultSandBoxHelper

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SandBoxHelper.OriginalIdResponse
static class	SandBoxHelper.QueryHints A query hint that can be passed to Query.setHint().

Method Summary

Methods

Modifier and Type	Method and Description
void	archiveObject(Object start, javax.persistence.EntityManager em) Archive an object so that it is no longer recognized by the sandbox support
SandBoxHelper.OriginalIdResponse	getOriginalId(javax.persistence.EntityManager em, Class<?> type, Long id) Return the original id for the requested id.
String[]	getSandBoxDiscriminatorFieldList() Retrieve the field names related to sandbox support
com.google.common.collect.BiMap<Long,Long>	getSandBoxToOriginalMap(javax.persistence.EntityManager em, Class<?> type, Long... ids) Retrieve a map keyed by sandbox id, with the value being the matching original item id for that sandbox item.
Long	getSandBoxVersionId(javax.persistence.EntityManager entityManager, Class<?> linkedObjectType, Long requestedParent) Return the sandbox version id for the requested original id.
Long	getSandBoxVersionId(javax.persistence.EntityManager entityManager, Class<?> linkedObjectType, Long requestedParent, Boolean includeSandBoxInheritance) Return the sandbox version id for the requested original id.
boolean	isPromote() Is the current thread involved in a promote operation?
boolean	isReject() Is the current thread involved in a reject operation?
boolean	isSandBoxable(String className) Whether or not the class is sandboxable
List<Long>	mergeCloneIds(javax.persistence.EntityManager em, Class<?> type, Long... originalIds) Retrieve a list of values that includes the the original ids passed in and any sandbox versions of those ids, if available.
void	optionallyIncludeDeletedItemsInQueriesAndCollections(Runnable runnable, boolean includeDeleted) For the passed in code block (Runnable), whether or not sandbox entities marked as deleted should be included in any results from queries or lazy collection retrievals.
void	setupSandBoxState(Object clone, javax.persistence.EntityManager em) Setup basic required fields for sandbox support

Method Detail

mergeCloneIds

List<Long> mergeCloneIds(javax.persistence.EntityManager em,
                       Class<?> type,
                       Long... originalIds)

Retrieve a list of values that includes the the original ids passed in and any sandbox versions of those ids, if available. This is useful for some queries that require search values for both the original id and the sandbox id.

Parameters:

em - the Entity Manager

type - the type of the entity in question

originalIds - one or more ids values for which sandbox versions should be included

Returns:

the merged id list

getSandBoxToOriginalMap

com.google.common.collect.BiMap<Long,Long> getSandBoxToOriginalMap(javax.persistence.EntityManager em,
                                                                 Class<?> type,
                                                                 Long... ids)

Retrieve a map keyed by sandbox id, with the value being the matching original item id for that sandbox item. Only members from the ids list passed in that have a sandbox counterpart are included.

Parameters:

em - the Entity Manager

type - the type of the entity in question

ids - list of ids to check

Returns:

the map of sandbox to original ids

getSandBoxVersionId

Long getSandBoxVersionId(javax.persistence.EntityManager entityManager,
                       Class<?> linkedObjectType,
                       Long requestedParent)

Return the sandbox version id for the requested original id. Will return null if no sandbox version is available.

Parameters:

entityManager - the Entity Manager

linkedObjectType - the type of the entity in question

requestedParent - the id to check

Returns:

the sandbox version, or null

getSandBoxVersionId

Long getSandBoxVersionId(javax.persistence.EntityManager entityManager,
                       Class<?> linkedObjectType,
                       Long requestedParent,
                       Boolean includeSandBoxInheritance)

Return the sandbox version id for the requested original id. Will return null if no sandbox version is available.

Parameters:

entityManager - the Entity Manager

linkedObjectType - the type of the entity in question

requestedParent - the id to check

includeSandBoxInheritance - override whether or not parent sandbox ids should be included in the query. Can be null - True by default.

Returns:

the sandbox version, or null

getOriginalId

SandBoxHelper.OriginalIdResponse getOriginalId(javax.persistence.EntityManager em,
                                             Class<?> type,
                                             Long id)

Return the original id for the requested id. Will return the passed in id if the type is not sandboxable. Will return null if the passed in id is not a sandbox record, or if it's a sandbox add.

Parameters:

em - the Entity Manager

type - the type of the entity in question

id - the id to check

Returns:

the original id for the requested sandbox id

setupSandBoxState

void setupSandBoxState(Object clone,
                     javax.persistence.EntityManager em)

Setup basic required fields for sandbox support

Parameters:

clone - the entity instance to setup

em - the Entity Manager

archiveObject

void archiveObject(Object start,
                 javax.persistence.EntityManager em)

Archive an object so that it is no longer recognized by the sandbox support

Parameters:

start - the object to archive

em - the Entity Manager

getSandBoxDiscriminatorFieldList

String[] getSandBoxDiscriminatorFieldList()

Retrieve the field names related to sandbox support

Returns:

the sandbox support fields

isSandBoxable

boolean isSandBoxable(String className)

Whether or not the class is sandboxable

Parameters:

className - the classname to check

Returns:

whether or not it's sandboxable

isPromote

boolean isPromote()

Is the current thread involved in a promote operation?

Returns:

whether or not a promote is currently taking place

isReject

boolean isReject()

Is the current thread involved in a reject operation?

Returns:

whether or not a reject is currently taking place

optionallyIncludeDeletedItemsInQueriesAndCollections

void optionallyIncludeDeletedItemsInQueriesAndCollections(Runnable runnable,
                                                        boolean includeDeleted)

For the passed in code block (Runnable), whether or not sandbox entities marked as deleted should be included in any results from queries or lazy collection retrievals.

Parameters:

runnable - the block of code for which this setting should be in effect

includeDeleted - whether or not to include deleted sandbox items