Liferay 6.2-ce-ga5

com.liferay.portal.service
Class UserGroupLocalServiceUtil

java.lang.Object
  extended by com.liferay.portal.service.UserGroupLocalServiceUtil

@ProviderType
public class UserGroupLocalServiceUtil
extends Object

Provides the local service utility for UserGroup. This utility wraps UserGroupLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

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

Constructor Summary
UserGroupLocalServiceUtil()
           
 
Method Summary
static void addGroupUserGroup(long groupId, long userGroupId)
           
static void addGroupUserGroup(long groupId, UserGroup userGroup)
           
static void addGroupUserGroups(long groupId, List<UserGroup> UserGroups)
           
static void addGroupUserGroups(long groupId, long[] userGroupIds)
           
static void addTeamUserGroup(long teamId, long userGroupId)
           
static void addTeamUserGroup(long teamId, UserGroup userGroup)
           
static void addTeamUserGroups(long teamId, List<UserGroup> UserGroups)
           
static void addTeamUserGroups(long teamId, long[] userGroupIds)
           
static UserGroup addUserGroup(long userId, long companyId, String name, String description)
          Deprecated. As of 6.2.0, replaced by addUserGroup(long, long, String, String, ServiceContext)
static UserGroup addUserGroup(long userId, long companyId, String name, String description, ServiceContext serviceContext)
          Adds a user group.
static UserGroup addUserGroup(UserGroup userGroup)
          Adds the user group to the database.
static void addUserUserGroup(long userId, long userGroupId)
           
static void addUserUserGroup(long userId, UserGroup userGroup)
           
static void addUserUserGroups(long userId, List<UserGroup> UserGroups)
           
static void addUserUserGroups(long userId, long[] userGroupIds)
           
static void clearGroupUserGroups(long groupId)
           
static void clearTeamUserGroups(long teamId)
           
static void clearUserUserGroups(long userId)
           
static void copyUserGroupLayouts(long[] userGroupIds, long userId)
          Deprecated. As of 6.1.0
static void copyUserGroupLayouts(long userGroupId, long userId)
          Deprecated. As of 6.2.0
static void copyUserGroupLayouts(long userGroupId, long[] userIds)
          Deprecated. As of 6.1.0
static UserGroup createUserGroup(long userGroupId)
          Creates a new user group with the primary key.
static void deleteGroupUserGroup(long groupId, long userGroupId)
           
static void deleteGroupUserGroup(long groupId, UserGroup userGroup)
           
static void deleteGroupUserGroups(long groupId, List<UserGroup> UserGroups)
           
static void deleteGroupUserGroups(long groupId, long[] userGroupIds)
           
static void deleteTeamUserGroup(long teamId, long userGroupId)
           
static void deleteTeamUserGroup(long teamId, UserGroup userGroup)
           
static void deleteTeamUserGroups(long teamId, List<UserGroup> UserGroups)
           
static void deleteTeamUserGroups(long teamId, long[] userGroupIds)
           
static UserGroup deleteUserGroup(long userGroupId)
          Deletes the user group with the primary key from the database.
static UserGroup deleteUserGroup(UserGroup userGroup)
          Deletes the user group from the database.
static void deleteUserGroups(long companyId)
           
static void deleteUserUserGroup(long userId, long userGroupId)
           
static void deleteUserUserGroup(long userId, UserGroup userGroup)
           
static void deleteUserUserGroups(long userId, List<UserGroup> UserGroups)
           
static void deleteUserUserGroups(long userId, long[] userGroupIds)
           
static DynamicQuery dynamicQuery()
           
static List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
static UserGroup fetchUserGroup(long userGroupId)
           
static UserGroup fetchUserGroup(long companyId, String name)
           
static UserGroup fetchUserGroupByUuidAndCompanyId(String uuid, long companyId)
          Returns the user group with the matching UUID and company.
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
static List<UserGroup> getGroupUserGroups(long groupId)
           
static List<UserGroup> getGroupUserGroups(long groupId, int start, int end)
           
static List<UserGroup> getGroupUserGroups(long groupId, int start, int end, OrderByComparator orderByComparator)
           
static int getGroupUserGroupsCount(long groupId)
           
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static UserGroupLocalService getService()
           
static List<UserGroup> getTeamUserGroups(long teamId)
           
static List<UserGroup> getTeamUserGroups(long teamId, int start, int end)
           
static List<UserGroup> getTeamUserGroups(long teamId, int start, int end, OrderByComparator orderByComparator)
           
