Liferay 7.0-ce-b4

com.liferay.portal.service
Class UserGroupLocalServiceWrapper

java.lang.Object
  extended by com.liferay.portal.service.UserGroupLocalServiceWrapper
All Implemented Interfaces:
BaseLocalService, PersistedModelLocalService, ServiceWrapper<UserGroupLocalService>, UserGroupLocalService

@ProviderType
public class UserGroupLocalServiceWrapper
extends Object
implements UserGroupLocalService, ServiceWrapper<UserGroupLocalService>

Provides a wrapper for UserGroupLocalService.

See Also:
UserGroupLocalService

Constructor Summary
UserGroupLocalServiceWrapper(UserGroupLocalService userGroupLocalService)
           
 
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)
           
 UserGroupLocalService getWrappedService()
           
 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 setWrappedService(UserGroupLocalService userGroupLocalService)
           
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UserGroupLocalServiceWrapper

public UserGroupLocalServiceWrapper(UserGroupLocalService userGroupLocalService)
Method Detail

addGroupUserGroup

public void addGroupUserGroup(long groupId,
                              UserGroup userGroup)
Specified by:
addGroupUserGroup in interface UserGroupLocalService

addGroupUserGroup

public void addGroupUserGroup(long groupId,
                              long userGroupId)
Specified by:
addGroupUserGroup in interface UserGroupLocalService

addGroupUserGroups

public void addGroupUserGroups(long groupId,
                               List<UserGroup> UserGroups)
Specified by:
addGroupUserGroups in interface UserGroupLocalService

addGroupUserGroups

public void addGroupUserGroups(long groupId,
                               long[] userGroupIds)
Specified by:
addGroupUserGroups in interface UserGroupLocalService

addTeamUserGroup

public void addTeamUserGroup(long teamId,
                             UserGroup userGroup)
Specified by:
addTeamUserGroup in interface UserGroupLocalService

addTeamUserGroup

public void addTeamUserGroup(long teamId,
                             long userGroupId)
Specified by:
addTeamUserGroup in interface UserGroupLocalService

addTeamUserGroups

public void addTeamUserGroups(long teamId,
                              List<UserGroup> UserGroups)
Specified by:
addTeamUserGroups in interface UserGroupLocalService

addTeamUserGroups

public void addTeamUserGroups(long teamId,
                              long[] userGroupIds)
Specified by:
addTeamUserGroups in interface UserGroupLocalService

addUserGroup

public UserGroup addUserGroup(UserGroup userGroup)
Adds the user group to the database. Also notifies the appropriate model listeners.

Specified by:
addUserGroup in interface UserGroupLocalService
Parameters:
userGroup - the user group
Returns:
the user group that was added

addUserGroup

@Deprecated
public 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.

Specified by:
addUserGroup in interface UserGroupLocalService
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

public 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.

Specified by:
addUserGroup in interface UserGroupLocalService
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

public void addUserUserGroup(long userId,
                             UserGroup userGroup)
Specified by:
addUserUserGroup in interface UserGroupLocalService

addUserUserGroup

public void addUserUserGroup(long userId,
                             long userGroupId)
Specified by:
addUserUserGroup in interface UserGroupLocalService

addUserUserGroups

public void addUserUserGroups(long userId,
                              List<UserGroup> UserGroups)
Specified by:
addUserUserGroups in interface UserGroupLocalService

addUserUserGroups

public void addUserUserGroups(long userId,
                              long[] userGroupIds)
Specified by:
addUserUserGroups in interface UserGroupLocalService

clearGroupUserGroups

public void clearGroupUserGroups(long groupId)
Specified by:
clearGroupUserGroups in interface UserGroupLocalService

clearTeamUserGroups

public void clearTeamUserGroups(long teamId)
Specified by:
clearTeamUserGroups in interface UserGroupLocalService

clearUserUserGroups

public void clearUserUserGroups(long userId)
Specified by:
clearUserUserGroups in interface UserGroupLocalService

