Package de.hybris.platform.b2b.company

Interface B2BCommerceB2BUserGroupService

All Known Subinterfaces:

B2BCommerceB2BUserGroupService

All Known Implementing Classes:

DefaultB2BCommerceB2BUserGroupService, DefaultB2BCommerceB2BUserGroupService

public interface B2BCommerceB2BUserGroupService

A service for user group management within b2b commerce

Method Summary

Modifier and Type	Method	Description
B2BCustomerModel	addMemberToUserGroup(java.lang.String userGroup, java.lang.String user)	Gets updated customer, after adding customer to given user group
void	disableUserGroup(java.lang.String uid)	Disable a user group given its uid
SearchPageData<B2BUserGroupModel>	getPagedB2BUserGroups(PageableData pageableData)	Gets list of SearchPageData for pagination given the required pagination parameters with PageableData
<T extends UserGroupModel> T	getUserGroupForUID(java.lang.String uid, java.lang.Class<T> userGroupType)	Gets a user group for given uid and user group type
B2BCustomerModel	removeMemberFromUserGroup(java.lang.String userGroup, java.lang.String user)	Gets updated customer, after removing customer from a given user group
void	removeUserGroup(java.lang.String uid)	Remove user group given its uid
java.util.Set<PrincipalGroupModel>	updateUserGroups(java.util.Collection<java.lang.String> userGroups, java.util.Collection<java.lang.String> roles, B2BCustomerModel customerModel)	Gets updated collection of user groups

Method Detail

getPagedB2BUserGroups

SearchPageData<B2BUserGroupModel> getPagedB2BUserGroups(PageableData pageableData)

Gets list of SearchPageData for pagination given the required pagination parameters with PageableData

Parameters:

pageableData - Pagination information

Returns:

List of paginated B2BUserGroupModel objects

updateUserGroups

java.util.Set<PrincipalGroupModel> updateUserGroups(java.util.Collection<java.lang.String> userGroups,
                                                    java.util.Collection<java.lang.String> roles,
                                                    B2BCustomerModel customerModel)

Gets updated collection of user groups

Parameters:

userGroups - Collection of user groups that has to be updated customer

roles - Collection of roles

customerModel - Customer object for which the user group has to be updated

Returns:

Updated PrincipalGroupModel object with given user groups.

getUserGroupForUID

<T extends UserGroupModel> T getUserGroupForUID(java.lang.String uid,
                                                java.lang.Class<T> userGroupType)

Gets a user group for given uid and user group type

Parameters:

uid - A unique identifier for B2BUserGroupModel

userGroupType - User group type

Returns:

Usergroup object based on the given uid and user group type

disableUserGroup

void disableUserGroup(java.lang.String uid)

Disable a user group given its uid

Parameters:

uid - A unique identifier for B2BUserGroupModel

removeUserGroup

void removeUserGroup(java.lang.String uid)

Remove user group given its uid

Parameters:

uid - A unique identifier for B2BUserGroupModel

addMemberToUserGroup

B2BCustomerModel addMemberToUserGroup(java.lang.String userGroup,
                                      java.lang.String user)

Gets updated customer, after adding customer to given user group

Parameters:

userGroup - A unique identifier for B2BUserGroupModel

user - A unique identifier for B2BCustomerModel

Returns:

Updated B2BCustomerModel object

removeMemberFromUserGroup

B2BCustomerModel removeMemberFromUserGroup(java.lang.String userGroup,
                                           java.lang.String user)

Gets updated customer, after removing customer from a given user group

Parameters:

userGroup - A unique identifier for B2BUserGroupModel

user - A unique identifier for B2BCustomerModel

Returns:

Updated B2BCustomerModel object