Class BaseMappableCrudEntityService<P>
- Type Parameters:
P
- The business domain type
- All Implemented Interfaces:
MappableCrudEntityService<P>
- Direct Known Subclasses:
BaseRsqlMappableCrudEntityService
MappableCrudEntityService
can extend from this
class as a convenience to inherit CRUD behavior for a particular business domain type. By
default, this class in turn defers to MappableCrudEntityHelper
in order to allow easier
refactoring of core functionality.
If a service implementation spans several repository types, then it is recommended to inject the
MappableCrudEntityHelper
rather than extend this class.
- Author:
- Nathan Moore (nathandmoore)
-
Constructor Summary
ConstructorDescriptionBaseMappableCrudEntityService
(R repository, MappableCrudEntityHelper helper) -
Method Summary
Modifier and TypeMethodDescriptionprotected P
convertFromPersistentDomain
(Object domain) <D,
R extends org.springframework.data.repository.CrudRepository<D, String> & com.broadleafcommerce.common.extension.DomainTypeAware>
PCreate an instance of an entity based on a business instance containing relevant property values.<D,
R extends org.springframework.data.repository.CrudRepository<D, String> & com.broadleafcommerce.common.extension.DomainTypeAware>
List<P>Create multiple instances of an entity at once based on the business instances containing relevant property values.<D,
R extends org.springframework.data.repository.CrudRepository<D, String> & com.broadleafcommerce.common.extension.DomainTypeAware>
BulkPersistenceResponse<P>createAllAllowingPartialSuccess
(List<P> businessInstances) Creates multiple instances of an entity at once based on the business instances containing relevant property values.void
Perform a delete operation on the entity identified by the id.protected MappableCrudEntityHelper
protected com.broadleafcommerce.common.extension.data.PagingAndSortingRepository<?,
String> readAll()
Read a list of instances in the form of the business instance.org.springframework.data.domain.Page<P>
readAll
(org.springframework.data.domain.Pageable pageable) Read a page of entity instances in the form of business instances.readAll
(org.springframework.data.domain.Sort sort) Read a list of instances in the form of the business instance.readAllByIds
(Iterable<String> ids) Reads all entity instances matching the provided ids.Read a single instance of an entity in the form of a business domain.Replace a single instance of an entity based on a business instance containing relavant property values.replaceAll
(List<Update<P>> replacements) Replace multiple instances of an entity at once based on the business instance containing relevant property values.replaceAllAllowingPartialSuccess
(List<Update<P>> replacements) Replace multiple instances of an entity at once based on the business instances containing relevant property values.Update a single instance of an entity based on a business instance containing relevant property values.A bulk operation that updates all of the items managed by the backing repository in the form of the business entity containing property values.updateAllAllowingPartialSuccess
(List<Update<P>> updates) Updates all of the items managed by the backing repository in the form of the business instances containing property values.
-
Constructor Details
-
BaseMappableCrudEntityService
-
-
Method Details
-
readById
Description copied from interface:MappableCrudEntityService
Read a single instance of an entity in the form of a business domain.- Specified by:
readById
in interfaceMappableCrudEntityService<P>
- Parameters:
id
- The id for the entity.- Returns:
- The entity instance in the form of a business instance
-
readAllByIds
Description copied from interface:MappableCrudEntityService
Reads all entity instances matching the provided ids.- Specified by:
readAllByIds
in interfaceMappableCrudEntityService<P>
- Parameters:
ids
-Iterable
of ids to read- Returns:
List
of matching instances
-
readAll
Description copied from interface:MappableCrudEntityService
Read a list of instances in the form of the business instance.- Specified by:
readAll
in interfaceMappableCrudEntityService<P>
- Returns:
- The list of data in the form of business instances
-
readAll
public org.springframework.data.domain.Page<P> readAll(@NonNull org.springframework.data.domain.Pageable pageable) Description copied from interface:MappableCrudEntityService
Read a page of entity instances in the form of business instances.- Specified by:
readAll
in interfaceMappableCrudEntityService<P>
- Parameters:
pageable
- information about which page of results to return. May bePageable.unpaged()
, may not benull
.- Returns:
- the requested page of entity instances in the form of business instances
-
readAll
Description copied from interface:MappableCrudEntityService
Read a list of instances in the form of the business instance. Also apply the given sort.- Specified by:
readAll
in interfaceMappableCrudEntityService<P>
- Parameters:
sort
- The sort to be performed on the results- Returns:
- The list of sorted data in the form of business instances
-
update
Description copied from interface:MappableCrudEntityService
Update a single instance of an entity based on a business instance containing relevant property values.- Specified by:
update
in interfaceMappableCrudEntityService<P>
- Parameters:
id
- The id for the entity.businessInstance
- The payload type that domain class should be converted to. In general, the payload is what the rest API responds with.- Returns:
- The updated entity instance in the form of a payload instance, or
EntityMissingException
if not available. - See Also:
-
updateAll
Description copied from interface:MappableCrudEntityService
A bulk operation that updates all of the items managed by the backing repository in the form of the business entity containing property values.All items contained within
updates
must exist in the backing repository and pass validation, else the entire batch will failFor an alternative that allows partial success, see
MappableCrudEntityService.updateAllAllowingPartialSuccess(List)
.- Specified by:
updateAll
in interfaceMappableCrudEntityService<P>
- Parameters:
updates
- each update to the repository domain- Returns:
- all of the updated entity instance in the form of a payload instance, or
EntityMissingException
if not available. - See Also:
-
updateAllAllowingPartialSuccess
Description copied from interface:MappableCrudEntityService
Updates all of the items managed by the backing repository in the form of the business instances containing property values.Each item contained within
updates
must exist in the backing repository and pass validation, or it will be added to the failed list in the response and not persisted. All successfully found and validated items will be persisted.For an alternative that does not allow partial success, see
MappableCrudEntityService.updateAll(List)
.- Specified by:
updateAllAllowingPartialSuccess
in interfaceMappableCrudEntityService<P>
- Parameters:
updates
- each update to the repository domain- Returns:
- a response containing a list of any entities which failed, and a list of the successfully updated entity instances in the form of a payload instance
- See Also:
-
replace
Description copied from interface:MappableCrudEntityService
Replace a single instance of an entity based on a business instance containing relavant property values.- Specified by:
replace
in interfaceMappableCrudEntityService<P>
- Parameters:
id
- The id for the entity.businessInstance
- The payload type that domain class should be converted to. In general, the payload is what the rest API responds with.- Returns:
- The replaced entity instance in the form of a payload instance, or
EntityMissingException
if not available. - See Also:
-
replaceAll
Description copied from interface:MappableCrudEntityService
Replace multiple instances of an entity at once based on the business instance containing relevant property values.All items contained within
replacements
must exist in the backing repository and pass validation, else the entire batch will failSee
MappableCrudEntityService.replaceAllAllowingPartialSuccess(List)
for an alternative that allows partial success.- Specified by:
replaceAll
in interfaceMappableCrudEntityService<P>
- Parameters:
replacements
- all replacements to the repository domain- Returns:
- all of the replaced entity instances in the form of a payload instance, or
EntityMissingException
if any of the items were not found - See Also:
-
replaceAllAllowingPartialSuccess
Description copied from interface:MappableCrudEntityService
Replace multiple instances of an entity at once based on the business instances containing relevant property values.Each item contained within
replacements
must exist in the backing repository and pass validation, or it will be added to the failed list in the response and not persisted. All successfully found and validated items will be persisted.See
MappableCrudEntityService.replaceAll(List)
for an alternative that does not allow partial success.- Specified by:
replaceAllAllowingPartialSuccess
in interfaceMappableCrudEntityService<P>
- Parameters:
replacements
- all replacements to the repository domain- Returns:
- a response containing a list of any entities which failed, and a list of the successfully replaced entity instances in the form of a payload instance
- See Also:
-
create
public <D,R extends org.springframework.data.repository.CrudRepository<D, P createString> & com.broadleafcommerce.common.extension.DomainTypeAware> (@NonNull P businessInstance) Description copied from interface:MappableCrudEntityService
Create an instance of an entity based on a business instance containing relevant property values. In this case, the implementation should be aware of the back repository entity type. This is generally discovered via repository implementations that use theDomainTypeAware
interface.- Specified by:
create
in interfaceMappableCrudEntityService<P>
- Parameters:
businessInstance
- The business domain instance. In general, theDomainMapperManager
is responsible for converting to a repository platform type for persistence.- Returns:
- The new entity instance in the form of a business type instance.
- See Also:
-
createAll
public <D,R extends org.springframework.data.repository.CrudRepository<D, List<P> createAllString> & com.broadleafcommerce.common.extension.DomainTypeAware> (List<P> businessInstances) Description copied from interface:MappableCrudEntityService
Create multiple instances of an entity at once based on the business instances containing relevant property values.All items contained within
businessInstances
must pass validation, else the entire batch will fail.See
MappableCrudEntityService.createAllAllowingPartialSuccess(List)
for an alternative where partial success is allowed.- Specified by:
createAll
in interfaceMappableCrudEntityService<P>
- Parameters:
businessInstances
- all instances to create in the data store- Returns:
- all of the created entity instances in the form of a payload instance
- See Also:
-
createAllAllowingPartialSuccess
public <D,R extends org.springframework.data.repository.CrudRepository<D, BulkPersistenceResponse<P> createAllAllowingPartialSuccessString> & com.broadleafcommerce.common.extension.DomainTypeAware> (List<P> businessInstances) Description copied from interface:MappableCrudEntityService
Creates multiple instances of an entity at once based on the business instances containing relevant property values.Each item contained within
businessInstances
will be validated, and if it fails validation, it will be added to the failed list in the response and not persisted. All successfully validated items will be persisted.See
MappableCrudEntityService.createAll(List)
for an alternative that does not allow partial success.- Specified by:
createAllAllowingPartialSuccess
in interfaceMappableCrudEntityService<P>
- Parameters:
businessInstances
- all instances to create in the data store- Returns:
- a response containing a list of any entities which failed, and a list of the successfully created entity instances in the form of a payload instance
- See Also:
-
delete
Description copied from interface:MappableCrudEntityService
Perform a delete operation on the entity identified by the id.- Specified by:
delete
in interfaceMappableCrudEntityService<P>
- Parameters:
id
- The id for the entity.
-
convertFromPersistentDomain
-
getRepository
@NonNull protected com.broadleafcommerce.common.extension.data.PagingAndSortingRepository<?,String> getRepository() -
getHelper
-