Liferay 7.0-ce-b4

com.liferay.portal.service
Interface UserGroupLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
UserGroupLocalServiceBaseImpl, UserGroupLocalServiceImpl, UserGroupLocalServiceWrapper

@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface UserGroupLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for UserGroup. 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.

See Also:
UserGroupLocalServiceUtil, UserGroupLocalServiceBaseImpl, UserGroupLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 void addGroupUserGroup(long groupId, long userGroupId)
           
 void addGroupUserGroup(long groupId, UserGroup userGroup)
           
 void addGroupUserGroups(long groupId, List<UserGroup> UserGroups)
           
 void addGroupUserGroups(long groupId, long[] userGroupIds)
           
 void addTeamUserGroup(long teamId, long userGroupId)
           
 void addTeamUserGroup(long teamId, UserGroup userGroup)
           
 void addTeamUserGroups(long teamId, List<UserGroup> UserGroups)
           
 void addTeamUserGroups(long teamId, long[] userGroupIds)
           
 UserGroup addUserGroup(long userId, long companyId, String name, String description)
          Deprecated. As of 6.2.0, replaced by addUserGroup(long, long, String, String, ServiceContext)
 UserGroup addUserGroup(long userId, long companyId, String name, String description, ServiceContext serviceContext)
          Adds a user group.
 UserGroup addUserGroup(UserGroup userGroup)
          Adds the user group to the database.
 void addUserUserGroup(long userId, long userGroupId)
           
 void addUserUserGroup(long userId, UserGroup userGroup)
           
 void addUserUserGroups(long userId, List<UserGroup> UserGroups)
           
 void addUserUserGroups(long userId, long[] userGroupIds)
           
 void clearGroupUserGroups(long groupId)
           
 void clearTeamUserGroups(long teamId)
           
 void clearUserUserGroups(long userId)
           
 void copyUserGroupLayouts(long[] userGroupIds, long userId)
          Deprecated. As of 6.1.0
 void copyUserGroupLayouts(long userGroupId, long userId)
          Deprecated. As of 6.2.0
 void copyUserGroupLayouts(long userGroupId, long[] userIds)
          Deprecated. As of 6.1.0
 UserGroup createUserGroup(long userGroupId)
          Creates a new user group with the primary key.
 void deleteGroupUserGroup(long groupId, long userGroupId)
           
 void deleteGroupUserGroup(long groupId, UserGroup userGroup)
           
 void deleteGroupUserGroups(long groupId, List<UserGroup> UserGroups)
           
 void deleteGroupUserGroups(long groupId, long[] userGroupIds)
           
 PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
 void deleteTeamUserGroup(long teamId, long userGroupId)
           
 void deleteTeamUserGroup(long teamId, UserGroup userGroup)
           
 void deleteTeamUserGroups(long teamId, List<UserGroup> UserGroups)
           
 void deleteTeamUserGroups(long teamId, long[] userGroupIds)
           
 UserGroup deleteUserGroup(long userGroupId)
          Deletes the user group with the primary key from the database.
 UserGroup deleteUserGroup(UserGroup userGroup)
          Deletes the user group from the database.
 void deleteUserGroups(long companyId)
           
 void deleteUserUserGroup(long userId, long userGroupId)
           
 void deleteUserUserGroup(long userId, UserGroup userGroup)
           
 void deleteUserUserGroups(long userId, List<UserGroup> UserGroups)
           
 void deleteUserUserGroups(long userId, long[] userGroupIds)
           
 DynamicQuery dynamicQuery()
           
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
<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.
<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.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows matching the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows matching the dynamic query.
 UserGroup fetchUserGroup(long userGroupId)
           
 UserGroup fetchUserGroup(long companyId, String name)
           
 UserGroup fetchUserGroupByUuidAndCompanyId(String uuid, long companyId)
          Returns the user group with the matching UUID and company.
 ActionableDynamicQuery getActionableDynamicQuery()
           
 ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
           
 long[] getGroupPrimaryKeys(long userGroupId)
          Returns the groupIds of the groups associated with the user group.
 List<UserGroup> getGroupUserGroups(long groupId)
           
 List<UserGroup> getGroupUserGroups(long groupId, int start, int end)
           
 List<UserGroup> getGroupUserGroups(long groupId, int start, int end, OrderByComparator<UserGroup> orderByComparator)
           
 int getGroupUserGroupsCount(long groupId)
           
 List<UserGroup> getGroupUserUserGroups(long groupId, long userId)
           
 IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
           
 String getOSGiServiceIdentifier()
          Returns the OSGi service identifier.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 long[] getTeamPrimaryKeys(long userGroupId)
          Returns the teamIds of the teams associated with the user group.
 List<UserGroup> getTeamUserGroups(long teamId)
           
 List<UserGroup> getTeamUserGroups(long teamId, int start, int end)
           
 List<UserGroup> getTeamUserGroups(long teamId, int start, int end, OrderByComparator<UserGroup> orderByComparator)
           
 int getTeamUserGroupsCount(long teamId)
           
 UserGroup getUserGroup(long userGroupId)
          Returns the user group with the primary key.
 UserGroup getUserGroup(long companyId, String name)
          Returns the user group with the name.
 UserGroup getUserGroupByUuidAndCompanyId(String uuid, long companyId)
          Returns the user group with the matching UUID and company.
 List<UserGroup> getUserGroups(int start, int end)
          Returns a range of all the user groups.
 List<UserGroup> getUserGroups(long companyId)
          Returns all the user groups belonging to the company.
 List<UserGroup> getUserGroups(long[] userGroupIds)
          Returns all the user groups with the primary keys.
 int getUserGroupsCount()
          Returns the number of user groups.
 long[] getUserPrimaryKeys(long userGroupId)
          Returns the userIds of the users associated with the user group.
 List<UserGroup> getUserUserGroups(long userId)
           
 List<UserGroup> getUserUserGroups(long userId, int start, int end)
           
 List<UserGroup> getUserUserGroups(long userId, int start, int end, OrderByComparator<UserGroup> orderByComparator)
           
 int getUserUserGroupsCount(long userId)
           
 boolean hasGroupUserGroup(long groupId, long userGroupId)
           
 boolean hasGroupUserGroups(long groupId)
           
 boolean hasTeamUserGroup(long teamId, long userGroupId)
           
 boolean hasTeamUserGroups(long teamId)
           
 boolean hasUserUserGroup(long userId, long userGroupId)
           
 boolean hasUserUserGroups(long userId)
           
 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.
 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.
 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.
 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.
 int searchCount(long companyId, String keywords, LinkedHashMap<String,Object> params)
          Returns the number of user groups that match the keywords
 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.
 BaseModelSearchResult<UserGroup> searchUserGroups(long companyId, String keywords, LinkedHashMap<String,Object> params, int start, int end, Sort sort)
           
 BaseModelSearchResult<UserGroup> searchUserGroups(long companyId, String name, String description, LinkedHashMap<String,Object> params, boolean andSearch, int start, int end, Sort sort)
           
 void setGroupUserGroups(long groupId, long[] userGroupIds)
           
 void setTeamUserGroups(long teamId, long[] userGroupIds)
           
 void setUserUserGroups(long userId, long[] userGroupIds)
           
 void unsetGroupUserGroups(long groupId, long[] userGroupIds)
          Removes the user groups from the group.
 void unsetTeamUserGroups(long teamId, long[] userGroupIds)
          Removes the user groups from the team.
 UserGroup updateUserGroup(long companyId, long userGroupId, String name, String description)
          Deprecated. As of 6.2.0, replaced by updateUserGroup(long, long, String, String, ServiceContext)
 UserGroup updateUserGroup(long companyId, long userGroupId, String name, String description, ServiceContext serviceContext)
          Updates the user group.
 UserGroup updateUserGroup(UserGroup userGroup)
          Updates the user group in the database or adds it if it does not yet exist.
 