copyUserGroupLayouts

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

Copies the user group's layout to the user.

Specified by:
copyUserGroupLayouts in interface UserGroupLocalService
Parameters:
userGroupId - the primary key of the user group
userId - the primary key of the user
Throws:
PortalException

copyUserGroupLayouts

@Deprecated
public 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.

Specified by:
copyUserGroupLayouts in interface UserGroupLocalService
Parameters:
userGroupId - the primary key of the user group
userIds - the primary keys of the users
Throws:
PortalException

copyUserGroupLayouts

@Deprecated
public void copyUserGroupLayouts(long[] userGroupIds,
                                            long userId)
                          throws PortalException
Deprecated. As of 6.1.0

Copies the user groups' layouts to the user.

Specified by:
copyUserGroupLayouts in interface UserGroupLocalService
Parameters:
userGroupIds - the primary keys of the user groups
userId - the primary key of the user
Throws:
PortalException

createUserGroup

public UserGroup createUserGroup(long userGroupId)
Creates a new user group with the primary key. Does not add the user group to the database.

Specified by:
createUserGroup in interface UserGroupLocalService
Parameters:
userGroupId - the primary key for the new user group
Returns:
the new user group

deleteGroupUserGroup

public void deleteGroupUserGroup(long groupId,
                                 UserGroup userGroup)
Specified by:
deleteGroupUserGroup in interface UserGroupLocalService

deleteGroupUserGroup

public void deleteGroupUserGroup(long groupId,
                                 long userGroupId)
Specified by:
deleteGroupUserGroup in interface UserGroupLocalService

deleteGroupUserGroups

public void deleteGroupUserGroups(long groupId,
                                  List<UserGroup> UserGroups)
Specified by:
deleteGroupUserGroups in interface UserGroupLocalService

deleteGroupUserGroups

public void deleteGroupUserGroups(long groupId,
                                  long[] userGroupIds)
Specified by:
deleteGroupUserGroups in interface UserGroupLocalService

deletePersistedModel

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

deleteTeamUserGroup

public void deleteTeamUserGroup(long teamId,
                                UserGroup userGroup)
Specified by:
deleteTeamUserGroup in interface UserGroupLocalService

deleteTeamUserGroup

public void deleteTeamUserGroup(long teamId,
                                long userGroupId)
Specified by:
deleteTeamUserGroup in interface UserGroupLocalService

deleteTeamUserGroups

public void deleteTeamUserGroups(long teamId,
                                 List<UserGroup> UserGroups)
Specified by:
deleteTeamUserGroups in interface UserGroupLocalService

deleteTeamUserGroups

public void deleteTeamUserGroups(long teamId,
                                 long[] userGroupIds)
Specified by:
deleteTeamUserGroups in interface UserGroupLocalService

deleteUserGroup

public UserGroup deleteUserGroup(UserGroup userGroup)
                          throws PortalException
Deletes the user group from the database. Also notifies the appropriate model listeners.

Specified by:
deleteUserGroup in interface UserGroupLocalService
Parameters:
userGroup - the user group
Returns:
the user group that was removed
Throws:
PortalException

deleteUserGroup

public UserGroup deleteUserGroup(long userGroupId)
                          throws PortalException
Deletes the user group with the primary key from the database. Also notifies the appropriate model listeners.

Specified by:
deleteUserGroup in interface UserGroupLocalService
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

public void deleteUserGroups(long companyId)
                      throws PortalException
Specified by:
deleteUserGroups in interface UserGroupLocalService
Throws:
PortalException

deleteUserUserGroup

public void deleteUserUserGroup(long userId,
                                UserGroup userGroup)
Specified by:
deleteUserUserGroup in interface UserGroupLocalService

deleteUserUserGroup

public void deleteUserUserGroup(long userId,
                                long userGroupId)
Specified by:
deleteUserUserGroup in interface UserGroupLocalService

deleteUserUserGroups

