com.liferay.portal.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, com.liferay.portal.service.impl.UserGroupRoleLocalServiceImpl

Generated:

Method Summary

Methods

Modifier and Type	Method and Description
UserGroupRole	addUserGroupRole(UserGroupRole userGroupRole) Adds the user group role to the database.
java.util.List<UserGroupRole>	addUserGroupRoles(long[] userIds, long groupId, long roleId)
java.util.List<UserGroupRole>	addUserGroupRoles(long userId, long groupId, long[] roleIds)
UserGroupRole	createUserGroupRole(UserGroupRolePK userGroupRolePK) Creates a new user group role with the primary key.
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 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()
java.util.List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
java.util.List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
java.util.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.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
UserGroupRole	fetchUserGroupRole(UserGroupRolePK userGroupRolePK)
java.lang.String	getBeanIdentifier() Returns the Spring bean ID for this bean.
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
UserGroupRole	getUserGroupRole(UserGroupRolePK userGroupRolePK) Returns the user group role with the primary key.
java.util.List<UserGroupRole>	getUserGroupRoles(int start, int end) Returns a range of all the user group roles.
java.util.List<UserGroupRole>	getUserGroupRoles(long userId)
java.util.List<UserGroupRole>	getUserGroupRoles(long userId, long groupId)
java.util.List<UserGroupRole>	getUserGroupRolesByGroup(long groupId)
java.util.List<UserGroupRole>	getUserGroupRolesByGroupAndRole(long groupId, long roleId)
java.util.List<UserGroupRole>	getUserGroupRolesByUserUserGroupAndGroup(long userId, long groupId)
int	getUserGroupRolesCount() Returns the number of user group roles.
boolean	hasUserGroupRole(long userId, long groupId, long roleId)
boolean	hasUserGroupRole(long userId, long groupId, long roleId, boolean inherit)
boolean	hasUserGroupRole(long userId, long groupId, java.lang.String roleName)
boolean	hasUserGroupRole(long userId, long groupId, java.lang.String roleName, boolean inherit)
void	setBeanIdentifier(java.lang.String beanIdentifier) Sets the Spring bean ID for this bean.
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)
                               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

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

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

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

DynamicQuery dynamicQuery()

dynamicQuery

java.util.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

java.util.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

java.util.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

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

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

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

Throws:

SystemException

getUserGroupRole

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

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

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getUserGroupRoles

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

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

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

java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(java.lang.String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addUserGroupRoles

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

Throws:

SystemException

addUserGroupRoles

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

Throws:

SystemException

deleteUserGroupRoles

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

Throws:

SystemException

deleteUserGroupRoles

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

Throws:

SystemException

deleteUserGroupRoles

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

Throws:

SystemException

deleteUserGroupRoles

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

Throws:

SystemException

deleteUserGroupRoles

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

Throws:

SystemException

deleteUserGroupRolesByGroupId

void deleteUserGroupRolesByGroupId(long groupId)
                                   throws SystemException

Throws:

SystemException

deleteUserGroupRolesByRoleId

void deleteUserGroupRolesByRoleId(long roleId)
                                  throws SystemException

Throws:

SystemException

deleteUserGroupRolesByUserId

void deleteUserGroupRolesByUserId(long userId)
                                  throws SystemException

Throws:

SystemException

getUserGroupRoles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<UserGroupRole> getUserGroupRoles(long userId)
                                                throws SystemException

Throws:

SystemException

getUserGroupRoles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<UserGroupRole> getUserGroupRoles(long userId,
                                                                                       long groupId)
                                                throws SystemException

Throws:

SystemException

getUserGroupRolesByGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<UserGroupRole> getUserGroupRolesByGroup(long groupId)
                                                       throws SystemException

Throws:

SystemException

getUserGroupRolesByGroupAndRole

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<UserGroupRole> getUserGroupRolesByGroupAndRole(long groupId,
                                                                                                     long roleId)
                                                              throws SystemException

Throws:

SystemException

getUserGroupRolesByUserUserGroupAndGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<UserGroupRole> getUserGroupRolesByUserUserGroupAndGroup(long userId,
                                                                                                              long groupId)
                                                                       throws SystemException

Throws:

SystemException

hasUserGroupRole

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

Throws:

SystemException

hasUserGroupRole

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

Throws:

SystemException

hasUserGroupRole

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

Throws:

PortalException

SystemException

hasUserGroupRole

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

Throws:

PortalException

SystemException