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 com.liferay.portal.kernel.exception.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) 099 throws com.liferay.portal.kernel.exception.PortalException; 100 101 public void deleteResourceBlockPermissions(long resourceBlockId); 102 103 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 104 105 /** 106 * Performs a dynamic query on the database and returns the matching rows. 107 * 108 * @param dynamicQuery the dynamic query 109 * @return the matching rows 110 */ 111 public <T> java.util.List<T> dynamicQuery( 112 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 113 114 /** 115 * Performs a dynamic query on the database and returns a range of the matching rows. 116 * 117 * <p> 118 * 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. 119 * </p> 120 * 121 * @param dynamicQuery the dynamic query 122 * @param start the lower bound of the range of model instances 123 * @param end the upper bound of the range of model instances (not inclusive) 124 * @return the range of matching rows 125 */ 126 public <T> java.util.List<T> dynamicQuery( 127 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 128 int end); 129 130 /** 131 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 132 * 133 * <p> 134 * 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. 135 * </p> 136 * 137 * @param dynamicQuery the dynamic query 138 * @param start the lower bound of the range of model instances 139 * @param end the upper bound of the range of model instances (not inclusive) 140 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 141 * @return the ordered range of matching rows 142 */ 143 public <T> java.util.List<T> dynamicQuery( 144 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 145 int end, 146 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 147 148 /** 149 * Returns the number of rows matching the dynamic query. 150 * 151 * @param dynamicQuery the dynamic query 152 * @return the number of rows matching the dynamic query 153 */ 154 public long dynamicQueryCount( 155 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 156 157 /** 158 * Returns the number of rows matching the dynamic query. 159 * 160 * @param dynamicQuery the dynamic query 161 * @param projection the projection to apply to the query 162 * @return the number of rows matching the dynamic query 163 */ 164 public long dynamicQueryCount( 165 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 166 com.liferay.portal.kernel.dao.orm.Projection projection); 167 168 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 169 public com.liferay.portal.model.ResourceBlockPermission fetchResourceBlockPermission( 170 long resourceBlockPermissionId); 171 172 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 173 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 174 175 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 176 public java.util.Map<java.lang.Long, java.util.Set<java.lang.String>> getAvailableResourceBlockPermissionActionIds( 177 java.lang.String name, long primKey, 178 java.util.List<java.lang.String> actionIds) 179 throws com.liferay.portal.kernel.exception.PortalException; 180 181 /** 182 * @deprecated As of 7.0.0, replaced by {@link 183 #getAvailableResourceBlockPermissionActionIds(String, long, 184 List)} 185 */ 186 @java.lang.Deprecated 187 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 188 public java.util.Map<java.lang.Long, java.util.Set<java.lang.String>> getAvailableResourceBlockPermissionActionIds( 189 long[] roleIds, java.lang.String name, long primKey, 190 java.util.List<java.lang.String> actionIds) 191 throws com.liferay.portal.kernel.exception.PortalException; 192 193 /** 194 * Returns the Spring bean ID for this bean. 195 * 196 * @return the Spring bean ID for this bean 197 */ 198 public java.lang.String getBeanIdentifier(); 199 200 @Override 201 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 202 public com.liferay.portal.model.PersistedModel getPersistedModel( 203 java.io.Serializable primaryKeyObj) 204 throws com.liferay.portal.kernel.exception.PortalException; 205 206 /** 207 * Returns the resource block permission with the primary key. 208 * 209 * @param resourceBlockPermissionId the primary key of the resource block permission 210 * @return the resource block permission 211 * @throws PortalException if a resource block permission with the primary key could not be found 212 */ 213 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 214 public com.liferay.portal.model.ResourceBlockPermission getResourceBlockPermission( 215 long resourceBlockPermissionId) 216 throws com.liferay.portal.kernel.exception.PortalException; 217 218 /** 219 * Returns a range of all the resource block permissions. 220 * 221 * <p> 222 * 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. 223 * </p> 224 * 225 * @param start the lower bound of the range of resource block permissions 226 * @param end the upper bound of the range of resource block permissions (not inclusive) 227 * @return the range of resource block permissions 228 */ 229 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 230 public java.util.List<com.liferay.portal.model.ResourceBlockPermission> getResourceBlockPermissions( 231 int start, int end); 232 233 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 234 public com.liferay.portal.model.ResourceBlockPermissionsContainer getResourceBlockPermissionsContainer( 235 long resourceBlockId); 236 237 /** 238 * Returns the number of resource block permissions. 239 * 240 * @return the number of resource block permissions 241 */ 242 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 243 public int getResourceBlockPermissionsCount(); 244 245 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 246 public int getResourceBlockPermissionsCount(long resourceBlockId, 247 long roleId); 248 249 /** 250 * Sets the Spring bean ID for this bean. 251 * 252 * @param beanIdentifier the Spring bean ID for this bean 253 */ 254 public void setBeanIdentifier(java.lang.String beanIdentifier); 255 256 public void updateResourceBlockPermission(long resourceBlockId, 257 long roleId, long actionIdsLong, int operator); 258 259 /** 260 * Updates the resource block permission in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 261 * 262 * @param resourceBlockPermission the resource block permission 263 * @return the resource block permission that was updated 264 */ 265 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 266 public com.liferay.portal.model.ResourceBlockPermission updateResourceBlockPermission( 267 com.liferay.portal.model.ResourceBlockPermission resourceBlockPermission); 268 }