public void deleteUserUserGroups(long userId,
                                 List<UserGroup> UserGroups)
Specified by:
deleteUserUserGroups in interface UserGroupLocalService

deleteUserUserGroups

public void deleteUserUserGroups(long userId,
                                 long[] userGroupIds)
Specified by:
deleteUserUserGroups in interface UserGroupLocalService

dynamicQuery

public DynamicQuery dynamicQuery()
Specified by:
dynamicQuery in interface UserGroupLocalService

dynamicQuery

public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.

Specified by:
dynamicQuery in interface UserGroupLocalService
Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows

dynamicQuery

public <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.

Specified by:
dynamicQuery in interface UserGroupLocalService
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 <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.

Specified by:
dynamicQuery in interface UserGroupLocalService
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 long dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.

Specified by:
dynamicQueryCount in interface UserGroupLocalService
Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows matching the dynamic query

dynamicQueryCount

public long dynamicQueryCount(DynamicQuery dynamicQuery,
                              Projection projection)
Returns the number of rows matching the dynamic query.

Specified by:
dynamicQueryCount in interface UserGroupLocalService
Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows matching the dynamic query

fetchUserGroup

public UserGroup fetchUserGroup(long companyId,
                                String name)
Specified by:
fetchUserGroup in interface UserGroupLocalService

fetchUserGroup

public UserGroup fetchUserGroup(long userGroupId)
Specified by:
fetchUserGroup in interface UserGroupLocalService

fetchUserGroupByUuidAndCompanyId

public UserGroup fetchUserGroupByUuidAndCompanyId(String uuid,
                                                  long companyId)
Returns the user group with the matching UUID and company.

Specified by:
fetchUserGroupByUuidAndCompanyId in interface UserGroupLocalService
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 ActionableDynamicQuery getActionableDynamicQuery()
Specified by:
getActionableDynamicQuery in interface UserGroupLocalService

getExportActionableDynamicQuery

public ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
Specified by:
getExportActionableDynamicQuery in interface UserGroupLocalService

getGroupPrimaryKeys

public long[] getGroupPrimaryKeys(long userGroupId)
Returns the groupIds of the groups associated with the user group.

Specified by:
getGroupPrimaryKeys in interface UserGroupLocalService
Parameters:
userGroupId - the userGroupId of the user group
Returns:
long[] the groupIds of groups associated with the user group

getGroupUserGroups

public List<UserGroup> getGroupUserGroups(long groupId)
Specified by:
getGroupUserGroups in interface UserGroupLocalService

getGroupUserGroups

public List<UserGroup> getGroupUserGroups(long groupId,
                                          int start,
                                          int end)
Specified by:
getGroupUserGroups in interface UserGroupLocalService

getGroupUserGroups

public List<UserGroup> getGroupUserGroups(long groupId,
                                          int start,
                                          int end,
                                          OrderByComparator<UserGroup> orderByComparator)
Specified by:
getGroupUserGroups in interface UserGroupLocalService

getGroupUserGroupsCount

public int getGroupUserGroupsCount(long groupId)
Specified by:
getGroupUserGroupsCount in interface UserGroupLocalService

getGroupUserUserGroups

public List<UserGroup> getGroupUserUserGroups(long groupId,
                                              long userId)
                                       throws PortalException
Specified by:
getGroupUserUserGroups in interface UserGroupLocalService
Throws:
PortalException

getIndexableActionableDynamicQuery

public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
Specified by:
getIndexableActionableDynamicQuery in interface UserGroupLocalService

getOSGiServiceIdentifier

public String getOSGiServiceIdentifier()
Returns the OSGi service identifier.

Specified by:
getOSGiServiceIdentifier in interface UserGroupLocalService
Returns:
the OSGi service identifier

getPersistedModel

public PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Specified by:
getPersistedModel in interface UserGroupLocalService
Throws:
PortalException

getTeamPrimaryKeys

public long[] getTeamPrimaryKeys(long userGroupId)
Returns the teamIds of the teams associated with the user group.

