com.liferay.portal.service
Interface UserGroupRoleLocalService

All Known Implementing Classes:

UserGroupRoleLocalServiceBaseImpl, UserGroupRoleLocalServiceImpl, UserGroupRoleLocalServiceWrapper

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

The interface for the user group role local service.

Never modify or reference this interface directly. Always use UserGroupRoleLocalServiceUtil to access the user group role local service. Add custom service methods to UserGroupRoleLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

This is a local service. 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.

See Also:

UserGroupRoleLocalServiceUtil, UserGroupRoleLocalServiceBaseImpl, UserGroupRoleLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary

UserGroupRole	addUserGroupRole(UserGroupRole userGroupRole) Adds the user group role to the database.
void	addUserGroupRoles(long[] userIds, long groupId, long roleId)
void	addUserGroupRoles(long userId, long groupId, long[] roleIds)
UserGroupRole	createUserGroupRole(UserGroupRolePK userGroupRolePK) Creates a new user group role with the primary key.
void	deleteUserGroupRole(UserGroupRole userGroupRole) Deletes the user group role from the database.
void	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, 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)
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
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) Counts the number of rows that match the dynamic query.
UserGroupRole	getUserGroupRole(UserGroupRolePK userGroupRolePK) Gets the user group role with the primary key.
List<UserGroupRole>	getUserGroupRoles(int start, int end) Gets a range of all the user group roles.
List<UserGroupRole>	getUserGroupRoles(long userId)
List<UserGroupRole>	getUserGroupRoles(long userId, long groupId)
List<UserGroupRole>	getUserGroupRolesByGroupAndRole(long groupId, long roleId)
List<UserGroupRole>	getUserGroupRolesByUserUserGroupAndGroup(long userId, long groupId)
int	getUserGroupRolesCount() Gets 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, String roleName)
boolean	hasUserGroupRole(long userId, long groupId, String roleName, boolean inherit)
UserGroupRole	updateUserGroupRole(UserGroupRole userGroupRole) Updates the user group role in the database.
UserGroupRole	updateUserGroupRole(UserGroupRole userGroupRole, boolean merge) Updates the user group role in the database.

Method Detail

addUserGroupRole

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

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

void 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 to delete

Throws:

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

SystemException - if a system exception occurred

deleteUserGroupRole

void 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 to delete

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException

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

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

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.

Parameters:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (not inclusive)

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

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.

Parameters:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Counts the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

getUserGroupRole

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

Gets the user group role with the primary key.

Parameters:

userGroupRolePK - the primary key of the user group role to get

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

getUserGroupRoles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroupRole> getUserGroupRoles(int start,
                                                                               int end)
                                      throws SystemException

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

Parameters:

start - the lower bound of the range of user group roles to return

end - the upper bound of the range of user group roles to return (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

Gets the number of user group roles.

Returns:

the number of user group roles

Throws:

SystemException - if a system exception occurred

updateUserGroupRole

UserGroupRole updateUserGroupRole(UserGroupRole userGroupRole)
                                  throws SystemException

Updates the user group role in the database. Also notifies the appropriate model listeners.

Parameters:

userGroupRole - the user group role to update

Returns:

the user group role that was updated

Throws:

SystemException - if a system exception occurred

updateUserGroupRole

UserGroupRole updateUserGroupRole(UserGroupRole userGroupRole,
                                  boolean merge)
                                  throws SystemException

Updates the user group role in the database. Also notifies the appropriate model listeners.

Parameters:

userGroupRole - the user group role to update

merge - whether to merge the user group role with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the user group role that was updated

Throws:

SystemException - if a system exception occurred

addUserGroupRoles

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

Throws:

PortalException

SystemException

addUserGroupRoles

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

Throws:

PortalException

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,
                          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)
List<UserGroupRole> getUserGroupRoles(long userId)
                                      throws SystemException

Throws:

SystemException

getUserGroupRoles

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

Throws:

SystemException

getUserGroupRolesByGroupAndRole

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

Throws:

SystemException

getUserGroupRolesByUserUserGroupAndGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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,
                                                                  String roleName)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

hasUserGroupRole

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

Throws:

PortalException

SystemException