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

Method Summary

Modifier and Type	Method and Description
Long	getCascadedProductionStateId(Class<?> linkedObjectType, Long requestedParent)
SandBoxHelper.OriginalIdResponse	getOriginalId(Class<?> type, Long id) Return the original id for the requested id.
Long	getOriginalId(Object test)
SandBoxHelper.OriginalIdResponse	getProductionOriginalId(Class<?> type, Long id) Return the original id for the requested id as if this was a production request.
Long	getProductionRecordIdIfApplicable(javax.persistence.EntityManager em, Object startFieldValue)
com.google.common.collect.BiMap<Long,Long>	getSandBoxToOriginalMap(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(Class<?> linkedObjectType, Long requestedParent) 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	isReplayOperation() Is the current thread involved in a replay operation (i.e.
boolean	isSandBoxable(String className) Whether or not the class is sandboxable
List<Long>	mergeCloneIds(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.

Method Detail

mergeCloneIds

List<Long> mergeCloneIds(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:

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(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:

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(Class<?> linkedObjectType,
                         Long requestedParent)

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

Parameters:

linkedObjectType - the type of the entity in question

requestedParent - the id to check

Returns:

the sandbox version, or null

getCascadedProductionStateId

Long getCascadedProductionStateId(Class<?> linkedObjectType,
                                  Long requestedParent)

getOriginalId

SandBoxHelper.OriginalIdResponse getOriginalId(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:

type - the type of the entity in question

id - the id to check

Returns:

the original id for the requested sandbox id

getProductionOriginalId

SandBoxHelper.OriginalIdResponse getProductionOriginalId(Class<?> type,
                                                         Long id)

Return the original id for the requested id as if this was a production request. The id passed in should be a production id. You will receive back the original id for this production id. The only time this makes sense is when the passed in id is for the production record from a standard site. This method is useful when you want the template record id for a standard site production id while in a sandbox context.

Parameters:

type -

id -

Returns:

getOriginalId

Long getOriginalId(Object test)

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

isReplayOperation

boolean isReplayOperation()

Is the current thread involved in a replay operation (i.e. promote, revert, reject, approve and sync).

Returns:

whether or not there is a replay operation in progress

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

getProductionRecordIdIfApplicable

Long getProductionRecordIdIfApplicable(javax.persistence.EntityManager em,
                                       Object startFieldValue)

Parameters:

em -

startFieldValue -

Returns: