Liferay 6.0.5

com.liferay.portal.service
Class UserGroupLocalServiceUtil

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

public class UserGroupLocalServiceUtil
extends Object

The utility for the user group local service. This utility wraps UserGroupLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

Never modify this class directly. Add custom service methods to UserGroupLocalServiceImpl and rerun ServiceBuilder to regenerate this class.

This is a local service. 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 is generated.

Constructor Summary
UserGroupLocalServiceUtil()
           
 
Method Summary
static void addGroupUserGroups(long groupId, long[] userGroupIds)
           
static UserGroup addUserGroup(long userId, long companyId, String name, String description)
           
static UserGroup addUserGroup(UserGroup userGroup)
          Adds the user group to the database.
static void clearUserUserGroups(long userId)
           
static void copyUserGroupLayouts(long[] userGroupIds, long userId)
           
static void copyUserGroupLayouts(long userGroupId, long userId)
           
static void copyUserGroupLayouts(long userGroupId, long[] userIds)
           
static UserGroup createUserGroup(long userGroupId)
          Creates a new user group with the primary key.
static void deleteUserGroup(long userGroupId)
          Deletes the user group with the primary key from the database.
static void deleteUserGroup(UserGroup userGroup)
          Deletes the user group from the database.
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)
          Counts the number of rows that match the dynamic query.
static UserGroupLocalService getService()
           
static UserGroup getUserGroup(long userGroupId)
          Gets the user group with the primary key.
static UserGroup getUserGroup(long companyId, String name)
           
static List<UserGroup> getUserGroups(int start, int end)
          Gets a range of all the user groups.
static List<UserGroup> getUserGroups(long companyId)
           
static List<UserGroup> getUserGroups(long[] userGroupIds)
           
static int getUserGroupsCount()
          Gets the number of user groups.
static List<UserGroup> getUserUserGroups(long userId)
           
static boolean hasGroupUserGroup(long groupId, long userGroupId)
           
static List<UserGroup> search(long companyId, String name, String description, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator obc)
           
static int searchCount(long companyId, String name, String description, LinkedHashMap<String,Object> params)
           
 void setService(UserGroupLocalService service)
           
static void setUserUserGroups(long userId, long[] userGroupIds)
           
static void unsetGroupUserGroups(long groupId, long[] userGroupIds)
           
static UserGroup updateUserGroup(long companyId, long userGroupId, String name, String description)
           
static UserGroup updateUserGroup(UserGroup userGroup)
          Updates the user group in the database.
static UserGroup updateUserGroup(UserGroup userGroup, boolean merge)
          Updates the user group in the database.
 
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 to add
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 void 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 to delete
Throws:
PortalException - if a user group with the primary key could not be found
SystemException - if a system exception occurred

deleteUserGroup

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

Parameters:
userGroup - the user group to delete
Throws:
SystemException - if a system exception occurred

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 to search with
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.

Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (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.

Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

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

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

getUserGroup

public static UserGroup getUserGroup(long userGroupId)
                              throws PortalException,
                                     SystemException
Gets the user group with the primary key.

Parameters:
userGroupId - the primary key of the user group to get
Returns:
the user group
Throws:
PortalException - if a user group with the primary key could not be found
SystemException - if a system exception occurred

getUserGroups

public static List<UserGroup> getUserGroups(int start,
                                            int end)
                                     throws SystemException
Gets 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.

Parameters:
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)
Returns:
the range of user groups
Throws:
SystemException - if a system exception occurred

getUserGroupsCount

public static int getUserGroupsCount()
                              throws SystemException
Gets 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. Also notifies the appropriate model listeners.

Parameters:
userGroup - the user group to update
Returns:
the user group that was updated
Throws:
SystemException - if a system exception occurred

updateUserGroup

public static UserGroup updateUserGroup(UserGroup userGroup,
                                        boolean merge)
                                 throws SystemException
Updates the user group in the database. Also notifies the appropriate model listeners.

Parameters:
userGroup - the user group to update
merge - whether to merge the user group with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the user group that was updated
Throws:
SystemException - if a system exception occurred

addGroupUserGroups

public static void addGroupUserGroups(long groupId,
                                      long[] userGroupIds)
                               throws SystemException
Throws:
SystemException

addUserGroup

public static UserGroup addUserGroup(long userId,
                                     long companyId,
                                     String name,
                                     String description)
                              throws PortalException,
                                     SystemException
Throws:
PortalException
SystemException

clearUserUserGroups

public static void clearUserUserGroups(long userId)
                                throws SystemException
Throws:
SystemException

copyUserGroupLayouts

public static void copyUserGroupLayouts(long userGroupId,
                                        long[] userIds)
                                 throws PortalException,
                                        SystemException
Throws:
PortalException
SystemException

copyUserGroupLayouts

public static void copyUserGroupLayouts(long[] userGroupIds,
                                        long userId)
                                 throws PortalException,
                                        SystemException
Throws:
PortalException
SystemException

copyUserGroupLayouts

public static void copyUserGroupLayouts(long userGroupId,
                                        long userId)
                                 throws PortalException,
                                        SystemException
Throws:
PortalException
SystemException

getUserGroup

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

getUserGroups

public static List<UserGroup> getUserGroups(long companyId)
                                     throws SystemException
Throws:
SystemException

getUserGroups

public static List<UserGroup> getUserGroups(long[] userGroupIds)
                                     throws PortalException,
                                            SystemException
Throws:
PortalException
SystemException

getUserUserGroups

public static List<UserGroup> getUserUserGroups(long userId)
                                         throws SystemException
Throws:
SystemException

hasGroupUserGroup

public static boolean hasGroupUserGroup(long groupId,
                                        long userGroupId)
                                 throws SystemException
Throws:
SystemException

search

public static List<UserGroup> search(long companyId,
                                     String name,
                                     String description,
                                     LinkedHashMap<String,Object> params,
                                     int start,
                                     int end,
                                     OrderByComparator obc)
                              throws SystemException
Throws:
SystemException

searchCount

public static int searchCount(long companyId,
                              String name,
                              String description,
                              LinkedHashMap<String,Object> params)
                       throws SystemException
Throws:
SystemException

setUserUserGroups

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

unsetGroupUserGroups

public static void unsetGroupUserGroups(long groupId,
                                        long[] userGroupIds)
                                 throws SystemException
Throws:
SystemException

updateUserGroup

public static UserGroup updateUserGroup(long companyId,
                                        long userGroupId,
                                        String name,
                                        String description)
                                 throws PortalException,
                                        SystemException
Throws:
PortalException
SystemException

getService

public static UserGroupLocalService getService()

setService

public void setService(UserGroupLocalService service)

Liferay 6.0.5