001 /** 002 * Copyright (c) 2000-present Liferay, Inc. All rights reserved. 003 * 004 * This library is free software; you can redistribute it and/or modify it under 005 * the terms of the GNU Lesser General Public License as published by the Free 006 * Software Foundation; either version 2.1 of the License, or (at your option) 007 * any later version. 008 * 009 * This library is distributed in the hope that it will be useful, but WITHOUT 010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 011 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more 012 * details. 013 */ 014 015 package com.liferay.portal.service; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.exception.PortalException; 020 import com.liferay.portal.kernel.exception.SystemException; 021 import com.liferay.portal.kernel.search.IndexableType; 022 import com.liferay.portal.kernel.transaction.Isolation; 023 import com.liferay.portal.kernel.transaction.Propagation; 024 import com.liferay.portal.kernel.transaction.Transactional; 025 026 /** 027 * Provides the local service interface for ResourceTypePermission. Methods of this 028 * service will not have security checks based on the propagated JAAS 029 * credentials because this service can only be accessed from within the same 030 * VM. 031 * 032 * @author Brian Wing Shun Chan 033 * @see ResourceTypePermissionLocalServiceUtil 034 * @see com.liferay.portal.service.base.ResourceTypePermissionLocalServiceBaseImpl 035 * @see com.liferay.portal.service.impl.ResourceTypePermissionLocalServiceImpl 036 * @generated 037 */ 038 @ProviderType 039 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 040 PortalException.class, SystemException.class}) 041 public interface ResourceTypePermissionLocalService extends BaseLocalService, 042 PersistedModelLocalService { 043 /* 044 * NOTE FOR DEVELOPERS: 045 * 046 * 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. 047 */ 048 049 /** 050 * Adds the resource type permission to the database. Also notifies the appropriate model listeners. 051 * 052 * @param resourceTypePermission the resource type permission 053 * @return the resource type permission that was added 054 */ 055 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 056 public com.liferay.portal.model.ResourceTypePermission addResourceTypePermission( 057 com.liferay.portal.model.ResourceTypePermission resourceTypePermission); 058 059 /** 060 * Creates a new resource type permission with the primary key. Does not add the resource type permission to the database. 061 * 062 * @param resourceTypePermissionId the primary key for the new resource type permission 063 * @return the new resource type permission 064 */ 065 public com.liferay.portal.model.ResourceTypePermission createResourceTypePermission( 066 long resourceTypePermissionId); 067 068 /** 069 * @throws PortalException 070 */ 071 @Override 072 public com.liferay.portal.model.PersistedModel deletePersistedModel( 073 com.liferay.portal.model.PersistedModel persistedModel) 074 throws PortalException; 075 076 /** 077 * Deletes the resource type permission from the database. Also notifies the appropriate model listeners. 078 * 079 * @param resourceTypePermission the resource type permission 080 * @return the resource type permission that was removed 081 */ 082 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 083 public com.liferay.portal.model.ResourceTypePermission deleteResourceTypePermission( 084 com.liferay.portal.model.ResourceTypePermission resourceTypePermission); 085 086 /** 087 * Deletes the resource type permission with the primary key from the database. Also notifies the appropriate model listeners. 088 * 089 * @param resourceTypePermissionId the primary key of the resource type permission 090 * @return the resource type permission that was removed 091 * @throws PortalException if a resource type permission with the primary key could not be found 092 */ 093 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 094 public com.liferay.portal.model.ResourceTypePermission deleteResourceTypePermission( 095 long resourceTypePermissionId) throws PortalException; 096 097 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 098 099 /** 100 * Performs a dynamic query on the database and returns the matching rows. 101 * 102 * @param dynamicQuery the dynamic query 103 * @return the matching rows 104 */ 105 public <T> java.util.List<T> dynamicQuery( 106 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 107 108 /** 109 * Performs a dynamic query on the database and returns a range of the matching rows. 110 * 111 * <p> 112 * 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. 113 * </p> 114 * 115 * @param dynamicQuery the dynamic query 116 * @param start the lower bound of the range of model instances 117 * @param end the upper bound of the range of model instances (not inclusive) 118 * @return the range of matching rows 119 */ 120 public <T> java.util.List<T> dynamicQuery( 121 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 122 int end); 123 124 /** 125 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 126 * 127 * <p> 128 * 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. 129 * </p> 130 * 131 * @param dynamicQuery the dynamic query 132 * @param start the lower bound of the range of model instances 133 * @param end the upper bound of the range of model instances (not inclusive) 134 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 135 * @return the ordered range of matching rows 136 */ 137 public <T> java.util.List<T> dynamicQuery( 138 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 139 int end, 140 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 141 142 /** 143 * Returns the number of rows matching the dynamic query. 144 * 145 * @param dynamicQuery the dynamic query 146 * @return the number of rows matching the dynamic query 147 */ 148 public long dynamicQueryCount( 149 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 150 151 /** 152 * Returns the number of rows matching the dynamic query. 153 * 154 * @param dynamicQuery the dynamic query 155 * @param projection the projection to apply to the query 156 * @return the number of rows matching the dynamic query 157 */ 158 public long dynamicQueryCount( 159 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 160 com.liferay.portal.kernel.dao.orm.Projection projection); 161 162 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 163 public com.liferay.portal.model.ResourceTypePermission fetchResourceTypePermission( 164 long resourceTypePermissionId); 165 166 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 167 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 168 169 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 170 public long getCompanyScopeActionIds(long companyId, java.lang.String name, 171 long roleId); 172 173 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 174 public long getGroupScopeActionIds(long companyId, long groupId, 175 java.lang.String name, long roleId); 176 177 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 178 public java.util.List<com.liferay.portal.model.ResourceTypePermission> getGroupScopeResourceTypePermissions( 179 long companyId, java.lang.String name, long roleId); 180 181 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 182 public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); 183 184 /** 185 * Returns the OSGi service identifier. 186 * 187 * @return the OSGi service identifier 188 */ 189 public java.lang.String getOSGiServiceIdentifier(); 190 191 @Override 192 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 193 public com.liferay.portal.model.PersistedModel getPersistedModel( 194 java.io.Serializable primaryKeyObj) throws PortalException; 195 196 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 197 public com.liferay.portal.model.ResourceBlockPermissionsContainer getResourceBlockPermissionsContainer( 198 long companyId, long groupId, java.lang.String name); 199 200 /** 201 * Returns the resource type permission with the primary key. 202 * 203 * @param resourceTypePermissionId the primary key of the resource type permission 204 * @return the resource type permission 205 * @throws PortalException if a resource type permission with the primary key could not be found 206 */ 207 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 208 public com.liferay.portal.model.ResourceTypePermission getResourceTypePermission( 209 long resourceTypePermissionId) throws PortalException; 210 211 /** 212 * Returns a range of all the resource type permissions. 213 * 214 * <p> 215 * 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. 216 * </p> 217 * 218 * @param start the lower bound of the range of resource type permissions 219 * @param end the upper bound of the range of resource type permissions (not inclusive) 220 * @return the range of resource type permissions 221 */ 222 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 223 public java.util.List<com.liferay.portal.model.ResourceTypePermission> getResourceTypePermissions( 224 int start, int end); 225 226 /** 227 * Returns the number of resource type permissions. 228 * 229 * @return the number of resource type permissions 230 */ 231 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 232 public int getResourceTypePermissionsCount(); 233 234 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 235 public java.util.List<com.liferay.portal.model.ResourceTypePermission> getRoleResourceTypePermissions( 236 long roleId); 237 238 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 239 public boolean hasCompanyScopePermission(long companyId, 240 java.lang.String name, long roleId, java.lang.String actionId) 241 throws PortalException; 242 243 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 244 public boolean hasEitherScopePermission(long companyId, 245 java.lang.String name, long roleId, java.lang.String actionId) 246 throws PortalException; 247 248 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 249 public boolean hasGroupScopePermission(long companyId, long groupId, 250 java.lang.String name, long roleId, java.lang.String actionId) 251 throws PortalException; 252 253 public void updateCompanyScopeResourceTypePermissions(long companyId, 254 java.lang.String name, long roleId, long actionIdsLong, long operator); 255 256 public void updateGroupScopeResourceTypePermissions(long companyId, 257 long groupId, java.lang.String name, long roleId, long actionIdsLong, 258 long operator); 259 260 /** 261 * Updates the resource type permission in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 262 * 263 * @param resourceTypePermission the resource type permission 264 * @return the resource type permission that was updated 265 */ 266 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 267 public com.liferay.portal.model.ResourceTypePermission updateResourceTypePermission( 268 com.liferay.portal.model.ResourceTypePermission resourceTypePermission); 269 }