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 ResourceBlockPermission. 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 ResourceBlockPermissionLocalServiceUtil 034 * @see com.liferay.portal.service.base.ResourceBlockPermissionLocalServiceBaseImpl 035 * @see com.liferay.portal.service.impl.ResourceBlockPermissionLocalServiceImpl 036 * @generated 037 */ 038 @ProviderType 039 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 040 PortalException.class, SystemException.class}) 041 public interface ResourceBlockPermissionLocalService extends BaseLocalService, 042 PermissionedModelLocalService { 043 /* 044 * NOTE FOR DEVELOPERS: 045 * 046 * Never modify or reference this interface directly. Always use {@link ResourceBlockPermissionLocalServiceUtil} to access the resource block permission local service. Add custom service methods to {@link com.liferay.portal.service.impl.ResourceBlockPermissionLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 047 */ 048 049 /** 050 * Adds the resource block permission to the database. Also notifies the appropriate model listeners. 051 * 052 * @param resourceBlockPermission the resource block permission 053 * @return the resource block permission that was added 054 */ 055 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 056 public com.liferay.portal.model.ResourceBlockPermission addResourceBlockPermission( 057 com.liferay.portal.model.ResourceBlockPermission resourceBlockPermission); 058 059 public void addResourceBlockPermissions(long resourceBlockId, 060 com.liferay.portal.model.ResourceBlockPermissionsContainer resourceBlockPermissionsContainer); 061 062 /** 063 * Creates a new resource block permission with the primary key. Does not add the resource block permission to the database. 064 * 065 * @param resourceBlockPermissionId the primary key for the new resource block permission 066 * @return the new resource block permission 067 */ 068 public com.liferay.portal.model.ResourceBlockPermission createResourceBlockPermission( 069 long resourceBlockPermissionId); 070 071 /** 072 * @throws PortalException 073 */ 074 @Override 075 public com.liferay.portal.model.PersistedModel deletePersistedModel( 076 com.liferay.portal.model.PersistedModel persistedModel) 077 throws PortalException; 078 079 /** 080 * Deletes the resource block permission from the database. Also notifies the appropriate model listeners. 081 * 082 * @param resourceBlockPermission the resource block permission 083 * @return the resource block permission that was removed 084 */ 085 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 086 public com.liferay.portal.model.ResourceBlockPermission deleteResourceBlockPermission( 087 com.liferay.portal.model.ResourceBlockPermission resourceBlockPermission); 088 089 /** 090 * Deletes the resource block permission with the primary key from the database. Also notifies the appropriate model listeners. 091 * 092 * @param resourceBlockPermissionId the primary key of the resource block permission 093 * @return the resource block permission that was removed 094 * @throws PortalException if a resource block permission with the primary key could not be found 095 */ 096 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 097 public com.liferay.portal.model.ResourceBlockPermission deleteResourceBlockPermission( 098 long resourceBlockPermissionId) throws PortalException; 099 100 public void deleteResourceBlockPermissions(long resourceBlockId); 101 102 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 103 104 /** 105 * Performs a dynamic query on the database and returns the matching rows. 106 * 107 * @param dynamicQuery the dynamic query 108 * @return the matching rows 109 */ 110 public <T> java.util.List<T> dynamicQuery( 111 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 112 113 /** 114 * Performs a dynamic query on the database and returns a range of the matching rows. 115 * 116 * <p> 117 * 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.ResourceBlockPermissionModelImpl}. 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. 118 * </p> 119 * 120 * @param dynamicQuery the dynamic query 121 * @param start the lower bound of the range of model instances 122 * @param end the upper bound of the range of model instances (not inclusive) 123 * @return the range of matching rows 124 */ 125 public <T> java.util.List<T> dynamicQuery( 126 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 127 int end); 128 129 /** 130 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 131 * 132 * <p> 133 * 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.ResourceBlockPermissionModelImpl}. 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. 134 * </p> 135 * 136 * @param dynamicQuery the dynamic query 137 * @param start the lower bound of the range of model instances 138 * @param end the upper bound of the range of model instances (not inclusive) 139 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 140 * @return the ordered range of matching rows 141 */ 142 public <T> java.util.List<T> dynamicQuery( 143 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 144 int end, 145 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 146 147 /** 148 * Returns the number of rows matching the dynamic query. 149 * 150 * @param dynamicQuery the dynamic query 151 * @return the number of rows matching the dynamic query 152 */ 153 public long dynamicQueryCount( 154 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 155 156 /** 157 * Returns the number of rows matching the dynamic query. 158 * 159 * @param dynamicQuery the dynamic query 160 * @param projection the projection to apply to the query 161 * @return the number of rows matching the dynamic query 162 */ 163 public long dynamicQueryCount( 164 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 165 com.liferay.portal.kernel.dao.orm.Projection projection); 166 167 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 168 public com.liferay.portal.model.ResourceBlockPermission fetchResourceBlockPermission( 169 long resourceBlockPermissionId); 170 171 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 172 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 173 174 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 175 public java.util.Map<java.lang.Long, java.util.Set<java.lang.String>> getAvailableResourceBlockPermissionActionIds( 176 java.lang.String name, long primKey, 177 java.util.List<java.lang.String> actionIds) throws PortalException; 178 179 /** 180 * @deprecated As of 7.0.0, replaced by {@link 181 #getAvailableResourceBlockPermissionActionIds(String, long, 182 List)} 183 */ 184 @java.lang.Deprecated 185 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 186 public java.util.Map<java.lang.Long, java.util.Set<java.lang.String>> getAvailableResourceBlockPermissionActionIds( 187 long[] roleIds, java.lang.String name, long primKey, 188 java.util.List<java.lang.String> actionIds) throws PortalException; 189 190 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 191 public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); 192 193 /** 194 * Returns the OSGi service identifier. 195 * 196 * @return the OSGi service identifier 197 */ 198 public java.lang.String getOSGiServiceIdentifier(); 199 200 @Override 201 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 202 public com.liferay.portal.model.PersistedModel getPersistedModel( 203 java.io.Serializable primaryKeyObj) throws PortalException; 204 205 /** 206 * Returns the resource block permission with the primary key. 207 * 208 * @param resourceBlockPermissionId the primary key of the resource block permission 209 * @return the resource block permission 210 * @throws PortalException if a resource block permission with the primary key could not be found 211 */ 212 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 213 public com.liferay.portal.model.ResourceBlockPermission getResourceBlockPermission( 214 long resourceBlockPermissionId) throws PortalException; 215 216 /** 217 * Returns a range of all the resource block permissions. 218 * 219 * <p> 220 * 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.ResourceBlockPermissionModelImpl}. 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. 221 * </p> 222 * 223 * @param start the lower bound of the range of resource block permissions 224 * @param end the upper bound of the range of resource block permissions (not inclusive) 225 * @return the range of resource block permissions 226 */ 227 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 228 public java.util.List<com.liferay.portal.model.ResourceBlockPermission> getResourceBlockPermissions( 229 int start, int end); 230 231 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 232 public com.liferay.portal.model.ResourceBlockPermissionsContainer getResourceBlockPermissionsContainer( 233 long resourceBlockId); 234 235 /** 236 * Returns the number of resource block permissions. 237 * 238 * @return the number of resource block permissions 239 */ 240 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 241 public int getResourceBlockPermissionsCount(); 242 243 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 244 public int getResourceBlockPermissionsCount(long resourceBlockId, 245 long roleId); 246 247 public void updateResourceBlockPermission(long resourceBlockId, 248 long roleId, long actionIdsLong, int operator); 249 250 /** 251 * Updates the resource block permission in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 252 * 253 * @param resourceBlockPermission the resource block permission 254 * @return the resource block permission that was updated 255 */ 256 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 257 public com.liferay.portal.model.ResourceBlockPermission updateResourceBlockPermission( 258 com.liferay.portal.model.ResourceBlockPermission resourceBlockPermission); 259 }