UserGroupLocalServiceUtil (Liferay 7.2.10 portal-kernel API)

Object
- com.liferay.portal.kernel.service.UserGroupLocalServiceUtil

```
public class UserGroupLocalServiceUtil
extends Object
```
Provides the local service utility for UserGroup. This utility wraps com.liferay.portal.service.impl.UserGroupLocalServiceImpl and is an access point for service operations in application layer code running on the local server. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

Author:

Brian Wing Shun Chan

See Also:

UserGroupLocalService

{$generated.description}

Constructor Summary

Constructors
Constructor and Description

UserGroupLocalServiceUtil()

Constructors
Constructor and Description
`UserGroupLocalServiceUtil()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`addGroupUserGroup(long groupId, long userGroupId)` NOTE FOR DEVELOPERS: Never modify or reference this interface directly.
`static void`	`addGroupUserGroup(long groupId, UserGroup userGroup)`
`static void`	`addGroupUserGroups(long groupId, List<UserGroup> userGroups)`
`static void`	`addGroupUserGroups(long groupId, long[] userGroupIds)`
`static void`	`addTeamUserGroup(long teamId, long userGroupId)`
`static void`	`addTeamUserGroup(long teamId, UserGroup userGroup)`
`static void`	`addTeamUserGroups(long teamId, List<UserGroup> userGroups)`
`static void`	`addTeamUserGroups(long teamId, long[] userGroupIds)`
`static UserGroup`	`addUserGroup(long userId, long companyId, String name, String description, ServiceContext serviceContext)` Adds a user group.
`static UserGroup`	`addUserGroup(UserGroup userGroup)` Adds the user group to the database.
`static void`	`addUserUserGroup(long userId, long userGroupId)`
`static void`	`addUserUserGroup(long userId, UserGroup userGroup)`
`static void`	`addUserUserGroups(long userId, List<UserGroup> userGroups)`
`static void`	`addUserUserGroups(long userId, long[] userGroupIds)`
`static void`	`clearGroupUserGroups(long groupId)`
`static void`	`clearTeamUserGroups(long teamId)`
`static void`	`clearUserUserGroups(long userId)`
`static void`	`copyUserGroupLayouts(long[] userGroupIds, long userId)` Deprecated. As of Newton (6.2.x)
`static void`	`copyUserGroupLayouts(long userGroupId, long userId)` Deprecated. As of Paton (6.1.x)
`static void`	`copyUserGroupLayouts(long userGroupId, long[] userIds)` Deprecated. As of Newton (6.2.x)
`static UserGroup`	`createUserGroup(long userGroupId)` Creates a new user group with the primary key.
`static void`	`deleteGroupUserGroup(long groupId, long userGroupId)`
`static void`	`deleteGroupUserGroup(long groupId, UserGroup userGroup)`
`static void`	`deleteGroupUserGroups(long groupId, List<UserGroup> userGroups)`
`static void`	`deleteGroupUserGroups(long groupId, long[] userGroupIds)`
`static PersistedModel`	`deletePersistedModel(PersistedModel persistedModel)`
`static void`	`deleteTeamUserGroup(long teamId, long userGroupId)`
`static void`	`deleteTeamUserGroup(long teamId, UserGroup userGroup)`
`static void`	`deleteTeamUserGroups(long teamId, List<UserGroup> userGroups)`
`static void`	`deleteTeamUserGroups(long teamId, long[] userGroupIds)`
`static UserGroup`	`deleteUserGroup(long userGroupId)` Deletes the user group with the primary key from the database.
`static UserGroup`	`deleteUserGroup(UserGroup userGroup)` Deletes the user group from the database.
`static void`	`deleteUserGroups(long companyId)`
`static void`	`deleteUserUserGroup(long userId, long userGroupId)`
`static void`	`deleteUserUserGroup(long userId, UserGroup userGroup)`
`static void`	`deleteUserUserGroups(long userId, List<UserGroup> userGroups)`
`static void`	`deleteUserUserGroups(long userId, long[] userGroupIds)`
`static DynamicQuery`	`dynamicQuery()`
`static <T> List<T>`	`dynamicQuery(DynamicQuery dynamicQuery)` Performs a dynamic query on the database and returns the matching rows.
`static <T> List<T>`	`dynamicQuery(DynamicQuery dynamicQuery, int start, int end)` Performs a dynamic query on the database and returns a range of the matching rows.
`static <T> List<T>`	`dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)` Performs a dynamic query on the database and returns an ordered range of the matching rows.
`static long`	`dynamicQueryCount(DynamicQuery dynamicQuery)` Returns the number of rows matching the dynamic query.
`static long`	`dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)` Returns the number of rows matching the dynamic query.
`static UserGroup`	`fetchUserGroup(long userGroupId)`
`static UserGroup`	`fetchUserGroup(long companyId, String name)`
`static UserGroup`	`fetchUserGroupByReferenceCode(long companyId, String externalReferenceCode)` Returns the user group with the matching external reference code and company.
`static UserGroup`	`fetchUserGroupByUuidAndCompanyId(String uuid, long companyId)` Returns the user group with the matching UUID and company.
`static ActionableDynamicQuery`	`getActionableDynamicQuery()`
`static ExportActionableDynamicQuery`	`getExportActionableDynamicQuery(PortletDataContext portletDataContext)`
`static long[]`	`getGroupPrimaryKeys(long userGroupId)` Returns the groupIds of the groups associated with the user group.
`static List<UserGroup>`	`getGroupUserGroups(long groupId)`
`static List<UserGroup>`	`getGroupUserGroups(long groupId, int start, int end)`
`static List<UserGroup>`	`getGroupUserGroups(long groupId, int start, int end, OrderByComparator<UserGroup> orderByComparator)`
`static int`	`getGroupUserGroupsCount(long groupId)`
`static List<UserGroup>`	`getGroupUserUserGroups(long groupId, long userId)`
`static IndexableActionableDynamicQuery`	`getIndexableActionableDynamicQuery()`
`static String`	`getOSGiServiceIdentifier()` Returns the OSGi service identifier.
`static PersistedModel`	`getPersistedModel(Serializable primaryKeyObj)`
`static UserGroupLocalService`	`getService()`
`static long[]`	`getTeamPrimaryKeys(long userGroupId)` Returns the teamIds of the teams associated with the user group.
`static List<UserGroup>`	`getTeamUserGroups(long teamId)`
`static List<UserGroup>`	`getTeamUserGroups(long teamId, int start, int end)`
`static List<UserGroup>`	`getTeamUserGroups(long teamId, int start, int end, OrderByComparator<UserGroup> orderByComparator)`
`static int`	`getTeamUserGroupsCount(long teamId)`
`static UserGroup`	`getUserGroup(long userGroupId)` Returns the user group with the primary key.
`static UserGroup`	`getUserGroup(long companyId, String name)` Returns the user group with the name.
`static UserGroup`	`getUserGroupByUuidAndCompanyId(String uuid, long companyId)` Returns the user group with the matching UUID and company.
`static List<UserGroup>`	`getUserGroups(int start, int end)` Returns a range of all the user groups.
`static List<UserGroup>`	`getUserGroups(long companyId)` Returns all the user groups belonging to the company.
`static List<UserGroup>`	`getUserGroups(long[] userGroupIds)` Returns all the user groups with the primary keys.
`static List<UserGroup>`	`getUserGroups(long companyId, String name, int start, int end)`
`static int`	`getUserGroupsCount()` Returns the number of user groups.
`static int`	`getUserGroupsCount(long companyId, String name)`
`static long[]`	`getUserPrimaryKeys(long userGroupId)` Returns the userIds of the users associated with the user group.
`static List<UserGroup>`	`getUserUserGroups(long userId)`
`static List<UserGroup>`	`getUserUserGroups(long userId, int start, int end)`
`static List<UserGroup>`	`getUserUserGroups(long userId, int start, int end, OrderByComparator<UserGroup> orderByComparator)`
`static int`	`getUserUserGroupsCount(long userId)`
`static boolean`	`hasGroupUserGroup(long groupId, long userGroupId)`
`static boolean`	`hasGroupUserGroups(long groupId)`
`static boolean`	`hasTeamUserGroup(long teamId, long userGroupId)`
`static boolean`	`hasTeamUserGroups(long teamId)`
`static boolean`	`hasUserUserGroup(long userId, long userGroupId)`
`static boolean`	`hasUserUserGroups(long userId)`
`static List<UserGroup>`	`search(long companyId, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<UserGroup> obc)` Returns an ordered range of all the user groups that match the keywords.
`static Hits`	`search(long companyId, String keywords, LinkedHashMap<String,Object> params, int start, int end, Sort sort)` Returns an ordered range of all the user groups that match the keywords, using the indexer.
`static List<UserGroup>`	`search(long companyId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, OrderByComparator<UserGroup> obc)` Returns an ordered range of all the user groups that match the name and description.
`static Hits`	`search(long companyId, String name, String description, LinkedHashMap<String,Object> params, boolean andSearch, int start, int end, Sort sort)` Returns an ordered range of all the user groups that match the name and description.
`static int`	`searchCount(long companyId, String keywords, LinkedHashMap<String,Object> params)` Returns the number of user groups that match the keywords
`static int`	`searchCount(long companyId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator)` Returns the number of user groups that match the name and description.
`static BaseModelSearchResult<UserGroup>`	`searchUserGroups(long companyId, String keywords, LinkedHashMap<String,Object> params, int start, int end, Sort sort)`
`static BaseModelSearchResult<UserGroup>`	`searchUserGroups(long companyId, String name, String description, LinkedHashMap<String,Object> params, boolean andSearch, int start, int end, Sort sort)`
`static void`	`setGroupUserGroups(long groupId, long[] userGroupIds)`
`static void`	`setTeamUserGroups(long teamId, long[] userGroupIds)`
`static void`	`setUserUserGroups(long userId, long[] userGroupIds)`
`static void`	`unsetGroupUserGroups(long groupId, long[] userGroupIds)` Removes the user groups from the group.
`static void`	`unsetTeamUserGroups(long teamId, long[] userGroupIds)` Removes the user groups from the team.
`static UserGroup`	`updateUserGroup(long companyId, long userGroupId, String name, String description, ServiceContext serviceContext)` Updates the user group.
`static UserGroup`	`updateUserGroup(UserGroup userGroup)` Updates the user group in the database or adds it if it does not yet exist.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - UserGroupLocalServiceUtil
```
public UserGroupLocalServiceUtil()
```
- Method Detail
  - addGroupUserGroup
```
public static void addGroupUserGroup(long groupId,
                                     long userGroupId)
