de.hybris.platform.b2b.services

Interface B2BApproverService<T>

Type Parameters:

T - the principal (customer)

All Known Implementing Classes:

DefaultB2BApproverService

public interface B2BApproverService<T>

The Interface B2BApproverService. Service is responsible for fetching approvers related to a B2BCustomer.

Spring Bean ID:

b2bApproverService

Method Summary

Modifier and Type	Method and Description
B2BCustomerModel	addApproverToCustomer(java.lang.String user, java.lang.String approver) Add an approver for a given user and return the updated B2BCustomerModel object updated with approver details
B2BCustomerModel	addApproverToUnit(java.lang.String unitId, java.lang.String approverId) Add approver to given unit
SearchPageData<B2BCustomerModel>	findPagedApproversForUnitByGroupMembership(PageableData pageableData, java.lang.String unitUid, java.lang.String... userGroupUid) Gets list of SearchPageData B2BCustomerModel provided with required pagination parameters with PageableData
java.util.List<UserModel>	getAccountManagerApprovers(PrincipalModel principal) Gets the list of account manager approvers.
java.util.List<T>	getAllActiveApprovers(B2BCustomerModel principal) Gets all the active approvers for a given customer
java.util.List<T>	getAllApprovers(T principal) Gets the approvers assigned to principal(customer) directly or as approver groups including its parent unit and all the units assigned to its parent up to the root unit.
boolean	isMemberOf(PrincipalGroupModel principal, java.lang.String userGroupUid) Deprecated. Since 4.4. User DefaultUserService.isMemberOfGroup(de.hybris.platform.core.model.user.UserGroupModel, de.hybris.platform.core.model.user.UserGroupModel)
B2BCustomerModel	removeApproverFromCustomer(java.lang.String user, java.lang.String approver) Remove an approver for a given user and return the updated B2BCustomerModel object updated with approver details
B2BCustomerModel	removeApproverFromUnit(java.lang.String unitUid, java.lang.String approverUid) If an approver is a member of the B2BUnit remove b2bapprovergroup role, if the approver is a member of the current branch of units the approver will be removed from B2BUnitModel.getApprovers() relationship

Method Detail

getAllApprovers

java.util.List<T> getAllApprovers(T principal)

Gets the approvers assigned to principal(customer) directly or as approver groups including its parent unit and all the units assigned to its parent up to the root unit.

Parameters:

principal - the principal (customer)

Returns:

A collection of approvers

isMemberOf

@Deprecated
boolean isMemberOf(PrincipalGroupModel principal,
                               java.lang.String userGroupUid)

Deprecated. Since 4.4. User DefaultUserService.isMemberOfGroup(de.hybris.platform.core.model.user.UserGroupModel, de.hybris.platform.core.model.user.UserGroupModel)

Checks if the principal is a member of the user group.

Parameters:

principal - the principal

userGroupUid - the uid of the user group to check if the principal is a memeber of.

Returns:

true, if is member of

getAccountManagerApprovers

java.util.List<UserModel> getAccountManagerApprovers(PrincipalModel principal)

Gets the list of account manager approvers.

Parameters:

principal - the principal

Returns:

the approvers

getAllActiveApprovers

java.util.List<T> getAllActiveApprovers(B2BCustomerModel principal)

Gets all the active approvers for a given customer

Parameters:

principal -

Returns:

list of approvers

addApproverToCustomer

B2BCustomerModel addApproverToCustomer(java.lang.String user,
                                       java.lang.String approver)

Add an approver for a given user and return the updated B2BCustomerModel object updated with approver details

Parameters:

user - A unique identifier for B2BCustomerModel representing a user

approver - A unique identifier for B2BCustomerModel representing a approver

Returns:

Updated B2BCustomerModel object updated with approvers

Throws:

{@link - IllegalArgumentException} if the approver is not in the approver group

removeApproverFromCustomer

B2BCustomerModel removeApproverFromCustomer(java.lang.String user,
                                            java.lang.String approver)

Remove an approver for a given user and return the updated B2BCustomerModel object updated with approver details

Parameters:

user - A unique identifier for B2BCustomerModel representing a user

approver - A unique identifier for B2BCustomerModel representing a approver

Returns:

Updated B2BCustomerModel object removed with approver

addApproverToUnit

B2BCustomerModel addApproverToUnit(java.lang.String unitId,
                                   java.lang.String approverId)

Add approver to given unit

Parameters:

unitId - A unique identifier for B2BUnitModel

approverId - A unique identifier for B2BCustomerModel who is a approver

Returns:

Updated B2BCustomerModel object after adding approver to customer.

removeApproverFromUnit

B2BCustomerModel removeApproverFromUnit(java.lang.String unitUid,
                                        java.lang.String approverUid)

If an approver is a member of the B2BUnit remove b2bapprovergroup role, if the approver is a member of the current branch of units the approver will be removed from B2BUnitModel.getApprovers() relationship

Parameters:

unitUid - A unique identifier of B2BUnitModel

approverUid - A unique identifier of B2BCustomerModel

Returns:

An approver who was removed from a B2BUnitModel.getApprovers()

findPagedApproversForUnitByGroupMembership

SearchPageData<B2BCustomerModel> findPagedApproversForUnitByGroupMembership(PageableData pageableData,
                                                                            java.lang.String unitUid,
                                                                            java.lang.String... userGroupUid)

Gets list of SearchPageData B2BCustomerModel provided with required pagination parameters with PageableData

Parameters:

pageableData - Pagination information

unitUid - A unique identifier of B2BUnitModel

userGroupUid - A unique identifier of B2BUserGroupModel

Returns:

Collection of paginated B2BCostCenterModel objects