com.liferay.portal.kernel.service

Class UserGroupRoleLocalServiceUtil

java.lang.Object

com.liferay.portal.kernel.service.UserGroupRoleLocalServiceUtil

@ProviderType
public class UserGroupRoleLocalServiceUtil
extends java.lang.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.

Author:

Brian Wing Shun Chan

See Also:

UserGroupRoleLocalService, UserGroupRoleLocalServiceBaseImpl, UserGroupRoleLocalServiceImpl

Generated:

Constructor Summary

Constructors

Constructor and Description
UserGroupRoleLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static UserGroupRole	addUserGroupRole(UserGroupRole userGroupRole) Adds the user group role to the database.
static java.util.List<UserGroupRole>	addUserGroupRoles(long[] userIds, long groupId, long roleId)
static java.util.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 PersistedModel	deletePersistedModel(PersistedModel persistedModel)
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 groupId, int roleType)
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 <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> 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 matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static UserGroupRole	fetchUserGroupRole(UserGroupRolePK userGroupRolePK)
static ActionableDynamicQuery	getActionableDynamicQuery()
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static UserGroupRoleLocalService	getService()
static UserGroupRole	getUserGroupRole(UserGroupRolePK userGroupRolePK) Returns the user group role with the primary key.
static java.util.List<UserGroupRole>	getUserGroupRoles(int start, int end) Returns a range of all the user group roles.
static java.util.List<UserGroupRole>	getUserGroupRoles(long userId)
static java.util.List<UserGroupRole>	getUserGroupRoles(long userId, long groupId)
static java.util.List<UserGroupRole>	getUserGroupRoles(long userId, long groupId, int start, int end)
static java.util.List<UserGroupRole>	getUserGroupRolesByGroup(long groupId)
static java.util.List<UserGroupRole>	getUserGroupRolesByGroupAndRole(long groupId, long roleId)
static java.util.List<UserGroupRole>	getUserGroupRolesByUserUserGroupAndGroup(long userId, long groupId)
static int	getUserGroupRolesCount() Returns the number of user group roles.
static int	getUserGroupRolesCount(long userId, long groupId)
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, java.lang.String roleName)
static boolean	hasUserGroupRole(long userId, long groupId, java.lang.String roleName, boolean inherit)
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)

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

addUserGroupRoles

public static java.util.List<UserGroupRole> addUserGroupRoles(long userId,
                                                              long groupId,
                                                              long[] roleIds)

addUserGroupRoles

public static java.util.List<UserGroupRole> addUserGroupRoles(long[] userIds,
                                                              long groupId,
                                                              long roleId)

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

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

deleteUserGroupRole

public static UserGroupRole deleteUserGroupRole(UserGroupRole userGroupRole)

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

deleteUserGroupRole

public static UserGroupRole deleteUserGroupRole(UserGroupRolePK userGroupRolePK)
                                         throws PortalException

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

deleteUserGroupRoles

public static void deleteUserGroupRoles(long groupId,
                                        int roleType)

deleteUserGroupRoles

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

deleteUserGroupRoles

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

deleteUserGroupRoles

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

deleteUserGroupRoles

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

deleteUserGroupRoles

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

deleteUserGroupRolesByGroupId

public static void deleteUserGroupRolesByGroupId(long groupId)

deleteUserGroupRolesByRoleId

public static void deleteUserGroupRolesByRoleId(long roleId)

deleteUserGroupRolesByUserId

public static void deleteUserGroupRolesByUserId(long userId)

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end)

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

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end,
                                                 OrderByComparator<T> orderByComparator)

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

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchUserGroupRole

public static UserGroupRole fetchUserGroupRole(UserGroupRolePK userGroupRolePK)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getUserGroupRole

public static UserGroupRole getUserGroupRole(UserGroupRolePK userGroupRolePK)
                                      throws PortalException

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

getUserGroupRoles

public static java.util.List<UserGroupRole> getUserGroupRoles(int start,
                                                              int end)

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

getUserGroupRoles

public static java.util.List<UserGroupRole> getUserGroupRoles(long userId)

getUserGroupRoles

public static java.util.List<UserGroupRole> getUserGroupRoles(long userId,
                                                              long groupId)

getUserGroupRoles

public static java.util.List<UserGroupRole> getUserGroupRoles(long userId,
                                                              long groupId,
                                                              int start,
                                                              int end)

getUserGroupRolesByGroup

public static java.util.List<UserGroupRole> getUserGroupRolesByGroup(long groupId)

getUserGroupRolesByGroupAndRole

public static java.util.List<UserGroupRole> getUserGroupRolesByGroupAndRole(long groupId,
                                                                            long roleId)

getUserGroupRolesByUserUserGroupAndGroup

public static java.util.List<UserGroupRole> getUserGroupRolesByUserUserGroupAndGroup(long userId,
                                                                                     long groupId)

getUserGroupRolesCount

public static int getUserGroupRolesCount()

Returns the number of user group roles.

Returns:

the number of user group roles

getUserGroupRolesCount

public static int getUserGroupRolesCount(long userId,
                                         long groupId)

hasUserGroupRole

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

hasUserGroupRole

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

hasUserGroupRole

public static boolean hasUserGroupRole(long userId,
                                       long groupId,
                                       java.lang.String roleName)
                                throws PortalException

Throws:

PortalException

hasUserGroupRole

public static boolean hasUserGroupRole(long userId,
                                       long groupId,
                                       java.lang.String roleName,
                                       boolean inherit)
                                throws PortalException

Throws:

PortalException

updateUserGroupRole

public static UserGroupRole updateUserGroupRole(UserGroupRole userGroupRole)

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

getService

public static UserGroupRoleLocalService getService()