static int getTeamUserGroupsCount(long teamId)
           
static UserGroup getUserGroup(long userGroupId)
          Returns the user group with the primary key.
static UserGroup getUserGroup(long companyId, String name)
          Returns the user group with the name.
static UserGroup getUserGroupByUuidAndCompanyId(String uuid, long companyId)
          Returns the user group with the matching UUID and company.
static List<UserGroup> getUserGroups(int start, int end)
          Returns a range of all the user groups.
static List<UserGroup> getUserGroups(long companyId)
          Returns all the user groups belonging to the company.
static List<UserGroup> getUserGroups(long[] userGroupIds)
          Returns all the user groups with the primary keys.
static int getUserGroupsCount()
          Returns the number of user groups.
static List<UserGroup> getUserUserGroups(long userId)
           
static List<UserGroup> getUserUserGroups(long userId, int start, int end)
           
static List<UserGroup> getUserUserGroups(long userId, int start, int end, OrderByComparator orderByComparator)
           
static int getUserUserGroupsCount(long userId)
           
static boolean hasGroupUserGroup(long groupId, long userGroupId)
           
static boolean hasGroupUserGroups(long groupId)
           
static boolean hasTeamUserGroup(long teamId, long userGroupId)
           
static boolean hasTeamUserGroups(long teamId)
           
static boolean hasUserUserGroup(long userId, long userGroupId)
           
static boolean hasUserUserGroups(long userId)
           
static List<UserGroup> search(long companyId, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator obc)
          Returns an ordered range of all the user groups that match the keywords.
static Hits search(long companyId, String keywords, LinkedHashMap<String,Object> params, int start, int end, Sort sort)
          Returns an ordered range of all the user groups that match the keywords, using the indexer.
static Hits search(long companyId, String name, String description, LinkedHashMap<String,Object> params, boolean andSearch, int start, int end, Sort sort)
          Returns an ordered range of all the user groups that match the name and description.
static int searchCount(long companyId, String keywords, LinkedHashMap<String,Object> params)
          Returns the number of user groups that match the keywords
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
static void setGroupUserGroups(long groupId, long[] userGroupIds)
           
 void setService(UserGroupLocalService service)
          Deprecated. As of 6.2.0
static void setTeamUserGroups(long teamId, long[] userGroupIds)
           
static void setUserUserGroups(long userId, long[] userGroupIds)
           
static void unsetGroupUserGroups(long groupId, long[] userGroupIds)
          Removes the user groups from the group.
static void unsetTeamUserGroups(long teamId, long[] userGroupIds)
          Removes the user groups from the team.
static UserGroup updateUserGroup(long companyId, long userGroupId, String name, String description)
          Deprecated. As of 6.2.0, replaced by updateUserGroup(long, long, String, String, ServiceContext)
static UserGroup updateUserGroup(long companyId, long userGroupId, String name, String description, ServiceContext serviceContext)
          Updates the user group.
static UserGroup updateUserGroup(UserGroup userGroup)
          Updates the user group in the database or adds it if it does not yet exist.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UserGroupLocalServiceUtil

public UserGroupLocalServiceUtil()
Method Detail

addUserGroup

public static UserGroup addUserGroup(UserGroup userGroup)
                              throws SystemException
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
Throws:
SystemException - if a system exception occurred

createUserGroup

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

Parameters:
userGroupId - the primary key for the new user group
Returns:
the new user group

deleteUserGroup

public static UserGroup deleteUserGroup(long userGroupId)
                                 throws PortalException,
                                        SystemException
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
SystemException - if a system exception occurred

deleteUserGroup

public static UserGroup deleteUserGroup(UserGroup userGroup)
                                 throws PortalException,
                                        SystemException
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
SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
                              throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchUserGroup

public static UserGroup fetchUserGroup(long userGroupId)
                                throws SystemException
Throws:
SystemException

fetchUserGroupByUuidAndCompanyId

public static UserGroup fetchUserGroupByUuidAndCompanyId(String uuid,
                                                         long companyId)
                                                  throws SystemException
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
Throws:
SystemException - if a system exception occurred

getUserGroup

public static UserGroup getUserGroup(long userGroupId)
                              throws PortalException,
                                     SystemException
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
SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
SystemException

getUserGroupByUuidAndCompanyId

public static UserGroup getUserGroupByUuidAndCompanyId(String uuid,
                                                       long companyId)
                                                throws PortalException,
                                                       SystemException
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
SystemException - if a system exception occurred