```
    NOTE FOR DEVELOPERS: Never modify or reference this interface directly. Always use UserGroupLocalServiceUtil to access the user group local service. Add custom service methods to com.liferay.portal.service.impl.UserGroupLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.
  - addGroupUserGroup
```
public static void addGroupUserGroup(long groupId,
                                     UserGroup userGroup)
```
  - addGroupUserGroups
```
public static void addGroupUserGroups(long groupId,
                                      List<UserGroup> userGroups)
```
  - addGroupUserGroups
```
public static void addGroupUserGroups(long groupId,
                                      long[] userGroupIds)
```
  - addTeamUserGroup
```
public static void addTeamUserGroup(long teamId,
                                    long userGroupId)
```
  - addTeamUserGroup
```
public static void addTeamUserGroup(long teamId,
                                    UserGroup userGroup)
```
  - addTeamUserGroups
```
public static void addTeamUserGroups(long teamId,
                                     List<UserGroup> userGroups)
```
  - addTeamUserGroups
```
public static void addTeamUserGroups(long teamId,
                                     long[] userGroupIds)
```
  - addUserGroup
```
public static UserGroup addUserGroup(long userId,
                                     long companyId,
                                     String name,
                                     String description,
                                     ServiceContext serviceContext)
                              throws PortalException
