com.liferay.portal.service.impl

Class UserGroupServiceImpl

Object

com.liferay.portal.kernel.service.BaseServiceImpl

com.liferay.portal.service.base.UserGroupServiceBaseImpl

com.liferay.portal.service.impl.UserGroupServiceImpl

All Implemented Interfaces:

com.liferay.portal.kernel.module.framework.service.IdentifiableOSGiService, com.liferay.portal.kernel.service.BaseService, com.liferay.portal.kernel.service.UserGroupService

public class UserGroupServiceImpl
extends UserGroupServiceBaseImpl

Provides the remote service for accessing, adding, deleting, and updating user groups. Its methods include permission checks.

Author:

Charles May

Field Summary

Fields inherited from class com.liferay.portal.service.base.UserGroupServiceBaseImpl

counterLocalService, groupPersistence, teamPersistence, userGroupFinder, userGroupLocalService, userGroupPersistence, userGroupService, userPersistence

Fields inherited from class com.liferay.portal.kernel.service.BaseServiceImpl

ANONYMOUS_NAMES, JRUN_ANONYMOUS, ORACLE_ANONYMOUS, SUN_ANONYMOUS, WEBLOGIC_ANONYMOUS

Constructor Summary

Constructors

Constructor and Description
UserGroupServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	addGroupUserGroups(long groupId, long[] userGroupIds) Adds the user groups to the group.
com.liferay.portal.kernel.model.UserGroup	addOrUpdateUserGroup(String externalReferenceCode, String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext)
void	addTeamUserGroups(long teamId, long[] userGroupIds) Adds the user groups to the team
com.liferay.portal.kernel.model.UserGroup	addUserGroup(String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a user group.
void	deleteUserGroup(long userGroupId) Deletes the user group.
com.liferay.portal.kernel.model.UserGroup	fetchUserGroup(long userGroupId) Fetches the user group with the primary key.
com.liferay.portal.kernel.model.UserGroup	fetchUserGroupByExternalReferenceCode(long companyId, String externalReferenceCode)
protected List<com.liferay.portal.kernel.model.UserGroup>	filterUserGroups(List<com.liferay.portal.kernel.model.UserGroup> userGroups)
List<com.liferay.portal.kernel.model.UserGroup>	getGtUserGroups(long gtUserGroupId, long companyId, long parentUserGroupId, int size)
com.liferay.portal.kernel.model.UserGroup	getUserGroup(long userGroupId) Returns the user group with the primary key.
com.liferay.portal.kernel.model.UserGroup	getUserGroup(String name) Returns the user group with the name.
List<com.liferay.portal.kernel.model.UserGroup>	getUserGroups(long companyId)
List<com.liferay.portal.kernel.model.UserGroup>	getUserGroups(long companyId, String name, int start, int end)
int	getUserGroupsCount(long companyId, String name)
List<com.liferay.portal.kernel.model.UserGroup>	getUserUserGroups(long userId) Returns all the user groups to which the user belongs.
protected boolean	isUseCustomSQL(LinkedHashMap<String,Object> params)
List<com.liferay.portal.kernel.model.UserGroup>	search(long companyId, String keywords, LinkedHashMap<String,Object> params, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.UserGroup> orderByComparator) Returns an ordered range of all the user groups that match the keywords.
List<com.liferay.portal.kernel.model.UserGroup>	search(long companyId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.UserGroup> orderByComparator) 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.
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.
com.liferay.portal.kernel.model.UserGroup	updateExternalReferenceCode(com.liferay.portal.kernel.model.UserGroup userGroup, String externalReferenceCode)
com.liferay.portal.kernel.model.UserGroup	updateUserGroup(long userGroupId, String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the user group.

Methods inherited from class com.liferay.portal.service.base.UserGroupServiceBaseImpl

afterPropertiesSet, destroy, getCounterLocalService, getModelClass, getModelClassName, getOSGiServiceIdentifier, getUserGroupFinder, getUserGroupLocalService, getUserGroupPersistence, getUserGroupService, runSQL, setCounterLocalService, setUserGroupFinder, setUserGroupLocalService, setUserGroupPersistence, setUserGroupService

Methods inherited from class com.liferay.portal.kernel.service.BaseServiceImpl

getClassLoader, getGuestOrUser, getGuestOrUserId, getPermissionChecker, getUser, getUserId

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserGroupServiceImpl

public UserGroupServiceImpl()

Method Detail

addGroupUserGroups

public void addGroupUserGroups(long groupId,
                               long[] userGroupIds)
                        throws com.liferay.portal.kernel.exception.PortalException

Adds the user groups to the group.

Parameters:

groupId - the primary key of the group

userGroupIds - the primary keys of the user groups

Throws:

com.liferay.portal.kernel.exception.PortalException

addOrUpdateUserGroup

public com.liferay.portal.kernel.model.UserGroup addOrUpdateUserGroup(String externalReferenceCode,
                                                                      String name,
                                                                      String description,
                                                                      com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                               throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addTeamUserGroups

public void addTeamUserGroups(long teamId,
                              long[] userGroupIds)
                       throws com.liferay.portal.kernel.exception.PortalException

Adds the user groups to the team

Parameters:

teamId - the primary key of the team

userGroupIds - the primary keys of the user groups

Throws:

com.liferay.portal.kernel.exception.PortalException

addUserGroup

public com.liferay.portal.kernel.model.UserGroup addUserGroup(String name,
                                                              String description,
                                                              com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                       throws com.liferay.portal.kernel.exception.PortalException

Adds a user group.

This method handles the creation and bookkeeping of the user group, including its resources, metadata, and internal data structures.

Parameters:

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:

com.liferay.portal.kernel.exception.PortalException

deleteUserGroup

public void deleteUserGroup(long userGroupId)
                     throws com.liferay.portal.kernel.exception.PortalException

Deletes the user group.

Parameters:

userGroupId - the primary key of the user group

Throws:

com.liferay.portal.kernel.exception.PortalException

fetchUserGroup

public com.liferay.portal.kernel.model.UserGroup fetchUserGroup(long userGroupId)
                                                         throws com.liferay.portal.kernel.exception.PortalException

Fetches the user group with the primary key.

Parameters:

userGroupId - the primary key of the user group

Returns:

the user group with the primary key

Throws:

com.liferay.portal.kernel.exception.PortalException

fetchUserGroupByExternalReferenceCode

public com.liferay.portal.kernel.model.UserGroup fetchUserGroupByExternalReferenceCode(long companyId,
                                                                                       String externalReferenceCode)
                                                                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getGtUserGroups

public List<com.liferay.portal.kernel.model.UserGroup> getGtUserGroups(long gtUserGroupId,
                                                                       long companyId,
                                                                       long parentUserGroupId,
                                                                       int size)

getUserGroup

public com.liferay.portal.kernel.model.UserGroup getUserGroup(long userGroupId)
                                                       throws com.liferay.portal.kernel.exception.PortalException

Returns the user group with the primary key.

Parameters:

userGroupId - the primary key of the user group

Returns:

the user group with the primary key

Throws:

com.liferay.portal.kernel.exception.PortalException

getUserGroup

public com.liferay.portal.kernel.model.UserGroup getUserGroup(String name)
                                                       throws com.liferay.portal.kernel.exception.PortalException

Returns the user group with the name.

Parameters:

name - the user group's name

Returns:

the user group with the name

Throws:

com.liferay.portal.kernel.exception.PortalException

getUserGroups

public List<com.liferay.portal.kernel.model.UserGroup> getUserGroups(long companyId)
                                                              throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getUserGroups

public List<com.liferay.portal.kernel.model.UserGroup> getUserGroups(long companyId,
                                                                     String name,
                                                                     int start,
                                                                     int end)

getUserGroupsCount

public int getUserGroupsCount(long companyId,
                              String name)

getUserUserGroups

public List<com.liferay.portal.kernel.model.UserGroup> getUserUserGroups(long userId)
                                                                  throws com.liferay.portal.kernel.exception.PortalException

Returns all the user groups to which the user belongs.

Parameters:

userId - the primary key of the user

Returns:

the user groups to which the user belongs

Throws:

com.liferay.portal.kernel.exception.PortalException

search

public List<com.liferay.portal.kernel.model.UserGroup> search(long companyId,
                                                              String keywords,
                                                              LinkedHashMap<String,Object> params,
                                                              int start,
                                                              int end,
                                                              com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.UserGroup> orderByComparator)

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)

orderByComparator - the comparator to order the user groups (optionally null)

Returns:

the matching user groups ordered by comparator orderByComparator

See Also:

UserGroupFinder

search

public List<com.liferay.portal.kernel.model.UserGroup> search(long companyId,
                                                              String name,
                                                              String description,
                                                              LinkedHashMap<String,Object> params,
                                                              boolean andOperator,
                                                              int start,
                                                              int end,
                                                              com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.UserGroup> orderByComparator)

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)

orderByComparator - the comparator to order the user groups (optionally null)

Returns:

the matching user groups ordered by comparator orderByComparator

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

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.

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

unsetGroupUserGroups

public void unsetGroupUserGroups(long groupId,
                                 long[] userGroupIds)
                          throws com.liferay.portal.kernel.exception.PortalException

Removes the user groups from the group.

Parameters:

groupId - the primary key of the group

userGroupIds - the primary keys of the user groups

Throws:

com.liferay.portal.kernel.exception.PortalException

unsetTeamUserGroups

public void unsetTeamUserGroups(long teamId,
                                long[] userGroupIds)
                         throws com.liferay.portal.kernel.exception.PortalException

Removes the user groups from the team.

Parameters:

teamId - the primary key of the team

userGroupIds - the primary keys of the user groups

Throws:

com.liferay.portal.kernel.exception.PortalException

updateExternalReferenceCode

public com.liferay.portal.kernel.model.UserGroup updateExternalReferenceCode(com.liferay.portal.kernel.model.UserGroup userGroup,
                                                                             String externalReferenceCode)
                                                                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateUserGroup

public com.liferay.portal.kernel.model.UserGroup updateUserGroup(long userGroupId,
                                                                 String name,
                                                                 String description,
                                                                 com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                          throws com.liferay.portal.kernel.exception.PortalException

Updates the user group.

Parameters:

userGroupId - the primary key of the user group

name - the user group's name

description - the 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:

com.liferay.portal.kernel.exception.PortalException

filterUserGroups

protected List<com.liferay.portal.kernel.model.UserGroup> filterUserGroups(List<com.liferay.portal.kernel.model.UserGroup> userGroups)
                                                                    throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

isUseCustomSQL

protected boolean isUseCustomSQL(LinkedHashMap<String,Object> params)

See Also:

UserGroupLocalServiceImpl.isUseCustomSQL(java.util.LinkedHashMap<java.lang.String, java.lang.Object>)