Specified by:
getTeamPrimaryKeys in interface UserGroupLocalService
Parameters:
userGroupId - the userGroupId of the user group
Returns:
long[] the teamIds of teams associated with the user group

getTeamUserGroups

public List<UserGroup> getTeamUserGroups(long teamId)
Specified by:
getTeamUserGroups in interface UserGroupLocalService

getTeamUserGroups

public List<UserGroup> getTeamUserGroups(long teamId,
                                         int start,
                                         int end)
Specified by:
getTeamUserGroups in interface UserGroupLocalService

getTeamUserGroups

public List<UserGroup> getTeamUserGroups(long teamId,
                                         int start,
                                         int end,
                                         OrderByComparator<UserGroup> orderByComparator)
Specified by:
getTeamUserGroups in interface UserGroupLocalService

getTeamUserGroupsCount

public int getTeamUserGroupsCount(long teamId)
Specified by:
getTeamUserGroupsCount in interface UserGroupLocalService

getUserGroup

public UserGroup getUserGroup(long companyId,
                              String name)
                       throws PortalException
Returns the user group with the name.

Specified by:
getUserGroup in interface UserGroupLocalService
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

public UserGroup getUserGroup(long userGroupId)
                       throws PortalException
Returns the user group with the primary key.

Specified by:
getUserGroup in interface UserGroupLocalService
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

public UserGroup getUserGroupByUuidAndCompanyId(String uuid,
                                                long companyId)
                                         throws PortalException
Returns the user group with the matching UUID and company.

Specified by:
getUserGroupByUuidAndCompanyId in interface UserGroupLocalService
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 List<UserGroup> getUserGroups(long companyId)
Returns all the user groups belonging to the company.

Specified by:
getUserGroups in interface UserGroupLocalService
Parameters:
companyId - the primary key of the user groups' company
Returns:
the user groups belonging to the company

getUserGroups

public 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.

Specified by:
getUserGroups in interface UserGroupLocalService
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 List<UserGroup> getUserGroups(long[] userGroupIds)
                              throws PortalException
Returns all the user groups with the primary keys.

Specified by:
getUserGroups in interface UserGroupLocalService
Parameters:
userGroupIds - the primary keys of the user groups
Returns:
the user groups with the primary keys
Throws:
PortalException

getUserGroupsCount

public int getUserGroupsCount()
Returns the number of user groups.

Specified by:
getUserGroupsCount in interface UserGroupLocalService
Returns:
the number of user groups

getUserPrimaryKeys

public long[] getUserPrimaryKeys(long userGroupId)
Returns the userIds of the users associated with the user group.

Specified by:
getUserPrimaryKeys in interface UserGroupLocalService
Parameters:
userGroupId - the userGroupId of the user group
Returns:
long[] the userIds of users associated with the user group

getUserUserGroups

public List<UserGroup> getUserUserGroups(long userId)
Specified by:
getUserUserGroups in interface UserGroupLocalService

getUserUserGroups

public List<UserGroup> getUserUserGroups(long userId,
                                         int start,
                                         int end)
Specified by:
getUserUserGroups in interface UserGroupLocalService

getUserUserGroups

public List<UserGroup> getUserUserGroups(long userId,
                                         int start,
                                         int end,
                                         OrderByComparator<UserGroup> orderByComparator)
Specified by:
getUserUserGroups in interface UserGroupLocalService

getUserUserGroupsCount

public int getUserUserGroupsCount(long userId)
Specified by:
getUserUserGroupsCount in interface UserGroupLocalService

hasGroupUserGroup

public boolean hasGroupUserGroup(long groupId,
                                 long userGroupId)
Specified by:
hasGroupUserGroup in interface UserGroupLocalService

hasGroupUserGroups

public boolean hasGroupUserGroups(long groupId)
Specified by:
hasGroupUserGroups in interface UserGroupLocalService

hasTeamUserGroup

public boolean hasTeamUserGroup(long teamId,
                                long userGroupId)