getUserGroups

public static List<UserGroup> getUserGroups(int start,
                                            int end)
                                     throws SystemException
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
Throws:
SystemException - if a system exception occurred

getUserGroupsCount

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

Returns:
the number of user groups
Throws:
SystemException - if a system exception occurred

updateUserGroup

public static UserGroup updateUserGroup(UserGroup userGroup)
                                 throws SystemException
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
Throws:
SystemException - if a system exception occurred

addGroupUserGroup

public static void addGroupUserGroup(long groupId,
                                     long userGroupId)
                              throws SystemException
Throws:
SystemException - if a system exception occurred

addGroupUserGroup

public static void addGroupUserGroup(long groupId,
                                     UserGroup userGroup)
                              throws SystemException
Throws:
SystemException - if a system exception occurred

addGroupUserGroups

public static void addGroupUserGroups(long groupId,
                                      long[] userGroupIds)
                               throws SystemException
Throws:
SystemException - if a system exception occurred

addGroupUserGroups

public static void addGroupUserGroups(long groupId,
                                      List<UserGroup> UserGroups)
                               throws SystemException
Throws:
SystemException - if a system exception occurred

clearGroupUserGroups

public static void clearGroupUserGroups(long groupId)
                                 throws SystemException
Throws:
SystemException - if a system exception occurred

deleteGroupUserGroup

public static void deleteGroupUserGroup(long groupId,
                                        long userGroupId)
                                 throws SystemException
Throws:
SystemException - if a system exception occurred

deleteGroupUserGroup

public static void deleteGroupUserGroup(long groupId,
                                        UserGroup userGroup)
                                 throws SystemException
Throws:
SystemException - if a system exception occurred

deleteGroupUserGroups

public static void deleteGroupUserGroups(long groupId,
                                         long[] userGroupIds)
                                  throws SystemException
Throws:
SystemException - if a system exception occurred

deleteGroupUserGroups

public static void deleteGroupUserGroups(long groupId,
                                         List<UserGroup> UserGroups)
                                  throws SystemException
Throws:
SystemException - if a system exception occurred

getGroupUserGroups

public static List<UserGroup> getGroupUserGroups(long groupId)
                                          throws SystemException
Throws:
SystemException - if a system exception occurred

getGroupUserGroups

public static List<UserGroup> getGroupUserGroups(long groupId,
                                                 int start,
                                                 int end)
                                          throws SystemException
Throws:
SystemException - if a system exception occurred

getGroupUserGroups

public static List<UserGroup> getGroupUserGroups(long groupId,
                                                 int start,
                                                 int end,
                                                 OrderByComparator orderByComparator)
                                          throws SystemException
Throws:
SystemException - if a system exception occurred

getGroupUserGroupsCount

public static int getGroupUserGroupsCount(long groupId)
                                   throws SystemException
Throws:
SystemException - if a system exception occurred

hasGroupUserGroup

public static boolean hasGroupUserGroup(long groupId,
                                        long userGroupId)
                                 throws SystemException
Throws:
SystemException - if a system exception occurred

hasGroupUserGroups

public static boolean hasGroupUserGroups(long groupId)
                                  throws SystemException
Throws:
SystemException - if a system exception occurred

setGroupUserGroups

public static void setGroupUserGroups(long groupId,
                                      long[] userGroupIds)
                               throws SystemException
Throws:
SystemException - if a system exception occurred

addTeamUserGroup

public static void addTeamUserGroup(long teamId,
                                    long userGroupId)
                             throws SystemException
Throws:
SystemException - if a system exception occurred

addTeamUserGroup

public static void addTeamUserGroup(long teamId,
                                    UserGroup userGroup)
                             throws SystemException
Throws:
SystemException - if a system exception occurred

addTeamUserGroups

public static void addTeamUserGroups(long teamId,
                                     long[] userGroupIds)
                              throws SystemException
Throws:
SystemException - if a system exception occurred

addTeamUserGroups

public static void addTeamUserGroups(long teamId,
                                     List<UserGroup> UserGroups)
                              throws SystemException
Throws:
SystemException - if a system exception occurred

clearTeamUserGroups

public static void clearTeamUserGroups(long teamId)
                                throws SystemException
Throws:
SystemException - if a system exception occurred

deleteTeamUserGroup

public static void deleteTeamUserGroup(long teamId,
                                       long userGroupId)
                                throws SystemException
Throws:
SystemException - if a system exception occurred

deleteTeamUserGroup

