com.liferay.portal.kernel.service

Class UserGroupGroupRoleLocalServiceUtil

Object

com.liferay.portal.kernel.service.UserGroupGroupRoleLocalServiceUtil

@ProviderType
public class UserGroupGroupRoleLocalServiceUtil
extends Object

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

UserGroupGroupRoleLocalService, UserGroupGroupRoleLocalServiceBaseImpl, UserGroupGroupRoleLocalServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
UserGroupGroupRoleLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static UserGroupGroupRole	addUserGroupGroupRole(UserGroupGroupRole userGroupGroupRole) Adds the user group group role to the database.
static void	addUserGroupGroupRoles(long[] userGroupIds, long groupId, long roleId)
static void	addUserGroupGroupRoles(long userGroupId, long groupId, long[] roleIds)
static UserGroupGroupRole	createUserGroupGroupRole(UserGroupGroupRolePK userGroupGroupRolePK) Creates a new user group group role with the primary key.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static UserGroupGroupRole	deleteUserGroupGroupRole(UserGroupGroupRole userGroupGroupRole) Deletes the user group group role from the database.
static UserGroupGroupRole	deleteUserGroupGroupRole(UserGroupGroupRolePK userGroupGroupRolePK) Deletes the user group group role with the primary key from the database.
static void	deleteUserGroupGroupRoles(long[] userGroupIds, long groupId)
static void	deleteUserGroupGroupRoles(long[] userGroupIds, long groupId, long roleId)
static void	deleteUserGroupGroupRoles(long groupId, int roleType)
static void	deleteUserGroupGroupRoles(long userGroupId, long[] groupIds)
static void	deleteUserGroupGroupRoles(long userGroupId, long groupId, long[] roleIds)
static void	deleteUserGroupGroupRolesByGroupId(long groupId)
static void	deleteUserGroupGroupRolesByRoleId(long roleId)
static void	deleteUserGroupGroupRolesByUserGroupId(long userGroupId)
static DynamicQuery	dynamicQuery()
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> 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> 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 UserGroupGroupRole	fetchUserGroupGroupRole(UserGroupGroupRolePK userGroupGroupRolePK)
static ActionableDynamicQuery	getActionableDynamicQuery()
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static UserGroupGroupRoleLocalService	getService()
static UserGroupGroupRole	getUserGroupGroupRole(UserGroupGroupRolePK userGroupGroupRolePK) Returns the user group group role with the primary key.
static List<UserGroupGroupRole>	getUserGroupGroupRoles(int start, int end) Returns a range of all the user group group roles.
static List<UserGroupGroupRole>	getUserGroupGroupRoles(long userGroupId)
static List<UserGroupGroupRole>	getUserGroupGroupRoles(long userGroupId, long groupId)
static List<UserGroupGroupRole>	getUserGroupGroupRolesByGroupAndRole(long groupId, long roleId)
static List<UserGroupGroupRole>	getUserGroupGroupRolesByUser(long userId)
static List<UserGroupGroupRole>	getUserGroupGroupRolesByUser(long userId, long groupId)
static int	getUserGroupGroupRolesCount() Returns the number of user group group roles.
static boolean	hasUserGroupGroupRole(long userGroupId, long groupId, long roleId)
static boolean	hasUserGroupGroupRole(long userGroupId, long groupId, String roleName)
static UserGroupGroupRole	updateUserGroupGroupRole(UserGroupGroupRole userGroupGroupRole) Updates the user group group role in the database or adds it if it does not yet exist.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserGroupGroupRoleLocalServiceUtil

public UserGroupGroupRoleLocalServiceUtil()

Method Detail

addUserGroupGroupRole

public static UserGroupGroupRole addUserGroupGroupRole(UserGroupGroupRole userGroupGroupRole)

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

Parameters:

userGroupGroupRole - the user group group role

Returns:

the user group group role that was added

addUserGroupGroupRoles

public static void addUserGroupGroupRoles(long userGroupId,
                                          long groupId,
                                          long[] roleIds)

addUserGroupGroupRoles

public static void addUserGroupGroupRoles(long[] userGroupIds,
                                          long groupId,
                                          long roleId)

createUserGroupGroupRole

public static UserGroupGroupRole createUserGroupGroupRole(UserGroupGroupRolePK userGroupGroupRolePK)

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

