com.liferay.portal.service
Class UserGroupRoleLocalServiceUtil

java.lang.Object
  com.liferay.portal.service.UserGroupRoleLocalServiceUtil

@ProviderType
public class UserGroupRoleLocalServiceUtil
extends Object

Provides the local service utility for UserGroupRole. This utility wraps UserGroupRoleLocalServiceImpl 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:

UserGroupRoleLocalService, UserGroupRoleLocalServiceBaseImpl, UserGroupRoleLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary

UserGroupRoleLocalServiceUtil()

Method Summary

static UserGroupRole	addUserGroupRole(UserGroupRole userGroupRole) Adds the user group role to the database.
static List<UserGroupRole>	addUserGroupRoles(long[] userIds, long groupId, long roleId)
static List<UserGroupRole>	addUserGroupRoles(long userId, long groupId, long[] roleIds)
static UserGroupRole	createUserGroupRole(UserGroupRolePK userGroupRolePK) Creates a new user group role with the primary key.
static UserGroupRole	deleteUserGroupRole(UserGroupRole userGroupRole) Deletes the user group role from the database.
static UserGroupRole	deleteUserGroupRole(UserGroupRolePK userGroupRolePK) Deletes the user group role with the primary key from the database.
static void	deleteUserGroupRoles(long[] userIds, long groupId)
static void	deleteUserGroupRoles(long[] userIds, long groupId, int roleType)
static void	deleteUserGroupRoles(long[] userIds, long groupId, long roleId)
static void	deleteUserGroupRoles(long userId, long[] groupIds)
static void	deleteUserGroupRoles(long userId, long groupId, long[] roleIds)
static void	deleteUserGroupRolesByGroupId(long groupId)
static void	deleteUserGroupRolesByRoleId(long roleId)
static void	deleteUserGroupRolesByUserId(long userId)
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 UserGroupRole	fetchUserGroupRole(UserGroupRolePK userGroupRolePK)
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static UserGroupRoleLocalService	getService()
static UserGroupRole	getUserGroupRole(UserGroupRolePK userGroupRolePK) Returns the user group role with the primary key.
static List<UserGroupRole>	getUserGroupRoles(int start, int end) Returns a range of all the user group roles.
static List<UserGroupRole>	getUserGroupRoles(long userId)
static List<UserGroupRole>	getUserGroupRoles(long userId, long groupId)
static List<UserGroupRole>	getUserGroupRolesByGroup(long groupId)
static List<UserGroupRole>	getUserGroupRolesByGroupAndRole(long groupId, long roleId)
static List<UserGroupRole>	getUserGroupRolesByUserUserGroupAndGroup(long userId, long groupId)
static int	getUserGroupRolesCount() Returns the number of user group roles.
static boolean	hasUserGroupRole(long userId, long groupId, long roleId)
static boolean	hasUserGroupRole(long userId, long groupId, long roleId, boolean inherit)
static boolean	hasUserGroupRole(long userId, long groupId, String roleName)
static boolean	hasUserGroupRole(long userId, long groupId, String roleName, boolean inherit)
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(UserGroupRoleLocalService service) Deprecated. As of 6.2.0
static UserGroupRole	updateUserGroupRole(UserGroupRole userGroupRole) Updates the user group role 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

UserGroupRoleLocalServiceUtil

public UserGroupRoleLocalServiceUtil()

Method Detail

addUserGroupRole

public static UserGroupRole addUserGroupRole(UserGroupRole userGroupRole)
                                      throws SystemException

Adds the user group role to the database. Also notifies the appropriate model listeners.

Parameters:

userGroupRole - the user group role

Returns:

the user group role that was added

Throws:

SystemException - if a system exception occurred

createUserGroupRole

public static UserGroupRole createUserGroupRole(UserGroupRolePK userGroupRolePK)

Creates a new user group role with the primary key. Does not add the user group role to the database.

Parameters:

userGroupRolePK - the primary key for the new user group role

Returns:

the new user group role

deleteUserGroupRole

public static UserGroupRole deleteUserGroupRole(UserGroupRolePK userGroupRolePK)
                                         throws PortalException,
                                                SystemException

Deletes the user group role with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

userGroupRolePK - the primary key of the user group role

Returns:

the user group role that was removed

Throws:

PortalException - if a user group role with the primary key could not be found

SystemException - if a system exception occurred

deleteUserGroupRole

public static UserGroupRole deleteUserGroupRole(UserGroupRole userGroupRole)
                                         throws SystemException

Deletes the user group role from the database. Also notifies the appropriate model listeners.

Parameters:

userGroupRole - the user group role

Returns:

the user group role that was removed

Throws:

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

fetchUserGroupRole

public static UserGroupRole fetchUserGroupRole(UserGroupRolePK userGroupRolePK)
                                        throws SystemException

Throws:

SystemException

getUserGroupRole

public static UserGroupRole getUserGroupRole(UserGroupRolePK userGroupRolePK)
                                      throws PortalException,
                                             SystemException

Returns the user group role with the primary key.

Parameters:

userGroupRolePK - the primary key of the user group role

Returns:

the user group role

Throws:

PortalException - if a user group role 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

getUserGroupRoles

public static List<UserGroupRole> getUserGroupRoles(int start,
                                                    int end)
                                             throws SystemException

Returns a range of all the user group roles.

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 UserGroupRoleModelImpl. 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 group roles

end - the upper bound of the range of user group roles (not inclusive)

Returns:

the range of user group roles

Throws:

SystemException - if a system exception occurred

getUserGroupRolesCount

public static int getUserGroupRolesCount()
                                  throws SystemException

Returns the number of user group roles.

Returns:

the number of user group roles

Throws:

SystemException - if a system exception occurred

updateUserGroupRole

public static UserGroupRole updateUserGroupRole(UserGroupRole userGroupRole)
                                         throws SystemException

Updates the user group role in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

userGroupRole - the user group role

Returns:

the user group role that was updated

Throws:

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

addUserGroupRoles

public static List<UserGroupRole> addUserGroupRoles(long userId,
                                                    long groupId,
                                                    long[] roleIds)
                                             throws SystemException

Throws:

SystemException

addUserGroupRoles

public static List<UserGroupRole> addUserGroupRoles(long[] userIds,
                                                    long groupId,
                                                    long roleId)
                                             throws SystemException

Throws:

SystemException

deleteUserGroupRoles

public static void deleteUserGroupRoles(long userId,
                                        long groupId,
                                        long[] roleIds)
                                 throws SystemException

Throws:

SystemException

deleteUserGroupRoles

public static void deleteUserGroupRoles(long userId,
                                        long[] groupIds)
                                 throws SystemException

Throws:

SystemException

deleteUserGroupRoles

public static void deleteUserGroupRoles(long[] userIds,
                                        long groupId)
                                 throws SystemException

Throws:

SystemException

deleteUserGroupRoles

public static void deleteUserGroupRoles(long[] userIds,
                                        long groupId,
                                        int roleType)
                                 throws SystemException

Throws:

SystemException

deleteUserGroupRoles

public static void deleteUserGroupRoles(long[] userIds,
                                        long groupId,
                                        long roleId)
                                 throws SystemException

Throws:

SystemException

deleteUserGroupRolesByGroupId

public static void deleteUserGroupRolesByGroupId(long groupId)
                                          throws SystemException

Throws:

SystemException

deleteUserGroupRolesByRoleId

public static void deleteUserGroupRolesByRoleId(long roleId)
                                         throws SystemException

Throws:

SystemException

deleteUserGroupRolesByUserId

public static void deleteUserGroupRolesByUserId(long userId)
                                         throws SystemException

Throws:

SystemException

getUserGroupRoles

public static List<UserGroupRole> getUserGroupRoles(long userId)
                                             throws SystemException

Throws:

SystemException

getUserGroupRoles

public static List<UserGroupRole> getUserGroupRoles(long userId,
                                                    long groupId)
                                             throws SystemException

Throws:

SystemException

getUserGroupRolesByGroup

public static List<UserGroupRole> getUserGroupRolesByGroup(long groupId)
                                                    throws SystemException

Throws:

SystemException

getUserGroupRolesByGroupAndRole

public static List<UserGroupRole> getUserGroupRolesByGroupAndRole(long groupId,
                                                                  long roleId)
                                                           throws SystemException

Throws:

SystemException

getUserGroupRolesByUserUserGroupAndGroup

public static List<UserGroupRole> getUserGroupRolesByUserUserGroupAndGroup(long userId,
                                                                           long groupId)
                                                                    throws SystemException

Throws:

SystemException

hasUserGroupRole

public static boolean hasUserGroupRole(long userId,
                                       long groupId,
                                       long roleId)
                                throws SystemException

Throws:

SystemException

hasUserGroupRole

public static boolean hasUserGroupRole(long userId,
                                       long groupId,
                                       long roleId,
                                       boolean inherit)
                                throws SystemException

Throws:

SystemException

hasUserGroupRole

public static boolean hasUserGroupRole(long userId,
                                       long groupId,
                                       String roleName)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

hasUserGroupRole

public static boolean hasUserGroupRole(long userId,
                                       long groupId,
                                       String roleName,
                                       boolean inherit)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

getService

public static UserGroupRoleLocalService getService()

setService

public void setService(UserGroupRoleLocalService service)

Deprecated. As of 6.2.0