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