```
    Adds a user group.
    This method handles the creation and bookkeeping of the user group, including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to setup default groups and resources for the user group.
    
    Parameters:
    
    userId - the primary key of the user
    
    companyId - the primary key of the user group's company
    
    name - the user group's name
    
    description - the user group's description
    
    serviceContext - the service context to be applied (optionally null). Can set expando bridge attributes for the user group.
    
    Returns:
    
    the user group
    
    Throws:
    
    PortalException
  - addUserGroup
```
public static UserGroup addUserGroup(UserGroup userGroup)
```
    Adds the user group to the database. Also notifies the appropriate model listeners.
    
    Parameters:
    
    userGroup - the user group
    
    Returns:
    
    the user group that was added
  - addUserUserGroup
```
public static void addUserUserGroup(long userId,
                                    long userGroupId)
```
  - addUserUserGroup
```
public static void addUserUserGroup(long userId,
                                    UserGroup userGroup)
```
  - addUserUserGroups
```
public static void addUserUserGroups(long userId,
                                     List<UserGroup> userGroups)
```
  - addUserUserGroups
```
public static void addUserUserGroups(long userId,
                                     long[] userGroupIds)
```
  - clearGroupUserGroups
```
public static void clearGroupUserGroups(long groupId)
```
  - clearTeamUserGroups
```
public static void clearTeamUserGroups(long teamId)
```
  - clearUserUserGroups
```
public static void clearUserUserGroups(long userId)
```
  - copyUserGroupLayouts
```
@Deprecated
public static void copyUserGroupLayouts(long userGroupId,
                                                    long userId)
                                             throws PortalException
