Liferay 6.1.2-ce-ga3

com.liferay.portal.service
Interface UserGroupRoleLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
UserGroupRoleLocalServiceBaseImpl, UserGroupRoleLocalServiceImpl, UserGroupRoleLocalServiceWrapper

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

The interface for the user group role local service.

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 it 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.
 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()
           
 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)
          Returns the number of rows that match the dynamic query.
 UserGroupRole fetchUserGroupRole(UserGroupRolePK userGroupRolePK)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 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> getUserGroupRolesByGroupAndRole(long groupId, long roleId)
           
 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, String roleName)
           
 boolean hasUserGroupRole(long userId, long groupId, String roleName, boolean inherit)
           
 void setBeanIdentifier(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.
 UserGroupRole updateUserGroupRole(UserGroupRole userGroupRole, boolean merge)
          Updates the user group role in the database or adds it if it does not yet exist.
 

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

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

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

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

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

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

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(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getUserGroupRoles

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

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

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

updateUserGroupRole

UserGroupRole updateUserGroupRole(UserGroupRole userGroupRole,
                                  boolean merge)
                                  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
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

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

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

Liferay 6.1.2-ce-ga3