Parameters:

userGroupGroupRolePK - the primary key for the new user group group role

Returns:

the new user group group role

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

deleteUserGroupGroupRole

public static UserGroupGroupRole deleteUserGroupGroupRole(UserGroupGroupRole userGroupGroupRole)

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

Parameters:

userGroupGroupRole - the user group group role

Returns:

the user group group role that was removed

deleteUserGroupGroupRole

public static UserGroupGroupRole deleteUserGroupGroupRole(UserGroupGroupRolePK userGroupGroupRolePK)
                                                   throws PortalException

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

Parameters:

userGroupGroupRolePK - the primary key of the user group group role

Returns:

the user group group role that was removed

Throws:

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

deleteUserGroupGroupRoles

public static void deleteUserGroupGroupRoles(long groupId,
                                             int roleType)

deleteUserGroupGroupRoles

public static void deleteUserGroupGroupRoles(long userGroupId,
                                             long groupId,
                                             long[] roleIds)

deleteUserGroupGroupRoles

public static void deleteUserGroupGroupRoles(long userGroupId,
                                             long[] groupIds)

deleteUserGroupGroupRoles

public static void deleteUserGroupGroupRoles(long[] userGroupIds,
                                             long groupId)

deleteUserGroupGroupRoles

public static void deleteUserGroupGroupRoles(long[] userGroupIds,
                                             long groupId,
                                             long roleId)

deleteUserGroupGroupRolesByGroupId

public static void deleteUserGroupGroupRolesByGroupId(long groupId)

deleteUserGroupGroupRolesByRoleId

public static void deleteUserGroupGroupRolesByRoleId(long roleId)

deleteUserGroupGroupRolesByUserGroupId

public static void deleteUserGroupGroupRolesByUserGroupId(long userGroupId)

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> 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> 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 UserGroupGroupRoleModelImpl. 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> 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 UserGroupGroupRoleModelImpl. 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

fetchUserGroupGroupRole

public static UserGroupGroupRole fetchUserGroupGroupRole(UserGroupGroupRolePK userGroupGroupRolePK)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getUserGroupGroupRole

public static UserGroupGroupRole getUserGroupGroupRole(UserGroupGroupRolePK userGroupGroupRolePK)
                                                throws PortalException

Returns the user group group role with the primary key.

Parameters:

userGroupGroupRolePK - the primary key of the user group group role

Returns:

the user group group role

Throws:

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

getUserGroupGroupRoles

public static List<UserGroupGroupRole> getUserGroupGroupRoles(int start,
                                                              int end)

Returns a range of all the user group 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 UserGroupGroupRoleModelImpl. 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 group roles

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

Returns:

the range of user group group roles

getUserGroupGroupRoles

public static List<UserGroupGroupRole> getUserGroupGroupRoles(long userGroupId)

getUserGroupGroupRoles

public static List<UserGroupGroupRole> getUserGroupGroupRoles(long userGroupId,
                                                              long groupId)

getUserGroupGroupRolesByGroupAndRole

public static List<UserGroupGroupRole> getUserGroupGroupRolesByGroupAndRole(long groupId,
                                                                            long roleId)

getUserGroupGroupRolesByUser

public static List<UserGroupGroupRole> getUserGroupGroupRolesByUser(long userId)

getUserGroupGroupRolesByUser

public static List<UserGroupGroupRole> getUserGroupGroupRolesByUser(long userId,
                                                                    long groupId)

getUserGroupGroupRolesCount

public static int getUserGroupGroupRolesCount()

Returns the number of user group group roles.

Returns:

the number of user group group roles

hasUserGroupGroupRole

public static boolean hasUserGroupGroupRole(long userGroupId,
                                            long groupId,
                                            long roleId)

hasUserGroupGroupRole

public static boolean hasUserGroupGroupRole(long userGroupId,
                                            long groupId,
                                            String roleName)
                                     throws PortalException

Throws:

PortalException

updateUserGroupGroupRole

public static UserGroupGroupRole updateUserGroupGroupRole(UserGroupGroupRole userGroupGroupRole)

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

Parameters:

userGroupGroupRole - the user group group role

Returns:

the user group group role that was updated

getService

public static UserGroupGroupRoleLocalService getService()