com.liferay.portal.kernel.service

Interface UserGroupRoleLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

UserGroupRoleLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface UserGroupRoleLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for UserGroupRole. 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:

UserGroupRoleLocalServiceUtil, UserGroupRoleLocalServiceBaseImpl, UserGroupRoleLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
UserGroupRole	addUserGroupRole(UserGroupRole userGroupRole) Adds the user group role to the database.
List<UserGroupRole>	addUserGroupRoles(long[] userIds, long groupId, long roleId)
List<UserGroupRole>	addUserGroupRoles(long userId, long groupId, long[] roleIds)
UserGroupRole	createUserGroupRole(UserGroupRolePK userGroupRolePK) Creates a new user group role with the primary key.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
UserGroupRole	deleteUserGroupRole(UserGroupRole userGroupRole) Deletes the user group role from the database.
UserGroupRole	deleteUserGroupRole(UserGroupRolePK userGroupRolePK) Deletes the user group role with the primary key from the database.
void	deleteUserGroupRoles(long[] userIds, long groupId)
void	deleteUserGroupRoles(long[] userIds, long groupId, int roleType)
void	deleteUserGroupRoles(long[] userIds, long groupId, long roleId)
void	deleteUserGroupRoles(long groupId, int roleType)
void	deleteUserGroupRoles(long userId, long[] groupIds)
void	deleteUserGroupRoles(long userId, long groupId, long[] roleIds)
void	deleteUserGroupRolesByGroupId(long groupId)
void	deleteUserGroupRolesByRoleId(long roleId)
void	deleteUserGroupRolesByUserId(long userId)
DynamicQuery	dynamicQuery()
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<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.
<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.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
UserGroupRole	fetchUserGroupRole(UserGroupRolePK userGroupRolePK)
ActionableDynamicQuery	getActionableDynamicQuery()
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
UserGroupRole	getUserGroupRole(UserGroupRolePK userGroupRolePK) Returns the user group role with the primary key.
List<UserGroupRole>	getUserGroupRoles(int start, int end) Returns a range of all the user group roles.
List<UserGroupRole>	getUserGroupRoles(long userId)
List<UserGroupRole>	getUserGroupRoles(long userId, long groupId)
List<UserGroupRole>	getUserGroupRoles(long userId, long groupId, int start, int end)
List<UserGroupRole>	getUserGroupRolesByGroup(long groupId)
List<UserGroupRole>	getUserGroupRolesByGroupAndRole(long groupId, long roleId)
List<UserGroupRole>	getUserGroupRolesByUserUserGroupAndGroup(long userId, long groupId)
int	getUserGroupRolesCount() Returns the number of user group roles.
int	getUserGroupRolesCount(long userId, long groupId)
boolean	hasUserGroupRole(long userId, long groupId, long roleId)
boolean	hasUserGroupRole(long userId, long groupId, long roleId, boolean inherit)
boolean	hasUserGroupRole(long userId, long groupId, String roleName)
boolean	hasUserGroupRole(long userId, long groupId, String roleName, boolean inherit)
UserGroupRole	updateUserGroupRole(UserGroupRole userGroupRole) Updates the user group role in the database or adds it if it does not yet exist.

Method Detail

addUserGroupRole

@Indexable(type=REINDEX)
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

List<UserGroupRole> addUserGroupRoles(long userId,
                                      long groupId,
                                      long[] roleIds)

addUserGroupRoles

List<UserGroupRole> addUserGroupRoles(long[] userIds,
                                      long groupId,
                                      long roleId)

createUserGroupRole

@Transactional(enabled=false)
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

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteUserGroupRole

@Indexable(type=DELETE)
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

@Indexable(type=DELETE)
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

void deleteUserGroupRoles(long groupId,
                          int roleType)

deleteUserGroupRoles

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

deleteUserGroupRoles

void deleteUserGroupRoles(long userId,
                          long[] groupIds)

deleteUserGroupRoles

void deleteUserGroupRoles(long[] userIds,
                          long groupId)

deleteUserGroupRoles

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

deleteUserGroupRoles

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

deleteUserGroupRolesByGroupId

void deleteUserGroupRolesByGroupId(long groupId)

deleteUserGroupRolesByRoleId

void deleteUserGroupRolesByRoleId(long roleId)

deleteUserGroupRolesByUserId

void deleteUserGroupRolesByUserId(long userId)

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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 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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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 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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserGroupRole fetchUserGroupRole(UserGroupRolePK userGroupRolePK)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getUserGroupRole

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroupRole> getUserGroupRoles(long userId)

getUserGroupRoles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroupRole> getUserGroupRoles(long userId,
                                                                                                         long groupId)

getUserGroupRoles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroupRole> getUserGroupRoles(long userId,
                                                                                                         long groupId,
                                                                                                         int start,
                                                                                                         int end)

getUserGroupRolesByGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroupRole> getUserGroupRolesByGroup(long groupId)

getUserGroupRolesByGroupAndRole

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroupRole> getUserGroupRolesByGroupAndRole(long groupId,
                                                                                                                       long roleId)

getUserGroupRolesByUserUserGroupAndGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroupRole> getUserGroupRolesByUserUserGroupAndGroup(long userId,
                                                                                                                                long groupId)

getUserGroupRolesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserGroupRolesCount()

Returns the number of user group roles.

Returns:

the number of user group roles

getUserGroupRolesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserGroupRolesCount(long userId,
                                                                                              long groupId)

hasUserGroupRole

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserGroupRole(long userId,
                                                                                            long groupId,
                                                                                            long roleId)

hasUserGroupRole

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserGroupRole(long userId,
                                                                                            long groupId,
                                                                                            long roleId,
                                                                                            boolean inherit)

hasUserGroupRole

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserGroupRole(long userId,
                                                                                            long groupId,
                                                                                            String roleName)
                                                                                     throws PortalException

Throws:

PortalException

hasUserGroupRole

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserGroupRole(long userId,
                                                                                            long groupId,
                                                                                            String roleName,
                                                                                            boolean inherit)
                                                                                     throws PortalException

Throws:

PortalException

updateUserGroupRole

@Indexable(type=REINDEX)
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