```
    Deprecated. As of Paton (6.1.x)
    
    Copies the user group's layout to the user.
    
    Parameters:
    
    userGroupId - the primary key of the user group
    
    userId - the primary key of the user
    
    Throws:
    
    PortalException
  - copyUserGroupLayouts
```
@Deprecated
public static void copyUserGroupLayouts(long userGroupId,
                                                    long[] userIds)
                                             throws PortalException
```
    Deprecated. As of Newton (6.2.x)
    
    Copies the user group's layouts to the users who are not already members of the user group.
    
    Parameters:
    
    userGroupId - the primary key of the user group
    
    userIds - the primary keys of the users
    
    Throws:
    
    PortalException
  - copyUserGroupLayouts
```
@Deprecated
public static void copyUserGroupLayouts(long[] userGroupIds,
                                                    long userId)
                                             throws PortalException
```
    Deprecated. As of Newton (6.2.x)
    
    Copies the user groups' layouts to the user.
    
    Parameters:
    
    userGroupIds - the primary keys of the user groups
    
    userId - the primary key of the user
    
    Throws:
    
    PortalException
  - createUserGroup
```
public static UserGroup createUserGroup(long userGroupId)
```
    Creates a new user group with the primary key. Does not add the user group to the database.
    
    Parameters:
    
    userGroupId - the primary key for the new user group
    
    Returns:
    
    the new user group
  - deleteGroupUserGroup
```
public static void deleteGroupUserGroup(long groupId,
                                        long userGroupId)
```
  - deleteGroupUserGroup
```
public static void deleteGroupUserGroup(long groupId,
                                        UserGroup userGroup)
```
  - deleteGroupUserGroups
```
public static void deleteGroupUserGroups(long groupId,
                                         List<UserGroup> userGroups)
```
  - deleteGroupUserGroups
```
public static void deleteGroupUserGroups(long groupId,
                                         long[] userGroupIds)
```
  - deletePersistedModel
```
public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException
```
    Throws:
    
    PortalException
  - deleteTeamUserGroup
```
public static void deleteTeamUserGroup(long teamId,
                                       long userGroupId)
```
  - deleteTeamUserGroup
```
public static void deleteTeamUserGroup(long teamId,
                                       UserGroup userGroup)
```
  - deleteTeamUserGroups
```
public static void deleteTeamUserGroups(long teamId,
                                        List<UserGroup> userGroups)
```
  - deleteTeamUserGroups
```
public static void deleteTeamUserGroups(long teamId,
                                        long[] userGroupIds)
```
  - deleteUserGroup
```
public static UserGroup deleteUserGroup(long userGroupId)
                                 throws PortalException
```
    Deletes the user group with the primary key from the database. Also notifies the appropriate model listeners.
    
    Parameters:
    
    userGroupId - the primary key of the user group
    
    Returns:
    
    the user group that was removed
    
    Throws:
    
    PortalException - if a user group with the primary key could not be found
  - deleteUserGroup
```
public static UserGroup deleteUserGroup(UserGroup userGroup)
                                 throws PortalException
```
    Deletes the user group from the database. Also notifies the appropriate model listeners.
    
    Parameters:
    
    userGroup - the user group
    
    Returns:
    
    the user group that was removed
    
    Throws:
    
    PortalException
  - deleteUserGroups
```
public static void deleteUserGroups(long companyId)
                             throws PortalException
```
    Throws:
    
    PortalException
  - deleteUserUserGroup
```
public static void deleteUserUserGroup(long userId,
                                       long userGroupId)
```
  - deleteUserUserGroup
```
public static void deleteUserUserGroup(long userId,
                                       UserGroup userGroup)
```
  - deleteUserUserGroups
```
public static void deleteUserUserGroups(long userId,
                                        List<UserGroup> userGroups)
```
  - deleteUserUserGroups
```
public static void deleteUserUserGroups(long userId,
                                        long[] userGroupIds)
