Package de.hybris.platform.b2bcommercefacades.company

Interface B2BUserGroupFacade

All Known Subinterfaces:

B2BCommerceB2BUserGroupFacade

All Known Implementing Classes:

DefaultB2BCommerceB2BUserGroupFacade, DefaultB2BUserGroupFacade

public interface B2BUserGroupFacade

A facade for handling user groups within b2b Commerce.

Since:

6.0

Method Summary

Modifier and Type	Method	Description
CustomerData	addMemberToUserGroup(java.lang.String userGroupUid, java.lang.String userUid)	Add the user with the given uid as a member of the user group.
void	disableUserGroup(java.lang.String userGroupUid)	Disabled a user group by removing all members from it.
B2BUserGroupData	getB2BUserGroup(java.lang.String userGroupUid)	Get the User Group Data with the uid
SearchPageData<B2BUserGroupData>	getPagedB2BUserGroups(PageableData pageableData)	Get a paginated lists of B2B user groups.
SearchPageData<CustomerData>	getPagedCustomersForUserGroup(PageableData pageableData, java.lang.String userGroupUid)	Get paginated list of customers who are members of the given B2B user group.
SearchPageData<CustomerData>	getPagedUserData(PageableData pageableData)	Get a paginated list of B2B users.
UserGroupData	getUserGroupDataForUid(java.lang.String userGroupUid)	Get the user group data for the given uid.
java.util.List<java.lang.String>	getUserGroups()	A list of user group codes (roles) a b2b customer can be assigned to.
CustomerData	removeMemberFromUserGroup(java.lang.String userGroupUid, java.lang.String userUid)	Remove the member with the given uid from the user group.
void	removeUserGroup(java.lang.String userGroupUid)	Remove the user group with the given uid.
void	updateUserGroup(java.lang.String userGroupUid, B2BUserGroupData userGroupData)	Updates B2B user group based on passed in data object.

Method Detail

getPagedCustomersForUserGroup

SearchPageData<CustomerData> getPagedCustomersForUserGroup(PageableData pageableData,
                                                           java.lang.String userGroupUid)

Get paginated list of customers who are members of the given B2B user group.

Parameters:

pageableData - pagination information for the request

userGroupUid - the uid of the user group

Returns:

a paginated list of CustomerData

updateUserGroup

void updateUserGroup(java.lang.String userGroupUid,
                     B2BUserGroupData userGroupData)

Updates B2B user group based on passed in data object. If no user group exists for the given uid a new user group is created.

Parameters:

userGroupUid - the uid of the user group to be updated

userGroupData - B2BUserGroupData containing the update information

disableUserGroup

void disableUserGroup(java.lang.String userGroupUid)

Disabled a user group by removing all members from it.

Parameters:

userGroupUid - the uid of the user group

removeUserGroup

void removeUserGroup(java.lang.String userGroupUid)

Remove the user group with the given uid.

Parameters:

userGroupUid - the uid of the user group

getPagedUserData

SearchPageData<CustomerData> getPagedUserData(PageableData pageableData)

Get a paginated list of B2B users.

Parameters:

pageableData - pagination information for the request

Returns:

a paginated list of CustomerData

getPagedB2BUserGroups

SearchPageData<B2BUserGroupData> getPagedB2BUserGroups(PageableData pageableData)

Get a paginated lists of B2B user groups.

Parameters:

pageableData - pagination information for the request

Returns:

a paginated list of B2BUserGroupData

getB2BUserGroup

B2BUserGroupData getB2BUserGroup(java.lang.String userGroupUid)

Get the User Group Data with the uid

Parameters:

userGroupUid - the uid of the user group

Returns:

B2BUserGroupData

addMemberToUserGroup

CustomerData addMemberToUserGroup(java.lang.String userGroupUid,
                                  java.lang.String userUid)

Add the user with the given uid as a member of the user group.

Parameters:

userGroupUid - the uid of the user group

userUid - the uid of the user

Returns:

CustomerData

removeMemberFromUserGroup

CustomerData removeMemberFromUserGroup(java.lang.String userGroupUid,
                                       java.lang.String userUid)

Remove the member with the given uid from the user group.

Parameters:

userGroupUid - the uid of the user group

userUid - the uid of the member

Returns:

CustomerData

getUserGroupDataForUid

UserGroupData getUserGroupDataForUid(java.lang.String userGroupUid)

Get the user group data for the given uid.

Parameters:

userGroupUid - the uid of the user group

Returns:

UserGroupData

getUserGroups

java.util.List<java.lang.String> getUserGroups()

A list of user group codes (roles) a b2b customer can be assigned to.

Returns:

a list of PrincipalModel.UID a b2b customer can be assigned to