Package com.broadleafcommerce.sandbox.service

Interface ChangeSummaryGroupService<P extends ChangeSummaryGroup>

All Superinterfaces:

com.broadleafcommerce.data.tracking.core.service.MappableCrudEntityService<P>, com.broadleafcommerce.data.tracking.core.service.RsqlMappableCrudEntityService<P>

All Known Implementing Classes:

DefaultChangeSummaryGroupService

public interface ChangeSummaryGroupService<P extends ChangeSummaryGroup>
extends com.broadleafcommerce.data.tracking.core.service.RsqlMappableCrudEntityService<P>

Service for working with instances. Primarily involves CRUD operations going through ChangeSummaryGroupRepository.

Author:

Jeff Fischer

Method Summary

Modifier and Type	Method	Description
void	archiveChangeSummaryGroupsForSandbox(String sandboxId)	Archives the group of ChangeSummary for the specified sandbox id.
boolean	batchTransition(PromoteBatchFlushContext flushContext)	Add all the members identified in SummaryBasedFlushContext.getSummaryUpdates() to the ChangeSummaryGroup.getChangeSummaryIds() collection via the ChangeSummaryGroup identified in PromoteBatchFlushContext.getGroupUpdate().
boolean	batchTransition(StateChangeOnlyBatchFlushContext flushContext)	Update ChangeSummaryGroup instances in bulk (identified by PromoteBatchFlushContext.getGroupUpdate()) in order to mutate state (such as ChangeSummaryGroup.getState()).
P	readByIdAndNotArchived(String id)	Takes ChangeSummaryGroup.getArchived() into account when retrieving a group with the given ID.
P	readByIdAndNotArchived(String id, boolean vendorNarrowing, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Takes ChangeSummaryGroup.getArchived() into account when retrieving a group with the given ID.
Long	readChangeSummaryGroupByIdsCount(List<String> changeSummaryGroupIds, List<String> states, List<String> statuses, String sandbox)	Given a list of ChangeSummaryGroup ids, find the count of groups that match the state requirements defined in the params.
org.springframework.data.domain.Page<P>	readChangeSummaryGroups(String state, String sandbox, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable)	Deprecated. since 1.3, replaced by readChangeSummaryGroups(String, String, Node, Pageable, boolean, ContextInfo)
org.springframework.data.domain.Page<P>	readChangeSummaryGroups(String state, String sandbox, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable, boolean vendorNarrowing, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Find a page of ChangeSummaryGroup records based on the state and sandbox.
Stream<P>	readChangeSummaryGroupsByIds(List<String> changeSummaryGroupIds)	Find all ChangeSummaryGroup instances matching primarily a list of ids.
Stream<P>	readChangeSummaryGroupsByIds(List<String> changeSummaryGroupIds, List<String> states, List<String> statuses, String sandbox)	Find all ChangeSummaryGroup instances matching primarily a list of ids.
Stream<P>	readChangeSummaryGroupsByIds(List<String> changeSummaryGroupIds, List<String> states, List<String> statuses, String sandbox, boolean vendorNarrowing, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Find all ChangeSummaryGroup instances matching primarily a list of ids.
Stream<P>	readChangeSummaryGroupsBySandbox(String sandbox, String state, List<String> status)	Deprecated. since 1.3, replaced by readChangeSummaryGroupsBySandbox(String, String, List, boolean, ContextInfo)
Stream<P>	readChangeSummaryGroupsBySandbox(String sandbox, String state, List<String> status, boolean vendorNarrowing, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Find all ChangeSummaryGroup instances matching primarily the sandbox.
org.springframework.data.domain.Page<P>	readChangeSummaryGroupsForUser(String state, String sandbox, String author, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable)	Deprecated. since 1.3, replaced by readChangeSummaryGroupsForUser(String, String, String, Node, Pageable, boolean, ContextInfo)
org.springframework.data.domain.Page<P>	readChangeSummaryGroupsForUser(String state, String sandbox, String author, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable, boolean vendorNarrowing, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Find a page of ChangeSummaryGroup records based on the state and sandbox.
boolean	removeFromAffectedVendors(String changeSummaryGroupId, String vendorRef)	Atomically removes the given vendorRef from ChangeSummaryGroup.getAffectedVendorRefs() of the given changeSummaryGroupId if present.
boolean	updateVals(String changeSummaryGroupId, List<String> whereStates, List<String> whereStatus, Map<String,Object> vals, boolean enforceArchive)	Update the fields for a record matching the id

Methods inherited from interface com.broadleafcommerce.data.tracking.core.service.MappableCrudEntityService

create, createAll, createAllAllowingPartialSuccess, delete, readAll, readAll, readAll, readAllByIds, readById, replace, replaceAll, replaceAllAllowingPartialSuccess, update, updateAll, updateAllAllowingPartialSuccess

Methods inherited from interface com.broadleafcommerce.data.tracking.core.service.RsqlMappableCrudEntityService

readAll, readAll, readAll, readAll

Method Details

readByIdAndNotArchived

P readByIdAndNotArchived(@NonNull
 String id)

Takes ChangeSummaryGroup.getArchived() into account when retrieving a group with the given ID.

Parameters:

id - ID of the group to retrieve

Returns:

A ChangeSummaryGroup matching the given ID and not archived

readByIdAndNotArchived

P readByIdAndNotArchived(@NonNull
 String id,
 boolean vendorNarrowing,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Takes ChangeSummaryGroup.getArchived() into account when retrieving a group with the given ID.

Parameters:

id - ID of the group to retrieve

vendorNarrowing - whether or not to filter results based on the current authentication's vendor restrictions if vendor processing is enabled

contextInfo - context information about sandboxing and multitenant state

Returns:

A ChangeSummaryGroup matching the given ID and not archived

readChangeSummaryGroups

@Deprecated
org.springframework.data.domain.Page<P> readChangeSummaryGroups(@NonNull
 String state,
 @NonNull
 String sandbox,
 @Nullable
 cz.jirutka.rsql.parser.ast.Node filters,
 @NonNull
 org.springframework.data.domain.Pageable pageable)

Deprecated.

since 1.3, replaced by readChangeSummaryGroups(String, String, Node, Pageable, boolean, ContextInfo)

Find a page of ChangeSummaryGroup records based on the state and sandbox. This primarily drives visibility of state related to ChangeState.PROMOTED and ChangeState.APPROVED. However, other states are possible and can be retrieved here as well.

Parameters:

state - ChangeSummaryGroup.getState()

sandbox - ChangeSummaryGroup.getSandbox()

filters - the RSQL Node used to restrict result

pageable - Page setup information

Returns:

page of matching records

readChangeSummaryGroups

org.springframework.data.domain.Page<P> readChangeSummaryGroups(@NonNull
 String state,
 @NonNull
 String sandbox,
 @Nullable
 cz.jirutka.rsql.parser.ast.Node filters,
 @NonNull
 org.springframework.data.domain.Pageable pageable,
 boolean vendorNarrowing,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Find a page of ChangeSummaryGroup records based on the state and sandbox. This primarily drives visibility of state related to ChangeState.PROMOTED and ChangeState.APPROVED. However, other states are possible and can be retrieved here as well.

Parameters:

state - ChangeSummaryGroup.getState()

sandbox - ChangeSummaryGroup.getSandbox()

filters - the RSQL Node used to restrict result

pageable - Page setup information

vendorNarrowing - whether or not to filter results based on the current authentication's vendor restrictions if vendor processing is enabled

contextInfo - context information about sandboxing and multitenant state

Returns:

page of matching records

readChangeSummaryGroupsForUser

@Deprecated
org.springframework.data.domain.Page<P> readChangeSummaryGroupsForUser(@NonNull
 String state,
 @NonNull
 String sandbox,
 @Nullable
 String author,
 @Nullable
 cz.jirutka.rsql.parser.ast.Node filters,
 @NonNull
 org.springframework.data.domain.Pageable pageable)

Deprecated.

since 1.3, replaced by readChangeSummaryGroupsForUser(String, String, String, Node, Pageable, boolean, ContextInfo)

Find a page of ChangeSummaryGroup records based on the state and sandbox. This primarily drives visibility of state related to ChangeState.PROMOTED for a specific author.

Parameters:

state - The ChangeState value for which ChangeSummaryGroup.getState() should match

sandbox - ChangeSummaryGroup.getSandbox()

author - ChangeSummaryGroup.getAuthor()

filters - the RSQL Node used to restrict result

pageable - Page setup information

Returns:

page of matching records

readChangeSummaryGroupsForUser

org.springframework.data.domain.Page<P> readChangeSummaryGroupsForUser(@NonNull
 String state,
 @NonNull
 String sandbox,
 @Nullable
 String author,
 @Nullable
 cz.jirutka.rsql.parser.ast.Node filters,
 @NonNull
 org.springframework.data.domain.Pageable pageable,
 boolean vendorNarrowing,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Find a page of ChangeSummaryGroup records based on the state and sandbox. This primarily drives visibility of state related to ChangeState.PROMOTED for a specific author.

Parameters:

state - The ChangeState value for which ChangeSummaryGroup.getState() should match

sandbox - ChangeSummaryGroup.getSandbox()

author - ChangeSummaryGroup.getAuthor()

filters - the RSQL Node used to restrict result

pageable - Page setup information

vendorNarrowing - whether or not to filter results based on the current authentication's vendor restrictions if vendor processing is enabled

contextInfo - context information about sandboxing and multitenant state

Returns:

page of matching records

readChangeSummaryGroupsBySandbox

@Deprecated
Stream<P> readChangeSummaryGroupsBySandbox(@NonNull
 String sandbox,
 @NonNull
 String state,
 List<String> status)

Deprecated.

since 1.3, replaced by readChangeSummaryGroupsBySandbox(String, String, List, boolean, ContextInfo)

Find all ChangeSummaryGroup instances matching primarily the sandbox.

Parameters:

sandbox - The sandbox for which the ChangeSummaryGroup.getSandbox() should match

state - The ChangeState value for which ChangeSummaryGroup.getState() should match

status - The list of ChangeStatusType values for which ChangeSummaryGroup.getStatus() should match one or more of. Can be empty

Returns:

A Stream that can be iterated, possibly containing a large number or records

readChangeSummaryGroupsBySandbox

Stream<P> readChangeSummaryGroupsBySandbox(@NonNull
 String sandbox,
 @NonNull
 String state,
 List<String> status,
 boolean vendorNarrowing,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Find all ChangeSummaryGroup instances matching primarily the sandbox.

Parameters:

sandbox - The sandbox for which the ChangeSummaryGroup.getSandbox() should match

state - The ChangeState value for which ChangeSummaryGroup.getState() should match

status - The list of ChangeStatusType values for which ChangeSummaryGroup.getStatus() should match one or more of. Can be empty

vendorNarrowing - whether or not to filter results based on the current authentication's vendor restrictions if vendor processing is enabled

contextInfo - context information about sandboxing and multitenant state

Returns:

A Stream that can be iterated, possibly containing a large number or records

readChangeSummaryGroupsByIds

Stream<P> readChangeSummaryGroupsByIds(List<String> changeSummaryGroupIds,
 List<String> states,
 List<String> statuses,
 @NonNull
 String sandbox)

Find all ChangeSummaryGroup instances matching primarily a list of ids.

Parameters:

changeSummaryGroupIds - The list of ChangeSummaryGroup.getId() values to match

states - The ChangeState values for which ChangeSummaryGroup.getState() should match

statuses - The list of ChangeStatusType values for which ChangeSummaryGroup.getStatus() should match one of more of. Can be empty

sandbox - The sandbox for which the ChangeSummaryGroup.getSandbox() should match

Returns:

A Stream that can be iterated, possibly containing a large number or records

readChangeSummaryGroupsByIds

Stream<P> readChangeSummaryGroupsByIds(List<String> changeSummaryGroupIds,
 List<String> states,
 List<String> statuses,
 @NonNull
 String sandbox,
 boolean vendorNarrowing,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Find all ChangeSummaryGroup instances matching primarily a list of ids.

Parameters:

changeSummaryGroupIds - The list of ChangeSummaryGroup.getId() values to match

states - The ChangeState values for which ChangeSummaryGroup.getState() should match

statuses - The list of ChangeStatusType values for which ChangeSummaryGroup.getStatus() should match one of more of. Can be empty

sandbox - The sandbox for which the ChangeSummaryGroup.getSandbox() should match

vendorNarrowing - whether or not to filter results based on the current authentication's vendor restrictions if vendor processing is enabled

contextInfo - context information about sandboxing and multitenant state

Returns:

A Stream that can be iterated, possibly containing a large number or records

readChangeSummaryGroupsByIds

Stream<P> readChangeSummaryGroupsByIds(List<String> changeSummaryGroupIds)

Find all ChangeSummaryGroup instances matching primarily a list of ids.

Parameters:

changeSummaryGroupIds - The list of ChangeSummaryGroup.getId() values to match

Returns:

A Stream that can be iterated, possibly containing a large number or records

readChangeSummaryGroupByIdsCount

Long readChangeSummaryGroupByIdsCount(@NonNull
 List<String> changeSummaryGroupIds,
 List<String> states,
 List<String> statuses,
 @NonNull
 String sandbox)

Given a list of ChangeSummaryGroup ids, find the count of groups that match the state requirements defined in the params.

Parameters:

changeSummaryGroupIds - The group ids to check

states - The ChangeState value for which ChangeSummaryGroup.getState() should match. Cannot be empty

statuses - The list of ChangeStatusType values for which ChangeSummaryGroup.getStatus() should match one of more of. Can be empty to indicate no filtration

sandbox - The sandbox for which the ChangeSummaryGroup.getSandbox() should match

Returns:

The count of entities matching the requested params

updateVals

boolean updateVals(@NonNull
 String changeSummaryGroupId,
 List<String> whereStates,
 List<String> whereStatus,
 Map<String,Object> vals,
 boolean enforceArchive)

Update the fields for a record matching the id

Parameters:

changeSummaryGroupId - The id requested to mutate

whereStates - all valid ChangeState values for which ChangeSummaryGroup.getState() should match

whereStatus - The list of ChangeStatusType values for which ChangeSummaryGroup.getStatus() should match one or more of. Can be empty

vals - Map of field to value changes to make to the ChangeSummaryGroup instance

enforceArchive - Whether archive status should be checked before updating

Returns:

Whether or not an update was performed. If no record found matching the id and state, will return false.

batchTransition

boolean batchTransition(PromoteBatchFlushContext flushContext)

Add all the members identified in SummaryBasedFlushContext.getSummaryUpdates() to the ChangeSummaryGroup.getChangeSummaryIds() collection via the ChangeSummaryGroup identified in PromoteBatchFlushContext.getGroupUpdate().

Parameters:

flushContext - Context object containing the change summary list to add to the group

batchTransition

boolean batchTransition(StateChangeOnlyBatchFlushContext flushContext)

Update ChangeSummaryGroup instances in bulk (identified by PromoteBatchFlushContext.getGroupUpdate()) in order to mutate state (such as ChangeSummaryGroup.getState()).

Parameters:

flushContext - Context object containing the change summary group transition information to commit

archiveChangeSummaryGroupsForSandbox

@Transactional("sandboxTransactionManager")
void archiveChangeSummaryGroupsForSandbox(String sandboxId)

Archives the group of ChangeSummary for the specified sandbox id.

Parameters:

sandboxId - the sandbox id associated to the change summary groups

removeFromAffectedVendors

boolean removeFromAffectedVendors(String changeSummaryGroupId,
 String vendorRef)

Atomically removes the given vendorRef from ChangeSummaryGroup.getAffectedVendorRefs() of the given changeSummaryGroupId if present.

Parameters:

changeSummaryGroupId - the ID of the group to update

vendorRef - the vendor ref to remove from ChangeSummaryGroup.getAffectedVendorRefs()

Returns:

true if the removal was successful, false otherwise