Class UserGroupLocalServiceImpl

Object
com.liferay.portal.kernel.service.BaseLocalServiceImpl
com.liferay.portal.service.base.UserGroupLocalServiceBaseImpl
com.liferay.portal.service.impl.UserGroupLocalServiceImpl
All Implemented Interfaces:
com.liferay.portal.kernel.module.framework.service.IdentifiableOSGiService, com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.change.tracking.CTService<com.liferay.portal.kernel.model.UserGroup>, com.liferay.portal.kernel.service.PersistedModelLocalService, com.liferay.portal.kernel.service.UserGroupLocalService

public class UserGroupLocalServiceImpl extends UserGroupLocalServiceBaseImpl
Provides the local service for accessing, adding, deleting, and updating user groups.
Author:
Charles May
  • Constructor Details

    • UserGroupLocalServiceImpl

      public UserGroupLocalServiceImpl()
  • Method Details

    • addGroupUserGroup

      public boolean addGroupUserGroup(long groupId, long userGroupId)
      Adds the user group to the group.
      Specified by:
      addGroupUserGroup in interface com.liferay.portal.kernel.service.UserGroupLocalService
      Overrides:
      addGroupUserGroup in class UserGroupLocalServiceBaseImpl
      Parameters:
      groupId - the primary key of the group
      userGroupId - the primary key of the user group
      Returns:
      true if the association between the ${groupId} and ${userGroupId} is added; false if it was already added
    • addGroupUserGroup

      public boolean addGroupUserGroup(long groupId, com.liferay.portal.kernel.model.UserGroup userGroup)
      Adds the user group to the group.
      Specified by:
      addGroupUserGroup in interface com.liferay.portal.kernel.service.UserGroupLocalService
      Overrides:
      addGroupUserGroup in class UserGroupLocalServiceBaseImpl
      Parameters:
      groupId - the primary key of the group
      userGroup - the user group
      Returns:
      true if the association between the ${groupId} and ${userGroup} is added; false if it was already added
    • addGroupUserGroups

      public boolean addGroupUserGroups(long groupId, List<com.liferay.portal.kernel.model.UserGroup> userGroups)
      Adds the user groups to the group.
      Specified by:
      addGroupUserGroups in interface com.liferay.portal.kernel.service.UserGroupLocalService
      Overrides:
      addGroupUserGroups in class UserGroupLocalServiceBaseImpl
      Parameters:
      groupId - the primary key of the group
      userGroups - the user groups
      Returns:
      true if at least an association between the ${groupId} and the ${userGroups} is added; false if all were already added
    • addGroupUserGroups

      public boolean addGroupUserGroups(long groupId, long[] userGroupIds)
      Adds the user groups to the group.
      Specified by:
      addGroupUserGroups in interface com.liferay.portal.kernel.service.UserGroupLocalService
      Overrides:
      addGroupUserGroups in class UserGroupLocalServiceBaseImpl
      Parameters:
      groupId - the primary key of the group
      userGroupIds - the primary keys of the user groups
      Returns:
      true if at least an association between the ${groupId} and the ${userGroupIds} is added; false if all were already added
    • addOrUpdateUserGroup

      public com.liferay.portal.kernel.model.UserGroup addOrUpdateUserGroup(String externalReferenceCode, long userId, long companyId, 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
    • addTeamUserGroup

      public boolean addTeamUserGroup(long teamId, com.liferay.portal.kernel.model.UserGroup userGroup)
      Specified by:
      addTeamUserGroup in interface com.liferay.portal.kernel.service.UserGroupLocalService
      Overrides:
      addTeamUserGroup in class UserGroupLocalServiceBaseImpl
    • addTeamUserGroups

      public boolean addTeamUserGroups(long teamId, long[] userGroupIds)
      Specified by:
      addTeamUserGroups in interface com.liferay.portal.kernel.service.UserGroupLocalService
      Overrides:
      addTeamUserGroups in class UserGroupLocalServiceBaseImpl
    • addUserGroup

      public com.liferay.portal.kernel.model.UserGroup addUserGroup(long userId, long companyId, 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. 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:
      com.liferay.portal.kernel.exception.PortalException
    • addUserUserGroup

      public boolean addUserUserGroup(long userId, long userGroupId) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      addUserUserGroup in interface com.liferay.portal.kernel.service.UserGroupLocalService
      Overrides:
      addUserUserGroup in class UserGroupLocalServiceBaseImpl
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addUserUserGroup

      public boolean addUserUserGroup(long userId, com.liferay.portal.kernel.model.UserGroup userGroup) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      addUserUserGroup in interface com.liferay.portal.kernel.service.UserGroupLocalService
      Overrides:
      addUserUserGroup in class UserGroupLocalServiceBaseImpl
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addUserUserGroups

      public boolean addUserUserGroups(long userId, List<com.liferay.portal.kernel.model.UserGroup> userGroups) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      addUserUserGroups in interface com.liferay.portal.kernel.service.UserGroupLocalService
      Overrides:
      addUserUserGroups in class UserGroupLocalServiceBaseImpl
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addUserUserGroups

      public boolean addUserUserGroups(long userId, long[] userGroupIds) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      addUserUserGroups in interface com.liferay.portal.kernel.service.UserGroupLocalService
      Overrides:
      addUserUserGroups in class UserGroupLocalServiceBaseImpl
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteUserGroup

      public com.liferay.portal.kernel.model.UserGroup deleteUserGroup(long userGroupId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the user group.
      Specified by:
      deleteUserGroup in interface com.liferay.portal.kernel.service.UserGroupLocalService
      Overrides:
      deleteUserGroup in class UserGroupLocalServiceBaseImpl
      Parameters:
      userGroupId - the primary key of the user group
      Returns:
      the deleted user group
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a user group with the primary key could not be found
    • deleteUserGroup

      @SystemEvent(action=1, type=1) public com.liferay.portal.kernel.model.UserGroup deleteUserGroup(com.liferay.portal.kernel.model.UserGroup userGroup) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the user group.
      Specified by:
      deleteUserGroup in interface com.liferay.portal.kernel.service.UserGroupLocalService
      Overrides:
      deleteUserGroup in class UserGroupLocalServiceBaseImpl
      Parameters:
      userGroup - the user group
      Returns:
      the deleted user group
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteUserGroups

      public void deleteUserGroups(long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • fetchUserGroup

      public com.liferay.portal.kernel.model.UserGroup fetchUserGroup(long companyId, String name)
    • getGroupUserUserGroups

      public List<com.liferay.portal.kernel.model.UserGroup> getGroupUserUserGroups(long groupId, long userId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getUserGroup

      public com.liferay.portal.kernel.model.UserGroup getUserGroup(long companyId, String name) throws com.liferay.portal.kernel.exception.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:
      com.liferay.portal.kernel.exception.PortalException
    • getUserGroups

      public List<com.liferay.portal.kernel.model.UserGroup> getUserGroups(long companyId)
      Returns all the user groups belonging to the company.
      Parameters:
      companyId - the primary key of the user groups' company
      Returns:
      the user groups belonging to the company
    • getUserGroups

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

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

      public List<com.liferay.portal.kernel.model.UserGroup> getUserGroups(long[] userGroupIds) throws com.liferay.portal.kernel.exception.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:
      com.liferay.portal.kernel.exception.PortalException
    • getUserGroupsCount

      public int getUserGroupsCount(long companyId, String name)
    • 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 com.liferay.portal.kernel.search.Hits search(long companyId, String keywords, LinkedHashMap<String,Object> params, int start, int end, com.liferay.portal.kernel.search.Sort sort)
      Returns an ordered range of all the user groups that match the keywords, using the indexer. It is preferable to use this method instead of the non-indexed version whenever possible for performance reasons.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

      Parameters:
      companyId - the primary key of the user group's company
      keywords - the keywords (space separated), which may occur in the user group's name or description (optionally null)
      params - the finder params (optionally null). For more information see com.liferay.user.groups.admin.web.search.UserGroupIndexer
      start - the lower bound of the range of user groups to return
      end - the upper bound of the range of user groups to return (not inclusive)
      sort - the field and direction by which to sort (optionally null)
      Returns:
      the matching user groups ordered by sort
      See Also:
      • com.liferay.user.groups.admin.web.search.UserGroupIndexer
    • search

      public 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
    • search

      public com.liferay.portal.kernel.search.Hits search(long companyId, String name, String description, LinkedHashMap<String,Object> params, boolean andSearch, int start, int end, com.liferay.portal.kernel.search.Sort sort)
      Returns an ordered range of all the user groups that match the name and description. It is preferable to use this method instead of the non-indexed version whenever possible for performance reasons.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

      Parameters:
      companyId - the primary key of the user group's company
      name - the user group's name (optionally null)
      description - the user group's description (optionally null)
      params - the finder params (optionally null). For more information see com.liferay.user.groups.admin.web.search.UserGroupIndexer
      andSearch - whether every field must match its keywords or just one field
      start - the lower bound of the range of user groups to return
      end - the upper bound of the range of user groups to return (not inclusive)
      sort - the field and direction by which to sort (optionally null)
      Returns:
      the matching user groups ordered by sort
      See Also:
      • UserGroupFinder
    • searchCount

      public 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
    • searchUserGroups

      public com.liferay.portal.kernel.search.BaseModelSearchResult<com.liferay.portal.kernel.model.UserGroup> searchUserGroups(long companyId, String keywords, LinkedHashMap<String,Object> params, int start, int end, com.liferay.portal.kernel.search.Sort sort) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • searchUserGroups

      public com.liferay.portal.kernel.search.BaseModelSearchResult<com.liferay.portal.kernel.model.UserGroup> searchUserGroups(long companyId, String name, String description, LinkedHashMap<String,Object> params, boolean andSearch, int start, int end, com.liferay.portal.kernel.search.Sort sort) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • setUserUserGroups

      public void setUserUserGroups(long userId, long[] userGroupIds) throws com.liferay.portal.kernel.exception.PortalException
      Sets the user groups associated with the user copying the user group layouts and removing and adding user group associations for the user as necessary.
      Specified by:
      setUserUserGroups in interface com.liferay.portal.kernel.service.UserGroupLocalService
      Overrides:
      setUserUserGroups in class UserGroupLocalServiceBaseImpl
      Parameters:
      userId - the primary key of the user
      userGroupIds - the primary keys of the user groups
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • unsetGroupUserGroups

      public void unsetGroupUserGroups(long groupId, long[] userGroupIds)
      Removes the user groups from the group.
      Parameters:
      groupId - the primary key of the group
      userGroupIds - the primary keys of the user groups
    • unsetTeamUserGroups

      public 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
    • updateExternalReferenceCode

      @Indexable(type=REINDEX) 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 companyId, 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:
      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:
      com.liferay.portal.kernel.exception.PortalException
    • buildSearchContext

      protected com.liferay.portal.kernel.search.SearchContext buildSearchContext(long companyId, String name, String description, LinkedHashMap<String,Object> params, boolean andSearch, int start, int end, com.liferay.portal.kernel.search.Sort sort)
    • exportLayouts

      protected File[] exportLayouts(long userGroupId, Map<String,String[]> parameterMap) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getLayoutTemplatesParameters

      protected Map<String,String[]> getLayoutTemplatesParameters()
    • importLayouts

      protected void importLayouts(long userId, Map<String,String[]> parameterMap, File privateLayoutsFile, File publicLayoutsFile) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • isUseCustomSQL

      protected boolean isUseCustomSQL(LinkedHashMap<String,Object> params)
      See Also:
    • reindex

      protected void reindex(long companyId, long[] userIds) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • reindexUserGroup

      protected void reindexUserGroup(com.liferay.portal.kernel.model.UserGroup userGroup) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • reindexUsers

      protected void reindexUsers(List<com.liferay.portal.kernel.model.UserGroup> userGroups) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • reindexUsers

      protected void reindexUsers(long userGroupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • reindexUsers

      protected void reindexUsers(long[] userGroupIds) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • reindexUsers

      protected void reindexUsers(com.liferay.portal.kernel.model.UserGroup userGroup) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • validate

      protected void validate(long userGroupId, long companyId, String name) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException