de.hybris.platform.cmsfacades.usergroups

Interface UserGroupFacade

All Known Implementing Classes:

DefaultUserGroupFacade

public interface UserGroupFacade

Facade for searching and getting information about available user groups.

Method Summary

Modifier and Type	Method and Description
SearchResult<UserGroupData>	findUserGroups(java.lang.String text, PageableData pageableData) Method to find user groups using a free-text form.
UserGroupData	getUserGroupById(java.lang.String uid) Get a single user group.

Method Detail

getUserGroupById

UserGroupData getUserGroupById(java.lang.String uid)
                        throws CMSItemNotFoundException

Get a single user group.

Parameters:

uid - - the identifier of the user group to retrieve

Returns:

user group

Throws:

CMSItemNotFoundException - when the user group could not be found

findUserGroups

SearchResult<UserGroupData> findUserGroups(java.lang.String text,
                                           PageableData pageableData)

Method to find user groups using a free-text form. It also supports pagination.

Parameters:

text - The free-text string to be used on the product search

pageableData - the pagination object

Returns:

the search result object.