```
  - dynamicQuery
```
public static DynamicQuery dynamicQuery()
```
  - dynamicQuery
```
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
```
    Performs a dynamic query on the database and returns the matching rows.
    
    Parameters:
    
    dynamicQuery - the dynamic query
    
    Returns:
    
    the matching rows
  - dynamicQuery
```
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end)
```
    Performs a dynamic query on the database and returns a range of the matching rows.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.UserGroupModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
    
    Parameters:
    
    dynamicQuery - the dynamic query
    
    start - the lower bound of the range of model instances
    
    end - the upper bound of the range of model instances (not inclusive)
    
    Returns:
    
    the range of matching rows
  - dynamicQuery
```
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end,
                                       OrderByComparator<T> orderByComparator)
```
    Performs a dynamic query on the database and returns an ordered range of the matching rows.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.UserGroupModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
    
    Parameters:
    
    dynamicQuery - the dynamic query
    
    start - the lower bound of the range of model instances
    
    end - the upper bound of the range of model instances (not inclusive)
    
    orderByComparator - the comparator to order the results by (optionally null)
    
    Returns:
    
    the ordered range of matching rows
  - dynamicQueryCount
```
public static long dynamicQueryCount(DynamicQuery dynamicQuery)
```
    Returns the number of rows matching the dynamic query.
    
    Parameters:
    
    dynamicQuery - the dynamic query
    
    Returns:
    
    the number of rows matching the dynamic query
  - dynamicQueryCount
```
public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
```
    Returns the number of rows matching the dynamic query.
    
    Parameters:
    
    dynamicQuery - the dynamic query
    
    projection - the projection to apply to the query
    
    Returns:
    
    the number of rows matching the dynamic query
  - fetchUserGroup
```
public static UserGroup fetchUserGroup(long userGroupId)
```
  - fetchUserGroup
```
public static UserGroup fetchUserGroup(long companyId,
                                       String name)
```
  - fetchUserGroupByReferenceCode
```
public static UserGroup fetchUserGroupByReferenceCode(long companyId,
                                                      String externalReferenceCode)
```
    Returns the user group with the matching external reference code and company.
    
    Parameters:
    
    companyId - the primary key of the company
    
    externalReferenceCode - the user group's external reference code
    
    Returns:
    
    the matching user group, or null if a matching user group could not be found
  - fetchUserGroupByUuidAndCompanyId
```
public static UserGroup fetchUserGroupByUuidAndCompanyId(String uuid,
                                                         long companyId)
```
    Returns the user group with the matching UUID and company.
    
    Parameters:
    
    uuid - the user group's UUID
    
    companyId - the primary key of the company
    
    Returns:
    
    the matching user group, or null if a matching user group could not be found
  - getActionableDynamicQuery
```
public static ActionableDynamicQuery getActionableDynamicQuery()
```
  - getExportActionableDynamicQuery
```
public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
```
  - getGroupPrimaryKeys
```
public static long[] getGroupPrimaryKeys(long userGroupId)
```
    Returns the groupIds of the groups associated with the user group.
    
    Parameters:
    
    userGroupId - the userGroupId of the user group
    
    Returns:
    
    long[] the groupIds of groups associated with the user group
  - getGroupUserGroups
```
public static List<UserGroup> getGroupUserGroups(long groupId)
```
  - getGroupUserGroups
```
public static List<UserGroup> getGroupUserGroups(long groupId,
                                                 int start,
                                                 int end)
```
  - getGroupUserGroups
```
public static List<UserGroup> getGroupUserGroups(long groupId,
                                                 int start,
                                                 int end,
                                                 OrderByComparator<UserGroup> orderByComparator)
```
  - getGroupUserGroupsCount
```
public static int getGroupUserGroupsCount(long groupId)
```
  - getGroupUserUserGroups
```
public static List<UserGroup> getGroupUserUserGroups(long groupId,
                                                     long userId)
                                              throws PortalException
```
    Throws:
    
    PortalException
  - getIndexableActionableDynamicQuery
```
public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
```
  - getOSGiServiceIdentifier
```
public static String getOSGiServiceIdentifier()
```
    Returns the OSGi service identifier.
    
    Returns:
    
    the OSGi service identifier
  - getPersistedModel
```
public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException
```
    Throws:
    
    PortalException
  - getTeamPrimaryKeys
```
public static long[] getTeamPrimaryKeys(long userGroupId)
```
    Returns the teamIds of the teams associated with the user group.
    
    Parameters:
    
    userGroupId - the userGroupId of the user group
    
    Returns:
    
    long[] the teamIds of teams associated with the user group
  - getTeamUserGroups
```
public static List<UserGroup> getTeamUserGroups(long teamId)
```
  - getTeamUserGroups
```
public static List<UserGroup> getTeamUserGroups(long teamId,
                                                int start,
                                                int end)