public static void deleteTeamUserGroup(long teamId,
                                       UserGroup userGroup)
                                throws SystemException
Throws:
SystemException - if a system exception occurred

deleteTeamUserGroups

public static void deleteTeamUserGroups(long teamId,
                                        long[] userGroupIds)
                                 throws SystemException
Throws:
SystemException - if a system exception occurred

deleteTeamUserGroups

public static void deleteTeamUserGroups(long teamId,
                                        List<UserGroup> UserGroups)
                                 throws SystemException
Throws:
SystemException - if a system exception occurred

getTeamUserGroups

public static List<UserGroup> getTeamUserGroups(long teamId)
                                         throws SystemException
Throws:
SystemException - if a system exception occurred

getTeamUserGroups

public static List<UserGroup> getTeamUserGroups(long teamId,
                                                int start,
                                                int end)
                                         throws SystemException
Throws:
SystemException - if a system exception occurred

getTeamUserGroups

public static List<UserGroup> getTeamUserGroups(long teamId,
                                                int start,
                                                int end,
                                                OrderByComparator orderByComparator)
                                         throws SystemException
Throws:
SystemException - if a system exception occurred

getTeamUserGroupsCount

public static int getTeamUserGroupsCount(long teamId)
                                  throws SystemException
Throws:
SystemException - if a system exception occurred

hasTeamUserGroup

public static boolean hasTeamUserGroup(long teamId,
                                       long userGroupId)
                                throws SystemException
Throws:
SystemException - if a system exception occurred

hasTeamUserGroups

public static boolean hasTeamUserGroups(long teamId)
                                 throws SystemException
Throws:
SystemException - if a system exception occurred

setTeamUserGroups

public static void setTeamUserGroups(long teamId,
                                     long[] userGroupIds)
                              throws SystemException
Throws:
SystemException - if a system exception occurred

addUserUserGroup

public static void addUserUserGroup(long userId,
                                    long userGroupId)
                             throws SystemException
Throws:
SystemException - if a system exception occurred

addUserUserGroup

public static void addUserUserGroup(long userId,
                                    UserGroup userGroup)
                             throws SystemException
Throws:
SystemException - if a system exception occurred

addUserUserGroups

public static void addUserUserGroups(long userId,
                                     long[] userGroupIds)
                              throws SystemException
Throws:
SystemException - if a system exception occurred

addUserUserGroups

public static void addUserUserGroups(long userId,
                                     List<UserGroup> UserGroups)
                              throws SystemException
Throws:
SystemException - if a system exception occurred

clearUserUserGroups

public static void clearUserUserGroups(long userId)
                                throws SystemException
Throws:
SystemException - if a system exception occurred

deleteUserUserGroup

public static void deleteUserUserGroup(long userId,
                                       long userGroupId)
                                throws SystemException
Throws:
SystemException - if a system exception occurred

deleteUserUserGroup

public static void deleteUserUserGroup(long userId,
                                       UserGroup userGroup)
                                throws SystemException
Throws:
SystemException - if a system exception occurred

deleteUserUserGroups

public static void deleteUserUserGroups(long userId,
                                        long[] userGroupIds)
                                 throws SystemException
Throws:
SystemException - if a system exception occurred

deleteUserUserGroups

public static void deleteUserUserGroups(long userId,
                                        List<UserGroup> UserGroups)
                                 throws SystemException
Throws:
SystemException - if a system exception occurred

getUserUserGroups

public static List<UserGroup> getUserUserGroups(long userId)
                                         throws SystemException
Throws:
SystemException - if a system exception occurred

getUserUserGroups

public static List<UserGroup> getUserUserGroups(long userId,
                                                int start,
                                                int end)
                                         throws SystemException
Throws:
SystemException - if a system exception occurred

getUserUserGroups

public static List<UserGroup> getUserUserGroups(long userId,
                                                int start,
                                                int end,
                                                OrderByComparator orderByComparator)
                                         throws SystemException
Throws:
SystemException - if a system exception occurred

getUserUserGroupsCount

public static int getUserUserGroupsCount(long userId)
                                  throws SystemException
Throws:
SystemException - if a system exception occurred

hasUserUserGroup

public static boolean hasUserUserGroup(long userId,
                                       long userGroupId)
                                throws SystemException
Throws:
SystemException - if a system exception occurred

hasUserUserGroups

public static boolean hasUserUserGroups(long userId)
                                 throws SystemException
Throws:
SystemException - if a system exception occurred

setUserUserGroups