Method Detail

addGroupUserGroup

void addGroupUserGroup(long groupId,
                       UserGroup userGroup)

addGroupUserGroup

void addGroupUserGroup(long groupId,
                       long userGroupId)

addGroupUserGroups

void addGroupUserGroups(long groupId,
                        List<UserGroup> UserGroups)

addGroupUserGroups

void addGroupUserGroups(long groupId,
                        long[] userGroupIds)

addTeamUserGroup

void addTeamUserGroup(long teamId,
                      UserGroup userGroup)

addTeamUserGroup

void addTeamUserGroup(long teamId,
                      long userGroupId)

addTeamUserGroups

void addTeamUserGroups(long teamId,
                       List<UserGroup> UserGroups)

addTeamUserGroups

void addTeamUserGroups(long teamId,
                       long[] userGroupIds)

addUserGroup

@Indexable(type=REINDEX)
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

addUserGroup

@Deprecated
UserGroup addUserGroup(long userId,
                                  long companyId,
                                  String name,
                                  String description)
                       throws PortalException
Deprecated. As of 6.2.0, replaced by addUserGroup(long, long, String, String, ServiceContext)

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
Returns:
the user group
Throws:
PortalException

addUserGroup

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

addUserUserGroup

void addUserUserGroup(long userId,
                      UserGroup userGroup)

addUserUserGroup

void addUserUserGroup(long userId,
                      long userGroupId)

addUserUserGroups

void addUserUserGroups(long userId,
                       List<UserGroup> UserGroups)

addUserUserGroups

void addUserUserGroups(long userId,
                       long[] userGroupIds)

clearGroupUserGroups

void clearGroupUserGroups(long groupId)

clearTeamUserGroups

void clearTeamUserGroups(long teamId)

clearUserUserGroups

void clearUserUserGroups(long userId)

copyUserGroupLayouts

@Deprecated
void copyUserGroupLayouts(long userGroupId,
                                     long userId)
                          throws PortalException
Deprecated. As of 6.2.0

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
void copyUserGroupLayouts(long userGroupId,
                                     long[] userIds)
                          throws PortalException
Deprecated. As of 6.1.0

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
void copyUserGroupLayouts(long[] userGroupIds,
                                     long userId)
                          throws PortalException
