Liferay 6.2-ce-ga5

com.liferay.portal.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.

See Also:
UserGroupGroupRoleLocalServiceUtil, UserGroupGroupRoleLocalServiceBaseImpl, com.liferay.portal.service.impl.UserGroupGroupRoleLocalServiceImpl

Method Summary
 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.
 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 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()
           
 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.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
 UserGroupGroupRole fetchUserGroupGroupRole(UserGroupGroupRolePK userGroupGroupRolePK)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 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)
           
 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)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 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)
                                         throws SystemException
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
Throws:
SystemException - if a system exception occurred

createUserGroupGroupRole

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

deleteUserGroupGroupRole

@Indexable(type=DELETE)
UserGroupGroupRole deleteUserGroupGroupRole(UserGroupGroupRolePK userGroupGroupRolePK)
                                            throws PortalException,
                                                   SystemException
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
SystemException - if a system exception occurred

deleteUserGroupGroupRole

@Indexable(type=DELETE)
UserGroupGroupRole deleteUserGroupGroupRole(UserGroupGroupRole userGroupGroupRole)
                                            throws SystemException
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
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. 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
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. 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
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

fetchUserGroupGroupRole

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserGroupGroupRole fetchUserGroupGroupRole(UserGroupGroupRolePK userGroupGroupRolePK)
                                           throws SystemException
Throws:
SystemException

getUserGroupGroupRole

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserGroupGroupRole getUserGroupGroupRole(UserGroupGroupRolePK userGroupGroupRolePK)
                                         throws PortalException,
                                                SystemException
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
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

getUserGroupGroupRoles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroupGroupRole> getUserGroupGroupRoles(int start,
                                                                                         int end)
                                                throws SystemException
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
Throws:
SystemException - if a system exception occurred

getUserGroupGroupRolesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserGroupGroupRolesCount()
                                throws SystemException
Returns the number of user group group roles.

Returns:
the number of user group group roles
Throws:
SystemException - if a system exception occurred

updateUserGroupGroupRole

@Indexable(type=REINDEX)
UserGroupGroupRole updateUserGroupGroupRole(UserGroupGroupRole userGroupGroupRole)
                                            throws SystemException
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
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

addUserGroupGroupRoles

void addUserGroupGroupRoles(long userGroupId,
                            long groupId,
                            long[] roleIds)
                            throws SystemException
Throws:
SystemException

addUserGroupGroupRoles

void addUserGroupGroupRoles(long[] userGroupIds,
                            long groupId,
                            long roleId)
                            throws SystemException
Throws:
SystemException

deleteUserGroupGroupRoles

void deleteUserGroupGroupRoles(long userGroupId,
                               long groupId,
                               long[] roleIds)
                               throws SystemException
Throws:
SystemException

deleteUserGroupGroupRoles

void deleteUserGroupGroupRoles(long userGroupId,
                               long[] groupIds)
                               throws SystemException
Throws:
SystemException

deleteUserGroupGroupRoles

void deleteUserGroupGroupRoles(long[] userGroupIds,
                               long groupId)
                               throws SystemException
Throws:
SystemException

deleteUserGroupGroupRoles

void deleteUserGroupGroupRoles(long[] userGroupIds,
                               long groupId,
                               long roleId)
                               throws SystemException
Throws:
SystemException

deleteUserGroupGroupRolesByGroupId

void deleteUserGroupGroupRolesByGroupId(long groupId)
                                        throws SystemException
Throws:
SystemException

deleteUserGroupGroupRolesByRoleId

void deleteUserGroupGroupRolesByRoleId(long roleId)
                                       throws SystemException
Throws:
SystemException

deleteUserGroupGroupRolesByUserGroupId

void deleteUserGroupGroupRolesByUserGroupId(long userGroupId)
                                            throws SystemException
Throws:
SystemException

getUserGroupGroupRoles

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

getUserGroupGroupRoles

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

getUserGroupGroupRolesByGroupAndRole

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

getUserGroupGroupRolesByUser

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

hasUserGroupGroupRole

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

hasUserGroupGroupRole

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

Liferay 6.2-ce-ga5