001 /** 002 * Copyright (c) 2000-2011 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.bean.PortalBeanLocatorUtil; 018 import com.liferay.portal.kernel.util.MethodCache; 019 import com.liferay.portal.kernel.util.ReferenceRegistry; 020 021 /** 022 * The utility for the resource block permission local service. This utility wraps {@link com.liferay.portal.service.impl.ResourceBlockPermissionLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server. 023 * 024 * <p> 025 * 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. 026 * </p> 027 * 028 * @author Brian Wing Shun Chan 029 * @see ResourceBlockPermissionLocalService 030 * @see com.liferay.portal.service.base.ResourceBlockPermissionLocalServiceBaseImpl 031 * @see com.liferay.portal.service.impl.ResourceBlockPermissionLocalServiceImpl 032 * @generated 033 */ 034 public class ResourceBlockPermissionLocalServiceUtil { 035 /* 036 * NOTE FOR DEVELOPERS: 037 * 038 * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.ResourceBlockPermissionLocalServiceImpl} and rerun ServiceBuilder to regenerate this class. 039 */ 040 041 /** 042 * Adds the resource block permission to the database. Also notifies the appropriate model listeners. 043 * 044 * @param resourceBlockPermission the resource block permission 045 * @return the resource block permission that was added 046 * @throws SystemException if a system exception occurred 047 */ 048 public static com.liferay.portal.model.ResourceBlockPermission addResourceBlockPermission( 049 com.liferay.portal.model.ResourceBlockPermission resourceBlockPermission) 050 throws com.liferay.portal.kernel.exception.SystemException { 051 return getService().addResourceBlockPermission(resourceBlockPermission); 052 } 053 054 /** 055 * Creates a new resource block permission with the primary key. Does not add the resource block permission to the database. 056 * 057 * @param resourceBlockPermissionId the primary key for the new resource block permission 058 * @return the new resource block permission 059 */ 060 public static com.liferay.portal.model.ResourceBlockPermission createResourceBlockPermission( 061 long resourceBlockPermissionId) { 062 return getService() 063 .createResourceBlockPermission(resourceBlockPermissionId); 064 } 065 066 /** 067 * Deletes the resource block permission with the primary key from the database. Also notifies the appropriate model listeners. 068 * 069 * @param resourceBlockPermissionId the primary key of the resource block permission 070 * @throws PortalException if a resource block permission with the primary key could not be found 071 * @throws SystemException if a system exception occurred 072 */ 073 public static void deleteResourceBlockPermission( 074 long resourceBlockPermissionId) 075 throws com.liferay.portal.kernel.exception.PortalException, 076 com.liferay.portal.kernel.exception.SystemException { 077 getService().deleteResourceBlockPermission(resourceBlockPermissionId); 078 } 079 080 /** 081 * Deletes the resource block permission from the database. Also notifies the appropriate model listeners. 082 * 083 * @param resourceBlockPermission the resource block permission 084 * @throws SystemException if a system exception occurred 085 */ 086 public static void deleteResourceBlockPermission( 087 com.liferay.portal.model.ResourceBlockPermission resourceBlockPermission) 088 throws com.liferay.portal.kernel.exception.SystemException { 089 getService().deleteResourceBlockPermission(resourceBlockPermission); 090 } 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 static java.util.List dynamicQuery( 101 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 102 throws com.liferay.portal.kernel.exception.SystemException { 103 return getService().dynamicQuery(dynamicQuery); 104 } 105 106 /** 107 * Performs a dynamic query on the database and returns a range of the matching rows. 108 * 109 * <p> 110 * 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. 111 * </p> 112 * 113 * @param dynamicQuery the dynamic query 114 * @param start the lower bound of the range of model instances 115 * @param end the upper bound of the range of model instances (not inclusive) 116 * @return the range of matching rows 117 * @throws SystemException if a system exception occurred 118 */ 119 @SuppressWarnings("rawtypes") 120 public static java.util.List dynamicQuery( 121 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 122 int end) throws com.liferay.portal.kernel.exception.SystemException { 123 return getService().dynamicQuery(dynamicQuery, start, end); 124 } 125 126 /** 127 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 128 * 129 * <p> 130 * 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. 131 * </p> 132 * 133 * @param dynamicQuery the dynamic query 134 * @param start the lower bound of the range of model instances 135 * @param end the upper bound of the range of model instances (not inclusive) 136 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 137 * @return the ordered range of matching rows 138 * @throws SystemException if a system exception occurred 139 */ 140 @SuppressWarnings("rawtypes") 141 public static java.util.List dynamicQuery( 142 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 143 int end, 144 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 145 throws com.liferay.portal.kernel.exception.SystemException { 146 return getService() 147 .dynamicQuery(dynamicQuery, start, end, orderByComparator); 148 } 149 150 /** 151 * Returns the number of rows that match the dynamic query. 152 * 153 * @param dynamicQuery the dynamic query 154 * @return the number of rows that match the dynamic query 155 * @throws SystemException if a system exception occurred 156 */ 157 public static long dynamicQueryCount( 158 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 159 throws com.liferay.portal.kernel.exception.SystemException { 160 return getService().dynamicQueryCount(dynamicQuery); 161 } 162 163 /** 164 * Returns the resource block permission with the primary key. 165 * 166 * @param resourceBlockPermissionId the primary key of the resource block permission 167 * @return the resource block permission 168 * @throws PortalException if a resource block permission with the primary key could not be found 169 * @throws SystemException if a system exception occurred 170 */ 171 public static com.liferay.portal.model.ResourceBlockPermission getResourceBlockPermission( 172 long resourceBlockPermissionId) 173 throws com.liferay.portal.kernel.exception.PortalException, 174 com.liferay.portal.kernel.exception.SystemException { 175 return getService().getResourceBlockPermission(resourceBlockPermissionId); 176 } 177 178 public static com.liferay.portal.model.PersistedModel getPersistedModel( 179 java.io.Serializable primaryKeyObj) 180 throws com.liferay.portal.kernel.exception.PortalException, 181 com.liferay.portal.kernel.exception.SystemException { 182 return getService().getPersistedModel(primaryKeyObj); 183 } 184 185 /** 186 * Returns a range of all the resource block permissions. 187 * 188 * <p> 189 * 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. 190 * </p> 191 * 192 * @param start the lower bound of the range of resource block permissions 193 * @param end the upper bound of the range of resource block permissions (not inclusive) 194 * @return the range of resource block permissions 195 * @throws SystemException if a system exception occurred 196 */ 197 public static java.util.List<com.liferay.portal.model.ResourceBlockPermission> getResourceBlockPermissions( 198 int start, int end) 199 throws com.liferay.portal.kernel.exception.SystemException { 200 return getService().getResourceBlockPermissions(start, end); 201 } 202 203 /** 204 * Returns the number of resource block permissions. 205 * 206 * @return the number of resource block permissions 207 * @throws SystemException if a system exception occurred 208 */ 209 public static int getResourceBlockPermissionsCount() 210 throws com.liferay.portal.kernel.exception.SystemException { 211 return getService().getResourceBlockPermissionsCount(); 212 } 213 214 /** 215 * Updates the resource block permission in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 216 * 217 * @param resourceBlockPermission the resource block permission 218 * @return the resource block permission that was updated 219 * @throws SystemException if a system exception occurred 220 */ 221 public static com.liferay.portal.model.ResourceBlockPermission updateResourceBlockPermission( 222 com.liferay.portal.model.ResourceBlockPermission resourceBlockPermission) 223 throws com.liferay.portal.kernel.exception.SystemException { 224 return getService() 225 .updateResourceBlockPermission(resourceBlockPermission); 226 } 227 228 /** 229 * Updates the resource block permission in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 230 * 231 * @param resourceBlockPermission the resource block permission 232 * @param merge whether to merge the resource block permission with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation. 233 * @return the resource block permission that was updated 234 * @throws SystemException if a system exception occurred 235 */ 236 public static com.liferay.portal.model.ResourceBlockPermission updateResourceBlockPermission( 237 com.liferay.portal.model.ResourceBlockPermission resourceBlockPermission, 238 boolean merge) 239 throws com.liferay.portal.kernel.exception.SystemException { 240 return getService() 241 .updateResourceBlockPermission(resourceBlockPermission, merge); 242 } 243 244 /** 245 * Returns the Spring bean ID for this bean. 246 * 247 * @return the Spring bean ID for this bean 248 */ 249 public static java.lang.String getBeanIdentifier() { 250 return getService().getBeanIdentifier(); 251 } 252 253 /** 254 * Sets the Spring bean ID for this bean. 255 * 256 * @param beanIdentifier the Spring bean ID for this bean 257 */ 258 public static void setBeanIdentifier(java.lang.String beanIdentifier) { 259 getService().setBeanIdentifier(beanIdentifier); 260 } 261 262 public static void addResourceBlockPermissions(long resourceBlockId, 263 com.liferay.portal.model.ResourceBlockPermissionsContainer resourceBlockPermissionsContainer) 264 throws com.liferay.portal.kernel.exception.SystemException { 265 getService() 266 .addResourceBlockPermissions(resourceBlockId, 267 resourceBlockPermissionsContainer); 268 } 269 270 public static void deleteResourceBlockPermissions(long resourceBlockId) 271 throws com.liferay.portal.kernel.exception.SystemException { 272 getService().deleteResourceBlockPermissions(resourceBlockId); 273 } 274 275 public static com.liferay.portal.model.ResourceBlockPermissionsContainer getResourceBlockPermissionsContainer( 276 long resourceBlockId) 277 throws com.liferay.portal.kernel.exception.SystemException { 278 return getService().getResourceBlockPermissionsContainer(resourceBlockId); 279 } 280 281 public static void updateResourceBlockPermission(long resourceBlockId, 282 long roleId, long actionIdsLong, int operator) 283 throws com.liferay.portal.kernel.exception.SystemException { 284 getService() 285 .updateResourceBlockPermission(resourceBlockId, roleId, 286 actionIdsLong, operator); 287 } 288 289 public static ResourceBlockPermissionLocalService getService() { 290 if (_service == null) { 291 _service = (ResourceBlockPermissionLocalService)PortalBeanLocatorUtil.locate(ResourceBlockPermissionLocalService.class.getName()); 292 293 ReferenceRegistry.registerReference(ResourceBlockPermissionLocalServiceUtil.class, 294 "_service"); 295 MethodCache.remove(ResourceBlockPermissionLocalService.class); 296 } 297 298 return _service; 299 } 300 301 public void setService(ResourceBlockPermissionLocalService service) { 302 MethodCache.remove(ResourceBlockPermissionLocalService.class); 303 304 _service = service; 305 306 ReferenceRegistry.registerReference(ResourceBlockPermissionLocalServiceUtil.class, 307 "_service"); 308 MethodCache.remove(ResourceBlockPermissionLocalService.class); 309 } 310 311 private static ResourceBlockPermissionLocalService _service; 312 }