/** * Copyright (c) 2000-present 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.kernel.service; import aQute.bnd.annotation.ProviderType; import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery; import com.liferay.portal.kernel.dao.orm.DynamicQuery; import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery; import com.liferay.portal.kernel.dao.orm.Projection; import com.liferay.portal.kernel.exception.PortalException; import com.liferay.portal.kernel.exception.SystemException; import com.liferay.portal.kernel.model.PersistedModel; import com.liferay.portal.kernel.model.ResourceBlockPermissionsContainer; import com.liferay.portal.kernel.model.ResourceTypePermission; import com.liferay.portal.kernel.search.Indexable; import com.liferay.portal.kernel.search.IndexableType; import com.liferay.portal.kernel.transaction.Isolation; import com.liferay.portal.kernel.transaction.Propagation; import com.liferay.portal.kernel.transaction.Transactional; import com.liferay.portal.kernel.util.OrderByComparator; import java.io.Serializable; import java.util.List; /** * Provides the local service interface for ResourceTypePermission. 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 ResourceTypePermissionLocalServiceUtil * @see com.liferay.portal.service.base.ResourceTypePermissionLocalServiceBaseImpl * @see com.liferay.portal.service.impl.ResourceTypePermissionLocalServiceImpl * @generated */ @ProviderType @Transactional(isolation = Isolation.PORTAL, rollbackFor = { PortalException.class, SystemException.class}) public interface ResourceTypePermissionLocalService extends BaseLocalService, PersistedModelLocalService { /* * NOTE FOR DEVELOPERS: * * Never modify or reference this interface directly. Always use {@link ResourceTypePermissionLocalServiceUtil} to access the resource type permission local service. Add custom service methods to {@link com.liferay.portal.service.impl.ResourceTypePermissionLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public boolean hasCompanyScopePermission(long companyId, java.lang.String name, long roleId, java.lang.String actionId) throws PortalException; @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public boolean hasEitherScopePermission(long companyId, java.lang.String name, long roleId, java.lang.String actionId) throws PortalException; @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public boolean hasGroupScopePermission(long companyId, long groupId, java.lang.String name, long roleId, java.lang.String actionId) throws PortalException; @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public ActionableDynamicQuery getActionableDynamicQuery(); public DynamicQuery dynamicQuery(); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); /** * @throws PortalException */ @Override public PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException; @Override @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException; @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public ResourceBlockPermissionsContainer getResourceBlockPermissionsContainer( long companyId, long groupId, java.lang.String name); /** * Adds the resource type permission to the database. Also notifies the appropriate model listeners. * * @param resourceTypePermission the resource type permission * @return the resource type permission that was added */ @Indexable(type = IndexableType.REINDEX) public ResourceTypePermission addResourceTypePermission( ResourceTypePermission resourceTypePermission); /** * Creates a new resource type permission with the primary key. Does not add the resource type permission to the database. * * @param resourceTypePermissionId the primary key for the new resource type permission * @return the new resource type permission */ public ResourceTypePermission createResourceTypePermission( long resourceTypePermissionId); /** * Deletes the resource type permission from the database. Also notifies the appropriate model listeners. * * @param resourceTypePermission the resource type permission * @return the resource type permission that was removed */ @Indexable(type = IndexableType.DELETE) public ResourceTypePermission deleteResourceTypePermission( ResourceTypePermission resourceTypePermission); /** * Deletes the resource type permission with the primary key from the database. Also notifies the appropriate model listeners. * * @param resourceTypePermissionId the primary key of the resource type permission * @return the resource type permission that was removed * @throws PortalException if a resource type permission with the primary key could not be found */ @Indexable(type = IndexableType.DELETE) public ResourceTypePermission deleteResourceTypePermission( long resourceTypePermissionId) throws PortalException; @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public ResourceTypePermission fetchResourceTypePermission( long resourceTypePermissionId); /** * Returns the resource type permission with the primary key. * * @param resourceTypePermissionId the primary key of the resource type permission * @return the resource type permission * @throws PortalException if a resource type permission with the primary key could not be found */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public ResourceTypePermission getResourceTypePermission( long resourceTypePermissionId) throws PortalException; /** * Updates the resource type permission in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. * * @param resourceTypePermission the resource type permission * @return the resource type permission that was updated */ @Indexable(type = IndexableType.REINDEX) public ResourceTypePermission updateResourceTypePermission( ResourceTypePermission resourceTypePermission); /** * Returns the number of resource type permissions. * * @return the number of resource type permissions */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int getResourceTypePermissionsCount(); /** * Returns the OSGi service identifier. * * @return the OSGi service identifier */ public java.lang.String getOSGiServiceIdentifier(); /** * Performs a dynamic query on the database and returns the matching rows. * * @param dynamicQuery the dynamic query * @return the matching rows */ public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery); /** * Performs a dynamic query on the database and returns a range of the matching rows. * * <p> * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> 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.ResourceTypePermissionModelImpl}. If both <code>orderByComparator</code> 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. * </p> * * @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 */ public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end); /** * Performs a dynamic query on the database and returns an ordered range of the matching rows. * * <p> * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> 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.ResourceTypePermissionModelImpl}. If both <code>orderByComparator</code> 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. * </p> * * @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 <code>null</code>) * @return the ordered range of matching rows */ public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<ResourceTypePermission> getGroupScopeResourceTypePermissions( long companyId, java.lang.String name, long roleId); /** * Returns a range of all the resource type permissions. * * <p> * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> 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.ResourceTypePermissionModelImpl}. If both <code>orderByComparator</code> 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. * </p> * * @param start the lower bound of the range of resource type permissions * @param end the upper bound of the range of resource type permissions (not inclusive) * @return the range of resource type permissions */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<ResourceTypePermission> getResourceTypePermissions(int start, int end); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<ResourceTypePermission> getRoleResourceTypePermissions( long roleId); /** * Returns the number of rows matching the dynamic query. * * @param dynamicQuery the dynamic query * @return the number of rows matching the dynamic query */ public long dynamicQueryCount(DynamicQuery dynamicQuery); /** * Returns the number of rows matching the dynamic query. * * @param dynamicQuery the dynamic query * @param projection the projection to apply to the query * @return the number of rows matching the dynamic query */ public long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public long getCompanyScopeActionIds(long companyId, java.lang.String name, long roleId); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public long getGroupScopeActionIds(long companyId, long groupId, java.lang.String name, long roleId); public void updateCompanyScopeResourceTypePermissions(long companyId, java.lang.String name, long roleId, long actionIdsLong, long operator); public void updateGroupScopeResourceTypePermissions(long companyId, long groupId, java.lang.String name, long roleId, long actionIdsLong, long operator); }