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