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.persistence; 016 017 import com.liferay.portal.kernel.exception.SystemException; 018 import com.liferay.portal.model.ResourceTypePermission; 019 020 /** 021 * The persistence interface for the resource type permission service. 022 * 023 * <p> 024 * Caching information and settings can be found in <code>portal.properties</code> 025 * </p> 026 * 027 * @author Brian Wing Shun Chan 028 * @see ResourceTypePermissionPersistenceImpl 029 * @see ResourceTypePermissionUtil 030 * @generated 031 */ 032 public interface ResourceTypePermissionPersistence extends BasePersistence<ResourceTypePermission> { 033 /* 034 * NOTE FOR DEVELOPERS: 035 * 036 * Never modify or reference this interface directly. Always use {@link ResourceTypePermissionUtil} to access the resource type permission persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this interface. 037 */ 038 039 /** 040 * Caches the resource type permission in the entity cache if it is enabled. 041 * 042 * @param resourceTypePermission the resource type permission 043 */ 044 public void cacheResult( 045 com.liferay.portal.model.ResourceTypePermission resourceTypePermission); 046 047 /** 048 * Caches the resource type permissions in the entity cache if it is enabled. 049 * 050 * @param resourceTypePermissions the resource type permissions 051 */ 052 public void cacheResult( 053 java.util.List<com.liferay.portal.model.ResourceTypePermission> resourceTypePermissions); 054 055 /** 056 * Creates a new resource type permission with the primary key. Does not add the resource type permission to the database. 057 * 058 * @param resourceTypePermissionId the primary key for the new resource type permission 059 * @return the new resource type permission 060 */ 061 public com.liferay.portal.model.ResourceTypePermission create( 062 long resourceTypePermissionId); 063 064 /** 065 * Removes the resource type permission with the primary key from the database. Also notifies the appropriate model listeners. 066 * 067 * @param resourceTypePermissionId the primary key of the resource type permission 068 * @return the resource type permission that was removed 069 * @throws com.liferay.portal.NoSuchResourceTypePermissionException if a resource type permission with the primary key could not be found 070 * @throws SystemException if a system exception occurred 071 */ 072 public com.liferay.portal.model.ResourceTypePermission remove( 073 long resourceTypePermissionId) 074 throws com.liferay.portal.NoSuchResourceTypePermissionException, 075 com.liferay.portal.kernel.exception.SystemException; 076 077 public com.liferay.portal.model.ResourceTypePermission updateImpl( 078 com.liferay.portal.model.ResourceTypePermission resourceTypePermission, 079 boolean merge) 080 throws com.liferay.portal.kernel.exception.SystemException; 081 082 /** 083 * Returns the resource type permission with the primary key or throws a {@link com.liferay.portal.NoSuchResourceTypePermissionException} if it could not be found. 084 * 085 * @param resourceTypePermissionId the primary key of the resource type permission 086 * @return the resource type permission 087 * @throws com.liferay.portal.NoSuchResourceTypePermissionException if a resource type permission with the primary key could not be found 088 * @throws SystemException if a system exception occurred 089 */ 090 public com.liferay.portal.model.ResourceTypePermission findByPrimaryKey( 091 long resourceTypePermissionId) 092 throws com.liferay.portal.NoSuchResourceTypePermissionException, 093 com.liferay.portal.kernel.exception.SystemException; 094 095 /** 096 * Returns the resource type permission with the primary key or returns <code>null</code> if it could not be found. 097 * 098 * @param resourceTypePermissionId the primary key of the resource type permission 099 * @return the resource type permission, or <code>null</code> if a resource type permission with the primary key could not be found 100 * @throws SystemException if a system exception occurred 101 */ 102 public com.liferay.portal.model.ResourceTypePermission fetchByPrimaryKey( 103 long resourceTypePermissionId) 104 throws com.liferay.portal.kernel.exception.SystemException; 105 106 /** 107 * Returns all the resource type permissions where roleId = ?. 108 * 109 * @param roleId the role ID 110 * @return the matching resource type permissions 111 * @throws SystemException if a system exception occurred 112 */ 113 public java.util.List<com.liferay.portal.model.ResourceTypePermission> findByRoleId( 114 long roleId) throws com.liferay.portal.kernel.exception.SystemException; 115 116 /** 117 * Returns a range of all the resource type permissions where roleId = ?. 118 * 119 * <p> 120 * 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. 121 * </p> 122 * 123 * @param roleId the role ID 124 * @param start the lower bound of the range of resource type permissions 125 * @param end the upper bound of the range of resource type permissions (not inclusive) 126 * @return the range of matching resource type permissions 127 * @throws SystemException if a system exception occurred 128 */ 129 public java.util.List<com.liferay.portal.model.ResourceTypePermission> findByRoleId( 130 long roleId, int start, int end) 131 throws com.liferay.portal.kernel.exception.SystemException; 132 133 /** 134 * Returns an ordered range of all the resource type permissions where roleId = ?. 135 * 136 * <p> 137 * 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. 138 * </p> 139 * 140 * @param roleId the role ID 141 * @param start the lower bound of the range of resource type permissions 142 * @param end the upper bound of the range of resource type permissions (not inclusive) 143 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 144 * @return the ordered range of matching resource type permissions 145 * @throws SystemException if a system exception occurred 146 */ 147 public java.util.List<com.liferay.portal.model.ResourceTypePermission> findByRoleId( 148 long roleId, int start, int end, 149 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 150 throws com.liferay.portal.kernel.exception.SystemException; 151 152 /** 153 * Returns the first resource type permission in the ordered set where roleId = ?. 154 * 155 * <p> 156 * 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. 157 * </p> 158 * 159 * @param roleId the role ID 160 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 161 * @return the first matching resource type permission 162 * @throws com.liferay.portal.NoSuchResourceTypePermissionException if a matching resource type permission could not be found 163 * @throws SystemException if a system exception occurred 164 */ 165 public com.liferay.portal.model.ResourceTypePermission findByRoleId_First( 166 long roleId, 167 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 168 throws com.liferay.portal.NoSuchResourceTypePermissionException, 169 com.liferay.portal.kernel.exception.SystemException; 170 171 /** 172 * Returns the last resource type permission in the ordered set where roleId = ?. 173 * 174 * <p> 175 * 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. 176 * </p> 177 * 178 * @param roleId the role ID 179 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 180 * @return the last matching resource type permission 181 * @throws com.liferay.portal.NoSuchResourceTypePermissionException if a matching resource type permission could not be found 182 * @throws SystemException if a system exception occurred 183 */ 184 public com.liferay.portal.model.ResourceTypePermission findByRoleId_Last( 185 long roleId, 186 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 187 throws com.liferay.portal.NoSuchResourceTypePermissionException, 188 com.liferay.portal.kernel.exception.SystemException; 189 190 /** 191 * Returns the resource type permissions before and after the current resource type permission in the ordered set where roleId = ?. 192 * 193 * <p> 194 * 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. 195 * </p> 196 * 197 * @param resourceTypePermissionId the primary key of the current resource type permission 198 * @param roleId the role ID 199 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 200 * @return the previous, current, and next resource type permission 201 * @throws com.liferay.portal.NoSuchResourceTypePermissionException if a resource type permission with the primary key could not be found 202 * @throws SystemException if a system exception occurred 203 */ 204 public com.liferay.portal.model.ResourceTypePermission[] findByRoleId_PrevAndNext( 205 long resourceTypePermissionId, long roleId, 206 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 207 throws com.liferay.portal.NoSuchResourceTypePermissionException, 208 com.liferay.portal.kernel.exception.SystemException; 209 210 /** 211 * Returns all the resource type permissions where companyId = ? and name = ? and roleId = ?. 212 * 213 * @param companyId the company ID 214 * @param name the name 215 * @param roleId the role ID 216 * @return the matching resource type permissions 217 * @throws SystemException if a system exception occurred 218 */ 219 public java.util.List<com.liferay.portal.model.ResourceTypePermission> findByC_N_R( 220 long companyId, java.lang.String name, long roleId) 221 throws com.liferay.portal.kernel.exception.SystemException; 222 223 /** 224 * Returns a range of all the resource type permissions where companyId = ? and name = ? and roleId = ?. 225 * 226 * <p> 227 * 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. 228 * </p> 229 * 230 * @param companyId the company ID 231 * @param name the name 232 * @param roleId the role ID 233 * @param start the lower bound of the range of resource type permissions 234 * @param end the upper bound of the range of resource type permissions (not inclusive) 235 * @return the range of matching resource type permissions 236 * @throws SystemException if a system exception occurred 237 */ 238 public java.util.List<com.liferay.portal.model.ResourceTypePermission> findByC_N_R( 239 long companyId, java.lang.String name, long roleId, int start, int end) 240 throws com.liferay.portal.kernel.exception.SystemException; 241 242 /** 243 * Returns an ordered range of all the resource type permissions where companyId = ? and name = ? and roleId = ?. 244 * 245 * <p> 246 * 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. 247 * </p> 248 * 249 * @param companyId the company ID 250 * @param name the name 251 * @param roleId the role ID 252 * @param start the lower bound of the range of resource type permissions 253 * @param end the upper bound of the range of resource type permissions (not inclusive) 254 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 255 * @return the ordered range of matching resource type permissions 256 * @throws SystemException if a system exception occurred 257 */ 258 public java.util.List<com.liferay.portal.model.ResourceTypePermission> findByC_N_R( 259 long companyId, java.lang.String name, long roleId, int start, int end, 260 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 261 throws com.liferay.portal.kernel.exception.SystemException; 262 263 /** 264 * Returns the first resource type permission in the ordered set where companyId = ? and name = ? and roleId = ?. 265 * 266 * <p> 267 * 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. 268 * </p> 269 * 270 * @param companyId the company ID 271 * @param name the name 272 * @param roleId the role ID 273 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 274 * @return the first matching resource type permission 275 * @throws com.liferay.portal.NoSuchResourceTypePermissionException if a matching resource type permission could not be found 276 * @throws SystemException if a system exception occurred 277 */ 278 public com.liferay.portal.model.ResourceTypePermission findByC_N_R_First( 279 long companyId, java.lang.String name, long roleId, 280 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 281 throws com.liferay.portal.NoSuchResourceTypePermissionException, 282 com.liferay.portal.kernel.exception.SystemException; 283 284 /** 285 * Returns the last resource type permission in the ordered set where companyId = ? and name = ? and roleId = ?. 286 * 287 * <p> 288 * 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. 289 * </p> 290 * 291 * @param companyId the company ID 292 * @param name the name 293 * @param roleId the role ID 294 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 295 * @return the last matching resource type permission 296 * @throws com.liferay.portal.NoSuchResourceTypePermissionException if a matching resource type permission could not be found 297 * @throws SystemException if a system exception occurred 298 */ 299 public com.liferay.portal.model.ResourceTypePermission findByC_N_R_Last( 300 long companyId, java.lang.String name, long roleId, 301 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 302 throws com.liferay.portal.NoSuchResourceTypePermissionException, 303 com.liferay.portal.kernel.exception.SystemException; 304 305 /** 306 * Returns the resource type permissions before and after the current resource type permission in the ordered set where companyId = ? and name = ? and roleId = ?. 307 * 308 * <p> 309 * 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. 310 * </p> 311 * 312 * @param resourceTypePermissionId the primary key of the current resource type permission 313 * @param companyId the company ID 314 * @param name the name 315 * @param roleId the role ID 316 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 317 * @return the previous, current, and next resource type permission 318 * @throws com.liferay.portal.NoSuchResourceTypePermissionException if a resource type permission with the primary key could not be found 319 * @throws SystemException if a system exception occurred 320 */ 321 public com.liferay.portal.model.ResourceTypePermission[] findByC_N_R_PrevAndNext( 322 long resourceTypePermissionId, long companyId, java.lang.String name, 323 long roleId, 324 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 325 throws com.liferay.portal.NoSuchResourceTypePermissionException, 326 com.liferay.portal.kernel.exception.SystemException; 327 328 /** 329 * Returns the resource type permission where companyId = ? and groupId = ? and name = ? and roleId = ? or throws a {@link com.liferay.portal.NoSuchResourceTypePermissionException} if it could not be found. 330 * 331 * @param companyId the company ID 332 * @param groupId the group ID 333 * @param name the name 334 * @param roleId the role ID 335 * @return the matching resource type permission 336 * @throws com.liferay.portal.NoSuchResourceTypePermissionException if a matching resource type permission could not be found 337 * @throws SystemException if a system exception occurred 338 */ 339 public com.liferay.portal.model.ResourceTypePermission findByC_G_N_R( 340 long companyId, long groupId, java.lang.String name, long roleId) 341 throws com.liferay.portal.NoSuchResourceTypePermissionException, 342 com.liferay.portal.kernel.exception.SystemException; 343 344 /** 345 * Returns the resource type permission where companyId = ? and groupId = ? and name = ? and roleId = ? or returns <code>null</code> if it could not be found. Uses the finder cache. 346 * 347 * @param companyId the company ID 348 * @param groupId the group ID 349 * @param name the name 350 * @param roleId the role ID 351 * @return the matching resource type permission, or <code>null</code> if a matching resource type permission could not be found 352 * @throws SystemException if a system exception occurred 353 */ 354 public com.liferay.portal.model.ResourceTypePermission fetchByC_G_N_R( 355 long companyId, long groupId, java.lang.String name, long roleId) 356 throws com.liferay.portal.kernel.exception.SystemException; 357 358 /** 359 * Returns the resource type permission where companyId = ? and groupId = ? and name = ? and roleId = ? or returns <code>null</code> if it could not be found, optionally using the finder cache. 360 * 361 * @param companyId the company ID 362 * @param groupId the group ID 363 * @param name the name 364 * @param roleId the role ID 365 * @param retrieveFromCache whether to use the finder cache 366 * @return the matching resource type permission, or <code>null</code> if a matching resource type permission could not be found 367 * @throws SystemException if a system exception occurred 368 */ 369 public com.liferay.portal.model.ResourceTypePermission fetchByC_G_N_R( 370 long companyId, long groupId, java.lang.String name, long roleId, 371 boolean retrieveFromCache) 372 throws com.liferay.portal.kernel.exception.SystemException; 373 374 /** 375 * Returns all the resource type permissions. 376 * 377 * @return the resource type permissions 378 * @throws SystemException if a system exception occurred 379 */ 380 public java.util.List<com.liferay.portal.model.ResourceTypePermission> findAll() 381 throws com.liferay.portal.kernel.exception.SystemException; 382 383 /** 384 * Returns a range of all the resource type permissions. 385 * 386 * <p> 387 * 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. 388 * </p> 389 * 390 * @param start the lower bound of the range of resource type permissions 391 * @param end the upper bound of the range of resource type permissions (not inclusive) 392 * @return the range of resource type permissions 393 * @throws SystemException if a system exception occurred 394 */ 395 public java.util.List<com.liferay.portal.model.ResourceTypePermission> findAll( 396 int start, int end) 397 throws com.liferay.portal.kernel.exception.SystemException; 398 399 /** 400 * Returns an ordered range of all the resource type permissions. 401 * 402 * <p> 403 * 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. 404 * </p> 405 * 406 * @param start the lower bound of the range of resource type permissions 407 * @param end the upper bound of the range of resource type permissions (not inclusive) 408 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 409 * @return the ordered range of resource type permissions 410 * @throws SystemException if a system exception occurred 411 */ 412 public java.util.List<com.liferay.portal.model.ResourceTypePermission> findAll( 413 int start, int end, 414 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 415 throws com.liferay.portal.kernel.exception.SystemException; 416 417 /** 418 * Removes all the resource type permissions where roleId = ? from the database. 419 * 420 * @param roleId the role ID 421 * @throws SystemException if a system exception occurred 422 */ 423 public void removeByRoleId(long roleId) 424 throws com.liferay.portal.kernel.exception.SystemException; 425 426 /** 427 * Removes all the resource type permissions where companyId = ? and name = ? and roleId = ? from the database. 428 * 429 * @param companyId the company ID 430 * @param name the name 431 * @param roleId the role ID 432 * @throws SystemException if a system exception occurred 433 */ 434 public void removeByC_N_R(long companyId, java.lang.String name, long roleId) 435 throws com.liferay.portal.kernel.exception.SystemException; 436 437 /** 438 * Removes the resource type permission where companyId = ? and groupId = ? and name = ? and roleId = ? from the database. 439 * 440 * @param companyId the company ID 441 * @param groupId the group ID 442 * @param name the name 443 * @param roleId the role ID 444 * @throws SystemException if a system exception occurred 445 */ 446 public void removeByC_G_N_R(long companyId, long groupId, 447 java.lang.String name, long roleId) 448 throws com.liferay.portal.NoSuchResourceTypePermissionException, 449 com.liferay.portal.kernel.exception.SystemException; 450 451 /** 452 * Removes all the resource type permissions from the database. 453 * 454 * @throws SystemException if a system exception occurred 455 */ 456 public void removeAll() 457 throws com.liferay.portal.kernel.exception.SystemException; 458 459 /** 460 * Returns the number of resource type permissions where roleId = ?. 461 * 462 * @param roleId the role ID 463 * @return the number of matching resource type permissions 464 * @throws SystemException if a system exception occurred 465 */ 466 public int countByRoleId(long roleId) 467 throws com.liferay.portal.kernel.exception.SystemException; 468 469 /** 470 * Returns the number of resource type permissions where companyId = ? and name = ? and roleId = ?. 471 * 472 * @param companyId the company ID 473 * @param name the name 474 * @param roleId the role ID 475 * @return the number of matching resource type permissions 476 * @throws SystemException if a system exception occurred 477 */ 478 public int countByC_N_R(long companyId, java.lang.String name, long roleId) 479 throws com.liferay.portal.kernel.exception.SystemException; 480 481 /** 482 * Returns the number of resource type permissions where companyId = ? and groupId = ? and name = ? and roleId = ?. 483 * 484 * @param companyId the company ID 485 * @param groupId the group ID 486 * @param name the name 487 * @param roleId the role ID 488 * @return the number of matching resource type permissions 489 * @throws SystemException if a system exception occurred 490 */ 491 public int countByC_G_N_R(long companyId, long groupId, 492 java.lang.String name, long roleId) 493 throws com.liferay.portal.kernel.exception.SystemException; 494 495 /** 496 * Returns the number of resource type permissions. 497 * 498 * @return the number of resource type permissions 499 * @throws SystemException if a system exception occurred 500 */ 501 public int countAll() 502 throws com.liferay.portal.kernel.exception.SystemException; 503 504 public ResourceTypePermission remove( 505 ResourceTypePermission resourceTypePermission) 506 throws SystemException; 507 }