001 /** 002 * Copyright (c) 2000-2013 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 com.liferay.portal.kernel.exception.PortalException; 018 import com.liferay.portal.kernel.exception.SystemException; 019 import com.liferay.portal.kernel.transaction.Isolation; 020 import com.liferay.portal.kernel.transaction.Propagation; 021 import com.liferay.portal.kernel.transaction.Transactional; 022 023 /** 024 * Provides the local service interface for ResourceTypePermission. Methods of this 025 * service will not have security checks based on the propagated JAAS 026 * credentials because this service can only be accessed from within the same 027 * VM. 028 * 029 * @author Brian Wing Shun Chan 030 * @see ResourceTypePermissionLocalServiceUtil 031 * @see com.liferay.portal.service.base.ResourceTypePermissionLocalServiceBaseImpl 032 * @see com.liferay.portal.service.impl.ResourceTypePermissionLocalServiceImpl 033 * @generated 034 */ 035 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 036 PortalException.class, SystemException.class}) 037 public interface ResourceTypePermissionLocalService extends BaseLocalService, 038 PersistedModelLocalService { 039 /* 040 * NOTE FOR DEVELOPERS: 041 * 042 * 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. 043 */ 044 045 /** 046 * Adds the resource type permission to the database. Also notifies the appropriate model listeners. 047 * 048 * @param resourceTypePermission the resource type permission 049 * @return the resource type permission that was added 050 * @throws SystemException if a system exception occurred 051 */ 052 public com.liferay.portal.model.ResourceTypePermission addResourceTypePermission( 053 com.liferay.portal.model.ResourceTypePermission resourceTypePermission) 054 throws com.liferay.portal.kernel.exception.SystemException; 055 056 /** 057 * Creates a new resource type permission with the primary key. Does not add the resource type permission to the database. 058 * 059 * @param resourceTypePermissionId the primary key for the new resource type permission 060 * @return the new resource type permission 061 */ 062 public com.liferay.portal.model.ResourceTypePermission createResourceTypePermission( 063 long resourceTypePermissionId); 064 065 /** 066 * Deletes the resource type permission with the primary key from the database. Also notifies the appropriate model listeners. 067 * 068 * @param resourceTypePermissionId the primary key of the resource type permission 069 * @return the resource type permission that was removed 070 * @throws PortalException if a resource type permission with the primary key could not be found 071 * @throws SystemException if a system exception occurred 072 */ 073 public com.liferay.portal.model.ResourceTypePermission deleteResourceTypePermission( 074 long resourceTypePermissionId) 075 throws com.liferay.portal.kernel.exception.PortalException, 076 com.liferay.portal.kernel.exception.SystemException; 077 078 /** 079 * Deletes the resource type permission from the database. Also notifies the appropriate model listeners. 080 * 081 * @param resourceTypePermission the resource type permission 082 * @return the resource type permission that was removed 083 * @throws SystemException if a system exception occurred 084 */ 085 public com.liferay.portal.model.ResourceTypePermission deleteResourceTypePermission( 086 com.liferay.portal.model.ResourceTypePermission resourceTypePermission) 087 throws com.liferay.portal.kernel.exception.SystemException; 088 089 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 090 091 /** 092 * Performs a dynamic query on the database and returns the matching rows. 093 * 094 * @param dynamicQuery the dynamic query 095 * @return the matching rows 096 * @throws SystemException if a system exception occurred 097 */ 098 @SuppressWarnings("rawtypes") 099 public java.util.List dynamicQuery( 100 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 101 throws com.liferay.portal.kernel.exception.SystemException; 102 103 /** 104 * Performs a dynamic query on the database and returns a range of the matching rows. 105 * 106 * <p> 107 * 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. 108 * </p> 109 * 110 * @param dynamicQuery the dynamic query 111 * @param start the lower bound of the range of model instances 112 * @param end the upper bound of the range of model instances (not inclusive) 113 * @return the range of matching rows 114 * @throws SystemException if a system exception occurred 115 */ 116 @SuppressWarnings("rawtypes") 117 public java.util.List dynamicQuery( 118 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 119 int end) throws com.liferay.portal.kernel.exception.SystemException; 120 121 /** 122 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 123 * 124 * <p> 125 * 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. 126 * </p> 127 * 128 * @param dynamicQuery the dynamic query 129 * @param start the lower bound of the range of model instances 130 * @param end the upper bound of the range of model instances (not inclusive) 131 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 132 * @return the ordered range of matching rows 133 * @throws SystemException if a system exception occurred 134 */ 135 @SuppressWarnings("rawtypes") 136 public java.util.List dynamicQuery( 137 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 138 int end, 139 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 140 throws com.liferay.portal.kernel.exception.SystemException; 141 142 /** 143 * Returns the number of rows that match the dynamic query. 144 * 145 * @param dynamicQuery the dynamic query 146 * @return the number of rows that match the dynamic query 147 * @throws SystemException if a system exception occurred 148 */ 149 public long dynamicQueryCount( 150 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 151 throws com.liferay.portal.kernel.exception.SystemException; 152 153 /** 154 * Returns the number of rows that match the dynamic query. 155 * 156 * @param dynamicQuery the dynamic query 157 * @param projection the projection to apply to the query 158 * @return the number of rows that match the dynamic query 159 * @throws SystemException if a system exception occurred 160 */ 161 public long dynamicQueryCount( 162 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 163 com.liferay.portal.kernel.dao.orm.Projection projection) 164 throws com.liferay.portal.kernel.exception.SystemException; 165 166 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 167 public com.liferay.portal.model.ResourceTypePermission fetchResourceTypePermission( 168 long resourceTypePermissionId) 169 throws com.liferay.portal.kernel.exception.SystemException; 170 171 /** 172 * Returns the resource type permission with the primary key. 173 * 174 * @param resourceTypePermissionId the primary key of the resource type permission 175 * @return the resource type permission 176 * @throws PortalException if a resource type permission with the primary key could not be found 177 * @throws SystemException if a system exception occurred 178 */ 179 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 180 public com.liferay.portal.model.ResourceTypePermission getResourceTypePermission( 181 long resourceTypePermissionId) 182 throws com.liferay.portal.kernel.exception.PortalException, 183 com.liferay.portal.kernel.exception.SystemException; 184 185 @Override 186 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 187 public com.liferay.portal.model.PersistedModel getPersistedModel( 188 java.io.Serializable primaryKeyObj) 189 throws com.liferay.portal.kernel.exception.PortalException, 190 com.liferay.portal.kernel.exception.SystemException; 191 192 /** 193 * Returns a range of all the resource type permissions. 194 * 195 * <p> 196 * 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. 197 * </p> 198 * 199 * @param start the lower bound of the range of resource type permissions 200 * @param end the upper bound of the range of resource type permissions (not inclusive) 201 * @return the range of resource type permissions 202 * @throws SystemException if a system exception occurred 203 */ 204 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 205 public java.util.List<com.liferay.portal.model.ResourceTypePermission> getResourceTypePermissions( 206 int start, int end) 207 throws com.liferay.portal.kernel.exception.SystemException; 208 209 /** 210 * Returns the number of resource type permissions. 211 * 212 * @return the number of resource type permissions 213 * @throws SystemException if a system exception occurred 214 */ 215 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 216 public int getResourceTypePermissionsCount() 217 throws com.liferay.portal.kernel.exception.SystemException; 218 219 /** 220 * Updates the resource type permission in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 221 * 222 * @param resourceTypePermission the resource type permission 223 * @return the resource type permission that was updated 224 * @throws SystemException if a system exception occurred 225 */ 226 public com.liferay.portal.model.ResourceTypePermission updateResourceTypePermission( 227 com.liferay.portal.model.ResourceTypePermission resourceTypePermission) 228 throws com.liferay.portal.kernel.exception.SystemException; 229 230 /** 231 * Returns the Spring bean ID for this bean. 232 * 233 * @return the Spring bean ID for this bean 234 */ 235 public java.lang.String getBeanIdentifier(); 236 237 /** 238 * Sets the Spring bean ID for this bean. 239 * 240 * @param beanIdentifier the Spring bean ID for this bean 241 */ 242 public void setBeanIdentifier(java.lang.String beanIdentifier); 243 244 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 245 public long getCompanyScopeActionIds(long companyId, java.lang.String name, 246 long roleId) throws com.liferay.portal.kernel.exception.SystemException; 247 248 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 249 public long getGroupScopeActionIds(long companyId, long groupId, 250 java.lang.String name, long roleId) 251 throws com.liferay.portal.kernel.exception.SystemException; 252 253 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 254 public java.util.List<com.liferay.portal.model.ResourceTypePermission> getGroupScopeResourceTypePermissions( 255 long companyId, java.lang.String name, long roleId) 256 throws com.liferay.portal.kernel.exception.SystemException; 257 258 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 259 public com.liferay.portal.model.ResourceBlockPermissionsContainer getResourceBlockPermissionsContainer( 260 long companyId, long groupId, java.lang.String name) 261 throws com.liferay.portal.kernel.exception.SystemException; 262 263 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 264 public java.util.List<com.liferay.portal.model.ResourceTypePermission> getRoleResourceTypePermissions( 265 long roleId) throws com.liferay.portal.kernel.exception.SystemException; 266 267 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 268 public boolean hasCompanyScopePermission(long companyId, 269 java.lang.String name, long roleId, java.lang.String actionId) 270 throws com.liferay.portal.kernel.exception.PortalException, 271 com.liferay.portal.kernel.exception.SystemException; 272 273 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 274 public boolean hasEitherScopePermission(long companyId, 275 java.lang.String name, long roleId, java.lang.String actionId) 276 throws com.liferay.portal.kernel.exception.PortalException, 277 com.liferay.portal.kernel.exception.SystemException; 278 279 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 280 public boolean hasGroupScopePermission(long companyId, long groupId, 281 java.lang.String name, long roleId, java.lang.String actionId) 282 throws com.liferay.portal.kernel.exception.PortalException, 283 com.liferay.portal.kernel.exception.SystemException; 284 285 public void updateCompanyScopeResourceTypePermissions(long companyId, 286 java.lang.String name, long roleId, long actionIdsLong, long operator) 287 throws com.liferay.portal.kernel.exception.SystemException; 288 289 public void updateGroupScopeResourceTypePermissions(long companyId, 290 long groupId, java.lang.String name, long roleId, long actionIdsLong, 291 long operator) 292 throws com.liferay.portal.kernel.exception.SystemException; 293 }