Package com.broadleafcommerce.sandbox.service

Class DefaultChangeSummaryGroupService<P extends ChangeSummaryGroup>

java.lang.Object

com.broadleafcommerce.data.tracking.core.service.BaseMappableCrudEntityService<P>

com.broadleafcommerce.data.tracking.core.service.BaseRsqlMappableCrudEntityService<P>

com.broadleafcommerce.sandbox.service.DefaultChangeSummaryGroupService<P>

All Implemented Interfaces:

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

public class DefaultChangeSummaryGroupService<P extends ChangeSummaryGroup>
extends com.broadleafcommerce.data.tracking.core.service.BaseRsqlMappableCrudEntityService<P>
implements ChangeSummaryGroupService<P>

Author:

Jeff Fischer

Constructor Summary

Constructors

Constructor	Description
DefaultChangeSummaryGroupService(ChangeSummaryGroupRepository<?> repository, com.broadleafcommerce.data.tracking.core.service.RsqlMappableCrudEntityHelper helper)

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()).
protected ChangeSummaryGroupRepository<?>	getRepository()
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> status, 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)	Find a page of ChangeSummaryGroup records based on the state and sandbox.
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> state, List<String> status, String sandbox)	Find all ChangeSummaryGroup instances matching primarily a list of ids.
Stream<P>	readChangeSummaryGroupsByIds(List<String> changeSummaryGroupIds, List<String> state, List<String> status, 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.
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)	Find a page of ChangeSummaryGroup records based on the state and 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, boolean vendorNarrowing, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Find a page of ChangeSummaryGroup records based on the state and sandbox.
boolean	removeFromAffectedVendors(@NonNull String changeSummaryGroupId, @NonNull 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 class com.broadleafcommerce.data.tracking.core.service.BaseRsqlMappableCrudEntityService

getRsqlHelper, readAll, readAll, readAll, readAll

Methods inherited from class com.broadleafcommerce.data.tracking.core.service.BaseMappableCrudEntityService

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Constructor Details

DefaultChangeSummaryGroupService

public DefaultChangeSummaryGroupService(ChangeSummaryGroupRepository<?> repository,
 com.broadleafcommerce.data.tracking.core.service.RsqlMappableCrudEntityHelper helper)

Method Details

readByIdAndNotArchived

public P readByIdAndNotArchived(@NonNull
 String id)

Description copied from interface: ChangeSummaryGroupService

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

Specified by:

readByIdAndNotArchived in interface ChangeSummaryGroupService<P extends ChangeSummaryGroup>

Parameters:

id - ID of the group to retrieve

Returns:

A ChangeSummaryGroup matching the given ID and not archived

readByIdAndNotArchived

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

Description copied from interface: ChangeSummaryGroupService

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

Specified by:

readByIdAndNotArchived in interface ChangeSummaryGroupService<P extends ChangeSummaryGroup>

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

readChangeSummaryGroupsForUser

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

Description copied from interface: ChangeSummaryGroupService

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.

Specified by:

readChangeSummaryGroupsForUser in interface ChangeSummaryGroupService<P extends ChangeSummaryGroup>

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

public org.springframework.data.domain.Page<P> readChangeSummaryGroupsForUser(@NonNull
 String state,
 @NonNull
 String sandbox,
 @NonNull
 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)

Description copied from interface: ChangeSummaryGroupService

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.

Specified by:

readChangeSummaryGroupsForUser in interface ChangeSummaryGroupService<P extends ChangeSummaryGroup>

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

readChangeSummaryGroups

public 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)

Description copied from interface: ChangeSummaryGroupService

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.

Specified by:

readChangeSummaryGroups in interface ChangeSummaryGroupService<P extends ChangeSummaryGroup>

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

public 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)

Description copied from interface: ChangeSummaryGroupService

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.

Specified by:

readChangeSummaryGroups in interface ChangeSummaryGroupService<P extends ChangeSummaryGroup>

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

readChangeSummaryGroupsBySandbox

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

Deprecated.

Description copied from interface: ChangeSummaryGroupService

Find all ChangeSummaryGroup instances matching primarily the sandbox.

Specified by:

readChangeSummaryGroupsBySandbox in interface ChangeSummaryGroupService<P extends ChangeSummaryGroup>

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

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

Description copied from interface: ChangeSummaryGroupService

Find all ChangeSummaryGroup instances matching primarily the sandbox.

Specified by:

readChangeSummaryGroupsBySandbox in interface ChangeSummaryGroupService<P extends ChangeSummaryGroup>

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

public Stream<P> readChangeSummaryGroupsByIds(@NonNull
 List<String> changeSummaryGroupIds,
 List<String> state,
 List<String> status,
 @NonNull
 String sandbox)

Description copied from interface: ChangeSummaryGroupService

Find all ChangeSummaryGroup instances matching primarily a list of ids.

Specified by:

readChangeSummaryGroupsByIds in interface ChangeSummaryGroupService<P extends ChangeSummaryGroup>

Parameters:

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

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

status - 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

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

Description copied from interface: ChangeSummaryGroupService

Find all ChangeSummaryGroup instances matching primarily a list of ids.

Specified by:

readChangeSummaryGroupsByIds in interface ChangeSummaryGroupService<P extends ChangeSummaryGroup>

Parameters:

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

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

status - 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

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

Description copied from interface: ChangeSummaryGroupService

Find all ChangeSummaryGroup instances matching primarily a list of ids.

Specified by:

readChangeSummaryGroupsByIds in interface ChangeSummaryGroupService<P extends ChangeSummaryGroup>

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

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

Description copied from interface: ChangeSummaryGroupService

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

Specified by:

readChangeSummaryGroupByIdsCount in interface ChangeSummaryGroupService<P extends ChangeSummaryGroup>

Parameters:

changeSummaryGroupIds - The group ids to check

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

status - 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

batchTransition

public boolean batchTransition(PromoteBatchFlushContext flushContext)

Description copied from interface: ChangeSummaryGroupService

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

Specified by:

batchTransition in interface ChangeSummaryGroupService<P extends ChangeSummaryGroup>

Parameters:

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

batchTransition

public boolean batchTransition(StateChangeOnlyBatchFlushContext flushContext)

Description copied from interface: ChangeSummaryGroupService

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

Specified by:

batchTransition in interface ChangeSummaryGroupService<P extends ChangeSummaryGroup>

Parameters:

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

updateVals

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

Description copied from interface: ChangeSummaryGroupService

Update the fields for a record matching the id

Specified by:

updateVals in interface ChangeSummaryGroupService<P extends ChangeSummaryGroup>

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.

archiveChangeSummaryGroupsForSandbox

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

Description copied from interface: ChangeSummaryGroupService

Archives the group of ChangeSummary for the specified sandbox id.

Specified by:

archiveChangeSummaryGroupsForSandbox in interface ChangeSummaryGroupService<P extends ChangeSummaryGroup>

Parameters:

sandboxId - the sandbox id associated to the change summary groups

removeFromAffectedVendors

public boolean removeFromAffectedVendors(@NonNull
 @NonNull String changeSummaryGroupId,
 @NonNull
 @NonNull String vendorRef)

Description copied from interface: ChangeSummaryGroupService

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

Specified by:

removeFromAffectedVendors in interface ChangeSummaryGroupService<P extends ChangeSummaryGroup>

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

getRepository

@NonNull
protected ChangeSummaryGroupRepository<?> getRepository()

Overrides:

getRepository in class com.broadleafcommerce.data.tracking.core.service.BaseMappableCrudEntityService<P extends ChangeSummaryGroup>