```
  - getTeamUserGroups
```
public static List<UserGroup> getTeamUserGroups(long teamId,
                                                int start,
                                                int end,
                                                OrderByComparator<UserGroup> orderByComparator)
```
  - getTeamUserGroupsCount
```
public static int getTeamUserGroupsCount(long teamId)
```
  - getUserGroup
```
public static UserGroup getUserGroup(long userGroupId)
                              throws PortalException
```
    Returns the user group with the primary key.
    
    Parameters:
    
    userGroupId - the primary key of the user group
    
    Returns:
    
    the user group
    
    Throws:
    
    PortalException - if a user group with the primary key could not be found
  - getUserGroup
```
public static UserGroup getUserGroup(long companyId,
                                     String name)
                              throws PortalException
```
    Returns the user group with the name.
    
    Parameters:
    
    companyId - the primary key of the user group's company
    
    name - the user group's name
    
    Returns:
    
    Returns the user group with the name
    
    Throws:
    
    PortalException
  - getUserGroupByUuidAndCompanyId
```
public static UserGroup getUserGroupByUuidAndCompanyId(String uuid,
                                                       long companyId)
                                                throws PortalException
```
    Returns the user group with the matching UUID and company.
    
    Parameters:
    
    uuid - the user group's UUID
    
    companyId - the primary key of the company
    
    Returns:
    
    the matching user group
    
    Throws:
    
    PortalException - if a matching user group could not be found
  - getUserGroups
```
public static List<UserGroup> getUserGroups(int start,
                                            int end)
```
    Returns a range of all the user groups.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.UserGroupModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
    
    Parameters:
    
    start - the lower bound of the range of user groups
    
    end - the upper bound of the range of user groups (not inclusive)
    
    Returns:
    
    the range of user groups
  - getUserGroups
```
public static List<UserGroup> getUserGroups(long companyId)
```
    Returns all the user groups belonging to the company.
    
    Parameters:
    
    companyId - the primary key of the user groups' company
    
    Returns:
    
    the user groups belonging to the company
  - getUserGroups
```
public static List<UserGroup> getUserGroups(long companyId,
                                            String name,
                                            int start,
                                            int end)
```
  - getUserGroups
```
public static List<UserGroup> getUserGroups(long[] userGroupIds)
                                     throws PortalException
```
    Returns all the user groups with the primary keys.
    
    Parameters:
    
    userGroupIds - the primary keys of the user groups
    
    Returns:
    
    the user groups with the primary keys
    
    Throws:
    
    PortalException
  - getUserGroupsCount
```
public static int getUserGroupsCount()
```
    Returns the number of user groups.
    
    Returns:
    
    the number of user groups
  - getUserGroupsCount
```
public static int getUserGroupsCount(long companyId,
                                     String name)
```
  - getUserPrimaryKeys
```
public static long[] getUserPrimaryKeys(long userGroupId)
```
    Returns the userIds of the users associated with the user group.
    
    Parameters:
    
    userGroupId - the userGroupId of the user group
    
    Returns:
    
    long[] the userIds of users associated with the user group
  - getUserUserGroups
```
public static List<UserGroup> getUserUserGroups(long userId)
```
  - getUserUserGroups
```
public static List<UserGroup> getUserUserGroups(long userId,
                                                int start,
                                                int end)
```
  - getUserUserGroups
```
public static List<UserGroup> getUserUserGroups(long userId,
                                                int start,
                                                int end,
                                                OrderByComparator<UserGroup> orderByComparator)
```
  - getUserUserGroupsCount
```
public static int getUserUserGroupsCount(long userId)
```
  - hasGroupUserGroup
```
public static boolean hasGroupUserGroup(long groupId,
                                        long userGroupId)
```
  - hasGroupUserGroups
```
public static boolean hasGroupUserGroups(long groupId)
```
  - hasTeamUserGroup
```
public static boolean hasTeamUserGroup(long teamId,
                                       long userGroupId)
```
  - hasTeamUserGroups
```
public static boolean hasTeamUserGroups(long teamId)
```
  - hasUserUserGroup
```
public static boolean hasUserUserGroup(long userId,
                                       long userGroupId)
```
  - hasUserUserGroups
```
public static boolean hasUserUserGroups(long userId)
```
  - search
```
public static List<UserGroup> search(long companyId,
                                     String keywords,
                                     LinkedHashMap<String,Object> params,
                                     int start,
                                     int end,
                                     OrderByComparator<UserGroup> obc)