public static void setUserUserGroups(long userId,
                                     long[] userGroupIds)
                              throws PortalException,
                                     SystemException
Throws:
PortalException
SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addUserGroup

public static UserGroup addUserGroup(long userId,
                                     long companyId,
                                     String name,
                                     String description)
                              throws PortalException,
                                     SystemException
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 - if the user group's information was invalid
SystemException - if a system exception occurred

addUserGroup

public static UserGroup addUserGroup(long userId,
                                     long companyId,
                                     String name,
                                     String description,
                                     ServiceContext serviceContext)
                              throws PortalException,
                                     SystemException
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 - if the user group's information was invalid
SystemException - if a system exception occurred

copyUserGroupLayouts

public static void copyUserGroupLayouts(long userGroupId,
                                        long userId)
                                 throws PortalException,
                                        SystemException
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 - if a user with the primary key could not be found or if a portal exception occurred
SystemException - if a system exception occurred

copyUserGroupLayouts

public static void copyUserGroupLayouts(long userGroupId,
                                        long[] userIds)
                                 throws PortalException,
                                        SystemException
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 - if any one of the users could not be found or if a portal exception occurred
SystemException - if a system exception occurred

copyUserGroupLayouts

public static void copyUserGroupLayouts(long[] userGroupIds,
                                        long userId)
                                 throws PortalException,
                                        SystemException
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 - if a user with the primary key could not be found or if a portal exception occurred
SystemException - if a system exception occurred

deleteUserGroups

public static void deleteUserGroups(long companyId)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

fetchUserGroup

public static UserGroup fetchUserGroup(long companyId,
                                       String name)
                                throws SystemException
Throws:
SystemException

getUserGroup

public static UserGroup getUserGroup(long companyId,
                                     String name)
                              throws PortalException,
                                     SystemException
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 - if a user group with the name could not be found
SystemException - if a system exception occurred

getUserGroups

public static List<UserGroup> getUserGroups(long companyId)
                                     throws SystemException
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
Throws:
SystemException - if a system exception occurred

getUserGroups

public static List<UserGroup> getUserGroups(long[] userGroupIds)
                                     throws PortalException,
                                            SystemException
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 - if any one of the user groups could not be found
SystemException - if a system exception occurred

search

public static List<UserGroup> search(long companyId,
                                     String keywords,
                                     LinkedHashMap<String,Object> params,
                                     int start,
                                     int end,
                                     OrderByComparator obc)
                              throws SystemException
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
Throws:
SystemException - if a system exception occurred
See Also:
UserGroupFinder

search

public static Hits search(long companyId,
                          String keywords,
                          LinkedHashMap<String,Object> params,
                          int start,
                          int end,
                          Sort sort)
                   throws SystemException
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 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
Throws:
SystemException - if a system exception occurred
See Also:
UserGroupIndexer

search

public static Hits search(long companyId,
                          String name,
                          String description,
                          LinkedHashMap<String,Object> params,
                          boolean andSearch,
                          int start,
                          int end,
                          Sort sort)
                   throws SystemException
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 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
Throws:
SystemException - if a system exception occurred
See Also:
UserGroupFinder

searchCount

public static int searchCount(long companyId,
                              String keywords,
                              LinkedHashMap<String,Object> params)
                       throws SystemException
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
Throws:
SystemException - if a system exception occurred
See Also:
UserGroupFinder

unsetGroupUserGroups

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

Parameters:
groupId - the primary key of the group
userGroupIds - the primary keys of the user groups
Throws:
SystemException - if a system exception occurred

unsetTeamUserGroups

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

Parameters:
teamId - the primary key of the team
userGroupIds - the primary keys of the user groups
Throws:
SystemException - if a system exception occurred

updateUserGroup

public static UserGroup updateUserGroup(long companyId,
                                        long userGroupId,
                                        String name,
                                        String description)
                                 throws PortalException,
                                        SystemException
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 - if a user group with the primary key could not be found or if the new information was invalid
SystemException - if a system exception occurred

updateUserGroup

public static UserGroup updateUserGroup(long companyId,
                                        long userGroupId,
                                        String name,
                                        String description,
                                        ServiceContext serviceContext)
                                 throws PortalException,
                                        SystemException
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 - if a user group with the primary key could not be found or if the new information was invalid
SystemException - if a system exception occurred

getService

public static UserGroupLocalService getService()

setService

public void setService(UserGroupLocalService service)
Deprecated. As of 6.2.0


Liferay 6.2-ce-ga5