Specified by:
hasTeamUserGroup in interface UserGroupLocalService

hasTeamUserGroups

public boolean hasTeamUserGroups(long teamId)
Specified by:
hasTeamUserGroups in interface UserGroupLocalService

hasUserUserGroup

public boolean hasUserUserGroup(long userId,
                                long userGroupId)
Specified by:
hasUserUserGroup in interface UserGroupLocalService

hasUserUserGroups

public boolean hasUserUserGroups(long userId)
Specified by:
hasUserUserGroups in interface UserGroupLocalService

search

public 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.

Specified by:
search in interface UserGroupLocalService
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 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.

Specified by:
search in interface UserGroupLocalService
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

public 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.

Specified by:
search in interface UserGroupLocalService
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 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.

Specified by:
search in interface UserGroupLocalService
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

public int searchCount(long companyId,
                       String keywords,
                       LinkedHashMap<String,Object> params)
Returns the number of user groups that match the keywords

Specified by:
searchCount in interface UserGroupLocalService
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 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.

Specified by:
searchCount in interface UserGroupLocalService
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 BaseModelSearchResult<UserGroup> searchUserGroups(long companyId,
                                                         String keywords,
                                                         LinkedHashMap<String,Object> params,
                                                         int start,
                                                         int end,
                                                         Sort sort)
                                                  throws PortalException
Specified by:
searchUserGroups in interface UserGroupLocalService
Throws:
PortalException

searchUserGroups

public BaseModelSearchResult<UserGroup> searchUserGroups(long companyId,
                                                         String name,
                                                         String description,
                                                         LinkedHashMap<String,Object> params,
                                                         boolean andSearch,
                                                         int start,
                                                         int end,
                                                         Sort sort)
                                                  throws PortalException
Specified by:
searchUserGroups in interface UserGroupLocalService
Throws:
PortalException

setGroupUserGroups

public void setGroupUserGroups(long groupId,
                               long[] userGroupIds)
Specified by:
setGroupUserGroups in interface UserGroupLocalService

setTeamUserGroups

public void setTeamUserGroups(long teamId,
                              long[] userGroupIds)
Specified by:
setTeamUserGroups in interface UserGroupLocalService

setUserUserGroups

public void setUserUserGroups(long userId,
                              long[] userGroupIds)
                       throws PortalException
Specified by:
setUserUserGroups in interface UserGroupLocalService
Throws:
PortalException

unsetGroupUserGroups

public void unsetGroupUserGroups(long groupId,
                                 long[] userGroupIds)
Removes the user groups from the group.

Specified by:
unsetGroupUserGroups in interface UserGroupLocalService
Parameters:
groupId - the primary key of the group
userGroupIds - the primary keys of the user groups

unsetTeamUserGroups

public void unsetTeamUserGroups(long teamId,
                                long[] userGroupIds)
Removes the user groups from the team.

Specified by:
unsetTeamUserGroups in interface UserGroupLocalService
Parameters:
teamId - the primary key of the team
userGroupIds - the primary keys of the user groups

updateUserGroup

@Deprecated
public 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.

Specified by:
updateUserGroup in interface UserGroupLocalService
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

public UserGroup updateUserGroup(long companyId,
                                 long userGroupId,
                                 String name,
                                 String description,
                                 ServiceContext serviceContext)
                          throws PortalException
Updates the user group.

Specified by:
updateUserGroup in interface UserGroupLocalService
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 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.

Specified by:
updateUserGroup in interface UserGroupLocalService
Parameters:
userGroup - the user group
Returns:
the user group that was updated

getWrappedService

public UserGroupLocalService getWrappedService()
Specified by:
getWrappedService in interface ServiceWrapper<UserGroupLocalService>

setWrappedService

public void setWrappedService(UserGroupLocalService userGroupLocalService)
Specified by:
setWrappedService in interface ServiceWrapper<UserGroupLocalService>

Liferay 7.0-ce-b4