```
    Returns an ordered range of all the user groups that match the keywords.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    Parameters:
    
    companyId - the primary key of the user group's company
    
    keywords - the keywords (space separated), which may occur in the user group's name or description (optionally null)
    
    params - the finder params (optionally null). For more information see UserGroupFinder
    
    start - the lower bound of the range of user groups to return
    
    end - the upper bound of the range of user groups to return (not inclusive)
    
    obc - the comparator to order the user groups (optionally null)
    
    Returns:
    
    the matching user groups ordered by comparator obc
    
    See Also:
    
    UserGroupFinder
  - search
```
public static Hits search(long companyId,
                          String keywords,
                          LinkedHashMap<String,Object> params,
                          int start,
                          int end,
                          Sort sort)
```
    Returns an ordered range of all the user groups that match the keywords, using the indexer. It is preferable to use this method instead of the non-indexed version whenever possible for performance reasons.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    Parameters:
    
    companyId - the primary key of the user group's company
    
    keywords - the keywords (space separated), which may occur in the user group's name or description (optionally null)
    
    params - the finder params (optionally null). For more information see com.liferay.user.groups.admin.web.search.UserGroupIndexer
    
    start - the lower bound of the range of user groups to return
    
    end - the upper bound of the range of user groups to return (not inclusive)
    
    sort - the field and direction by which to sort (optionally null)
    
    Returns:
    
    the matching user groups ordered by sort
    
    See Also:
    
    com.liferay.user.groups.admin.web.search.UserGroupIndexer
  - search
```
public static List<UserGroup> search(long companyId,
                                     String name,
                                     String description,
                                     LinkedHashMap<String,Object> params,
                                     boolean andOperator,
                                     int start,
                                     int end,
                                     OrderByComparator<UserGroup> obc)
```
    Returns an ordered range of all the user groups that match the name and description.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    Parameters:
    
    companyId - the primary key of the user group's company
    
    name - the user group's name (optionally null)
    
    description - the user group's description (optionally null)
    
    params - the finder params (optionally null). For more information see UserGroupFinder
    
    andOperator - whether every field must match its keywords or just one field
    
    start - the lower bound of the range of user groups to return
    
    end - the upper bound of the range of user groups to return (not inclusive)
    
    obc - the comparator to order the user groups (optionally null)
    
    Returns:
    
    the matching user groups ordered by comparator obc
    
    See Also:
    
    UserGroupFinder
  - search
```
public static Hits search(long companyId,
                          String name,
                          String description,
                          LinkedHashMap<String,Object> params,
                          boolean andSearch,
                          int start,
                          int end,
                          Sort sort)
```
    Returns an ordered range of all the user groups that match the name and description. It is preferable to use this method instead of the non-indexed version whenever possible for performance reasons.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    Parameters:
    
    companyId - the primary key of the user group's company
    
    name - the user group's name (optionally null)
    
    description - the user group's description (optionally null)
    
    params - the finder params (optionally null). For more information see com.liferay.user.groups.admin.web.search.UserGroupIndexer
    
    andSearch - whether every field must match its keywords or just one field
    
    start - the lower bound of the range of user groups to return
    
    end - the upper bound of the range of user groups to return (not inclusive)
    
    sort - the field and direction by which to sort (optionally null)
    
    Returns:
    
    the matching user groups ordered by sort
    
    See Also:
    
    UserGroupFinder
  - searchCount
```
public static int searchCount(long companyId,
                              String keywords,
                              LinkedHashMap<String,Object> params)
```
    Returns the number of user groups that match the keywords
    
    Parameters:
    
    companyId - the primary key of the user group's company
    
    keywords - the keywords (space separated), which may occur in the user group's name or description (optionally null)
    
    params - the finder params (optionally null). For more information see UserGroupFinder
    
    Returns:
    
    the number of matching user groups
    
    See Also:
    
    UserGroupFinder
  - searchCount
```
public static int searchCount(long companyId,
                              String name,
                              String description,
                              LinkedHashMap<String,Object> params,
                              boolean andOperator)
```
    Returns the number of user groups that match the name and description.
    
    Parameters:
    
    companyId - the primary key of the user group's company
    
    name - the user group's name (optionally null)
    
    description - the user group's description (optionally null)
    
    params - the finder params (optionally null). For more information see UserGroupFinder
    
    andOperator - whether every field must match its keywords or just one field
    
    Returns:
    
    the number of matching user groups
    
    See Also:
    
    UserGroupFinder
  - searchUserGroups
```
public static BaseModelSearchResult<UserGroup> searchUserGroups(long companyId,
                                                                String keywords,
                                                                LinkedHashMap<String,Object> params,
                                                                int start,
                                                                int end,
                                                                Sort sort)
                                                         throws PortalException
