com.liferay.portal.service.UserGroupRoleLocalService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-service Show documentation
Show all versions of portal-service Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
/**
* Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.portal.service;
import aQute.bnd.annotation.ProviderType;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.transaction.Isolation;
import com.liferay.portal.kernel.transaction.Propagation;
import com.liferay.portal.kernel.transaction.Transactional;
/**
* 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 UserGroupRoleLocalServiceUtil
* @see com.liferay.portal.service.base.UserGroupRoleLocalServiceBaseImpl
* @see com.liferay.portal.service.impl.UserGroupRoleLocalServiceImpl
* @generated
*/
@ProviderType
@Transactional(isolation = Isolation.PORTAL, rollbackFor = {
PortalException.class, SystemException.class})
public interface UserGroupRoleLocalService extends BaseLocalService,
PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link UserGroupRoleLocalServiceUtil} to access the user group role local service. Add custom service methods to {@link com.liferay.portal.service.impl.UserGroupRoleLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
/**
* Adds the user group role to the database. Also notifies the appropriate model listeners.
*
* @param userGroupRole the user group role
* @return the user group role that was added
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.UserGroupRole addUserGroupRole(
com.liferay.portal.model.UserGroupRole userGroupRole)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Creates a new user group role with the primary key. Does not add the user group role to the database.
*
* @param userGroupRolePK the primary key for the new user group role
* @return the new user group role
*/
public com.liferay.portal.model.UserGroupRole createUserGroupRole(
com.liferay.portal.service.persistence.UserGroupRolePK userGroupRolePK);
/**
* Deletes the user group role with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param userGroupRolePK the primary key of the user group role
* @return the user group role that was removed
* @throws PortalException if a user group role with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.UserGroupRole deleteUserGroupRole(
com.liferay.portal.service.persistence.UserGroupRolePK userGroupRolePK)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Deletes the user group role from the database. Also notifies the appropriate model listeners.
*
* @param userGroupRole the user group role
* @return the user group role that was removed
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.UserGroupRole deleteUserGroupRole(
com.liferay.portal.model.UserGroupRole userGroupRole)
throws com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.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 {@link com.liferay.portal.kernel.dao.orm.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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.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.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @return the range of matching rows
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end) throws com.liferay.portal.kernel.exception.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 {@link com.liferay.portal.kernel.dao.orm.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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.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.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching rows
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of rows that match the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows that match the dynamic query
* @throws SystemException if a system exception occurred
*/
public long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of rows that match the dynamic query.
*
* @param dynamicQuery the dynamic query
* @param projection the projection to apply to the query
* @return the number of rows that match the dynamic query
* @throws SystemException if a system exception occurred
*/
public long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.UserGroupRole fetchUserGroupRole(
com.liferay.portal.service.persistence.UserGroupRolePK userGroupRolePK)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the user group role with the primary key.
*
* @param userGroupRolePK the primary key of the user group role
* @return the user group role
* @throws PortalException if a user group role with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.UserGroupRole getUserGroupRole(
com.liferay.portal.service.persistence.UserGroupRolePK userGroupRolePK)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.PersistedModel getPersistedModel(
java.io.Serializable primaryKeyObj)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.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 {@link com.liferay.portal.kernel.dao.orm.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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.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.
*
*
* @param start the lower bound of the range of user group roles
* @param end the upper bound of the range of user group roles (not inclusive)
* @return the range of user group roles
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getUserGroupRoles(
int start, int end)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of user group roles.
*
* @return the number of user group roles
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getUserGroupRolesCount()
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Updates the user group role in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param userGroupRole the user group role
* @return the user group role that was updated
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.UserGroupRole updateUserGroupRole(
com.liferay.portal.model.UserGroupRole userGroupRole)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the Spring bean ID for this bean.
*
* @return the Spring bean ID for this bean
*/
public java.lang.String getBeanIdentifier();
/**
* Sets the Spring bean ID for this bean.
*
* @param beanIdentifier the Spring bean ID for this bean
*/
public void setBeanIdentifier(java.lang.String beanIdentifier);
public java.util.List addUserGroupRoles(
long userId, long groupId, long[] roleIds)
throws com.liferay.portal.kernel.exception.SystemException;
public java.util.List addUserGroupRoles(
long[] userIds, long groupId, long roleId)
throws com.liferay.portal.kernel.exception.SystemException;
public void deleteUserGroupRoles(long userId, long groupId, long[] roleIds)
throws com.liferay.portal.kernel.exception.SystemException;
public void deleteUserGroupRoles(long userId, long[] groupIds)
throws com.liferay.portal.kernel.exception.SystemException;
public void deleteUserGroupRoles(long[] userIds, long groupId)
throws com.liferay.portal.kernel.exception.SystemException;
public void deleteUserGroupRoles(long[] userIds, long groupId, int roleType)
throws com.liferay.portal.kernel.exception.SystemException;
public void deleteUserGroupRoles(long[] userIds, long groupId, long roleId)
throws com.liferay.portal.kernel.exception.SystemException;
public void deleteUserGroupRolesByGroupId(long groupId)
throws com.liferay.portal.kernel.exception.SystemException;
public void deleteUserGroupRolesByRoleId(long roleId)
throws com.liferay.portal.kernel.exception.SystemException;
public void deleteUserGroupRolesByUserId(long userId)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getUserGroupRoles(
long userId) throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getUserGroupRoles(
long userId, long groupId)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getUserGroupRolesByGroup(
long groupId)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getUserGroupRolesByGroupAndRole(
long groupId, long roleId)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getUserGroupRolesByUserUserGroupAndGroup(
long userId, long groupId)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public boolean hasUserGroupRole(long userId, long groupId, long roleId)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public boolean hasUserGroupRole(long userId, long groupId, long roleId,
boolean inherit)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public boolean hasUserGroupRole(long userId, long groupId,
java.lang.String roleName)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public boolean hasUserGroupRole(long userId, long groupId,
java.lang.String roleName, boolean inherit)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
}