com.liferay.portal.kernel.service

Interface UserGroupGroupRoleLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

UserGroupGroupRoleLocalServiceWrapper

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

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

UserGroupGroupRoleLocalServiceUtil, UserGroupGroupRoleLocalServiceBaseImpl, UserGroupGroupRoleLocalServiceImpl

{$generated.description}

Method Summary

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

Method Detail

addUserGroupGroupRole

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

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

addUserGroupGroupRoles

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

createUserGroupGroupRole

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

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteUserGroupGroupRole

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

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

void deleteUserGroupGroupRoles(long groupId,
                               int roleType)

deleteUserGroupGroupRoles

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

deleteUserGroupGroupRoles

void deleteUserGroupGroupRoles(long userGroupId,
                               long[] groupIds)

deleteUserGroupGroupRoles

void deleteUserGroupGroupRoles(long[] userGroupIds,
                               long groupId)

deleteUserGroupGroupRoles

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

deleteUserGroupGroupRolesByGroupId

void deleteUserGroupGroupRolesByGroupId(long groupId)

deleteUserGroupGroupRolesByRoleId

void deleteUserGroupGroupRolesByRoleId(long roleId)

deleteUserGroupGroupRolesByUserGroupId

void deleteUserGroupGroupRolesByUserGroupId(long userGroupId)

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

@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 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

@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

fetchUserGroupGroupRole

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserGroupGroupRole fetchUserGroupGroupRole(UserGroupGroupRolePK userGroupGroupRolePK)

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

getUserGroupGroupRole

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroupGroupRole> getUserGroupGroupRoles(long userGroupId)

getUserGroupGroupRoles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroupGroupRole> getUserGroupGroupRoles(long userGroupId,
                                                                                                                   long groupId)

getUserGroupGroupRolesByGroupAndRole

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

getUserGroupGroupRolesByUser

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroupGroupRole> getUserGroupGroupRolesByUser(long userId)

getUserGroupGroupRolesByUser

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

getUserGroupGroupRolesCount

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

Returns the number of user group group roles.

Returns:

the number of user group group roles

hasUserGroupGroupRole

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserGroupGroupRole(long userGroupId,
                                                                                                 long groupId,
                                                                                                 long roleId)

hasUserGroupGroupRole

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

Throws:

PortalException

updateUserGroupGroupRole

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