```
    Throws:
    
    PortalException
  - searchUserGroups
```
public static BaseModelSearchResult<UserGroup> searchUserGroups(long companyId,
                                                                String name,
                                                                String description,
                                                                LinkedHashMap<String,Object> params,
                                                                boolean andSearch,
                                                                int start,
                                                                int end,
                                                                Sort sort)
                                                         throws PortalException
```
    Throws:
    
    PortalException
  - setGroupUserGroups
```
public static void setGroupUserGroups(long groupId,
                                      long[] userGroupIds)
```
  - setTeamUserGroups
```
public static void setTeamUserGroups(long teamId,
                                     long[] userGroupIds)
```
  - setUserUserGroups
```
public static void setUserUserGroups(long userId,
                                     long[] userGroupIds)
                              throws PortalException
```
    Throws:
    
    PortalException
  - unsetGroupUserGroups
```
public static void unsetGroupUserGroups(long groupId,
                                        long[] userGroupIds)
```
    Removes the user groups from the group.
    
    Parameters:
    
    groupId - the primary key of the group
    
    userGroupIds - the primary keys of the user groups
  - unsetTeamUserGroups
```
public static void unsetTeamUserGroups(long teamId,
                                       long[] userGroupIds)
```
    Removes the user groups from the team.
    
    Parameters:
    
    teamId - the primary key of the team
    
    userGroupIds - the primary keys of the user groups
  - updateUserGroup
```
public static UserGroup updateUserGroup(long companyId,
                                        long userGroupId,
                                        String name,
                                        String description,
                                        ServiceContext serviceContext)
                                 throws PortalException
```
    Updates the user group.
    
    Parameters:
    
    companyId - the primary key of the user group's company
    
    userGroupId - the primary key of the user group
    
    name - the user group's name
    
    description - the user group's description
    
    serviceContext - the service context to be applied (optionally null). Can set expando bridge attributes for the user group.
    
    Returns:
    
    the user group
    
    Throws:
    
    PortalException
  - updateUserGroup
```
public static UserGroup updateUserGroup(UserGroup userGroup)
```
    Updates the user group in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
    
    Parameters:
    
    userGroup - the user group
    
    Returns:
    
    the user group that was updated
  - getService
```
public static UserGroupLocalService getService()
```

Class UserGroupLocalServiceUtil

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

UserGroupLocalServiceUtil

Method Detail

addGroupUserGroup

addGroupUserGroup

addGroupUserGroups

addGroupUserGroups

addTeamUserGroup

addTeamUserGroup

addTeamUserGroups

addTeamUserGroups

addUserGroup

addUserGroup

addUserUserGroup

addUserUserGroup

addUserUserGroups

addUserUserGroups

clearGroupUserGroups

clearTeamUserGroups

clearUserUserGroups

copyUserGroupLayouts

copyUserGroupLayouts

copyUserGroupLayouts

createUserGroup

deleteGroupUserGroup

deleteGroupUserGroup

deleteGroupUserGroups

deleteGroupUserGroups

deletePersistedModel

deleteTeamUserGroup

deleteTeamUserGroup

deleteTeamUserGroups

deleteTeamUserGroups

deleteUserGroup

deleteUserGroup

deleteUserGroups

deleteUserUserGroup

deleteUserUserGroup

deleteUserUserGroups

deleteUserUserGroups

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQueryCount

dynamicQueryCount

fetchUserGroup

fetchUserGroup

fetchUserGroupByReferenceCode

fetchUserGroupByUuidAndCompanyId

getActionableDynamicQuery

getExportActionableDynamicQuery

getGroupPrimaryKeys

getGroupUserGroups

getGroupUserGroups

getGroupUserGroups

getGroupUserGroupsCount

getGroupUserUserGroups

getIndexableActionableDynamicQuery

getOSGiServiceIdentifier

getPersistedModel

getTeamPrimaryKeys

getTeamUserGroups

getTeamUserGroups

getTeamUserGroups

getTeamUserGroupsCount

getUserGroup

getUserGroup

getUserGroupByUuidAndCompanyId

getUserGroups

getUserGroups

getUserGroups

getUserGroups

getUserGroupsCount

getUserGroupsCount

getUserPrimaryKeys