Interface AccountService<P extends Account>
-
- All Superinterfaces:
com.broadleafcommerce.data.tracking.core.service.CrudEntityService<P>
,com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<P>
- All Known Implementing Classes:
DefaultAccountService
public interface AccountService<P extends Account> extends com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<P>
Service API forAccounts
. Supported byAccountRepository
.- Author:
- Chris Kittrell (ckittrell)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description List<P>
readAllByIdWithChildren(@NonNull Collection<String> ids, int childAccountDepth, boolean filterParents, cz.jirutka.rsql.parser.ast.Node filters, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
Reads all of theAccounts
byids
and optionally include child accounts.-
Methods inherited from interface com.broadleafcommerce.data.tracking.core.service.CrudEntityService
create, createAll, createAllAllowingPartialSuccess, delete, readAll, readAll, readAll, readAllByContextId, readByContextId, replace, replaceAll, replaceAllAllowingPartialSuccess, update, updateAll, updateAllAllowingPartialSuccess, updateSort
-
-
-
-
Method Detail
-
readAllByIdWithChildren
List<P> readAllByIdWithChildren(@NonNull @NonNull Collection<String> ids, int childAccountDepth, boolean filterParents, @Nullable cz.jirutka.rsql.parser.ast.Node filters, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
Reads all of theAccounts
byids
and optionally include child accounts. SetexcludeAccountsWithInactiveParent
totrue
to filter out accounts that have a disabled parent account.- Parameters:
ids
- The Ids of the accounts to matchchildAccountDepth
- How many levels deep of the account hierarchy of the accounts matchingids
to include in the results, e.g., how many levels of child accounts to include.-1
indicates no limit.0
indicates no child accounts.Default is
0
.filterParents
- If true, the returned list will include only accounts with active parent accounts.filters
- An RSQL filter used to narrow query results. May beEmptyNode
if no filters should be applied.contextInfo
- Additional multitenant and sandbox info- Returns:
- All of the
Accounts
byids
and optionally child accounts.
-
-