Deprecated. As of 6.1.0

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

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

void deleteGroupUserGroup(long groupId,
                          UserGroup userGroup)

deleteGroupUserGroup

void deleteGroupUserGroup(long groupId,
                          long userGroupId)

deleteGroupUserGroups

void deleteGroupUserGroups(long groupId,
                           List<UserGroup> UserGroups)

deleteGroupUserGroups

void deleteGroupUserGroups(long groupId,
                           long[] userGroupIds)

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                    throws PortalException
Specified by:
deletePersistedModel in interface PersistedModelLocalService
Throws:
PortalException

deleteTeamUserGroup

void deleteTeamUserGroup(long teamId,
                         UserGroup userGroup)

deleteTeamUserGroup

void deleteTeamUserGroup(long teamId,
                         long userGroupId)

deleteTeamUserGroups

void deleteTeamUserGroups(long teamId,
                          List<UserGroup> UserGroups)

deleteTeamUserGroups

void deleteTeamUserGroups(long teamId,
                          long[] userGroupIds)

deleteUserGroup

@Indexable(type=DELETE)
@SystemEvent(action=1,
             type=1)
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

deleteUserGroup

@Indexable(type=DELETE)
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

deleteUserGroups

void deleteUserGroups(long companyId)
                      throws PortalException
Throws:
PortalException

deleteUserUserGroup

void deleteUserUserGroup(long userId,
                         UserGroup userGroup)

deleteUserUserGroup

void deleteUserUserGroup(long userId,
                         long userGroupId)

deleteUserUserGroups

void deleteUserUserGroups(long userId,
                          List<UserGroup> UserGroups)

deleteUserUserGroups

void deleteUserUserGroups(long userId,
                          long[] userGroupIds)

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

<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

<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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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

<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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserGroup fetchUserGroup(long companyId,
                                                                  String name)

fetchUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserGroup fetchUserGroup(long userGroupId)

fetchUserGroupByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getGroupPrimaryKeys

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getGroupUserGroups(long groupId)

getGroupUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getGroupUserGroups(long groupId,
                                                                            int start,
                                                                            int end)

getGroupUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getGroupUserGroups(long groupId,
                                                                            int start,
                                                                            int end,
                                                                            OrderByComparator<UserGroup> orderByComparator)

getGroupUserGroupsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupUserGroupsCount(long groupId)

getGroupUserUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getGroupUserUserGroups(long groupId,
                                                                                long userId)
                                       throws PortalException
Throws:
PortalException

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()
Returns the OSGi service identifier.

Returns:
the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException

getTeamPrimaryKeys

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getTeamUserGroups(long teamId)

getTeamUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getTeamUserGroups(long teamId,
                                                                           int start,
                                                                           int end)

getTeamUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getTeamUserGroups(long teamId,
                                                                           int start,
                                                                           int end,
                                                                           OrderByComparator<UserGroup> orderByComparator)

getTeamUserGroupsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getTeamUserGroupsCount(long teamId)

getUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getUserGroupByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserGroupsCount()
Returns the number of user groups.

Returns:
the number of user groups

getUserPrimaryKeys

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getUserUserGroups(long userId)

getUserUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getUserUserGroups(long userId,
                                                                           int start,
                                                                           int end)

getUserUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getUserUserGroups(long userId,
                                                                           int start,
                                                                           int end,
                                                                           OrderByComparator<UserGroup> orderByComparator)

getUserUserGroupsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserUserGroupsCount(long userId)

hasGroupUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasGroupUserGroup(long groupId,
                                                                   long userGroupId)

hasGroupUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasGroupUserGroups(long groupId)

hasTeamUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasTeamUserGroup(long teamId,
                                                                  long userGroupId)

hasTeamUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasTeamUserGroups(long teamId)

hasUserUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserUserGroup(long userId,
                                                                  long userGroupId)

hasUserUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserUserGroups(long userId)

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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.portlet.usergroupsadmin.util.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.portlet.usergroupsadmin.util.UserGroupIndexer

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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.portlet.usergroupsadmin.util.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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BaseModelSearchResult<UserGroup> searchUserGroups(long companyId,
                                                                                           String keywords,
                                                                                           LinkedHashMap<String,Object> params,
                                                                                           int start,
                                                                                           int end,
                                                                                           Sort sort)
                                                  throws PortalException
Throws:
PortalException

searchUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

void setGroupUserGroups(long groupId,
                        long[] userGroupIds)

setTeamUserGroups

void setTeamUserGroups(long teamId,
                       long[] userGroupIds)

setUserUserGroups

void setUserUserGroups(long userId,
                       long[] userGroupIds)
                       throws PortalException
Throws:
PortalException

unsetGroupUserGroups

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

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

@Deprecated
UserGroup updateUserGroup(long companyId,
                                     long userGroupId,
                                     String name,
                                     String description)
                          throws PortalException
Deprecated. As of 6.2.0, replaced by updateUserGroup(long, long, String, String, ServiceContext)

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
Returns:
the user group
Throws:
PortalException

updateUserGroup

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

@Indexable(type=REINDEX)
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

Liferay 7.0-ce-b4