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.portlet.trash.service; 016 017 import com.liferay.portal.service.ServiceWrapper; 018 019 /** 020 * Provides a wrapper for {@link TrashEntryLocalService}. 021 * 022 * @author Brian Wing Shun Chan 023 * @see TrashEntryLocalService 024 * @generated 025 */ 026 public class TrashEntryLocalServiceWrapper implements TrashEntryLocalService, 027 ServiceWrapper<TrashEntryLocalService> { 028 public TrashEntryLocalServiceWrapper( 029 TrashEntryLocalService trashEntryLocalService) { 030 _trashEntryLocalService = trashEntryLocalService; 031 } 032 033 /** 034 * Adds the trash entry to the database. Also notifies the appropriate model listeners. 035 * 036 * @param trashEntry the trash entry 037 * @return the trash entry that was added 038 * @throws SystemException if a system exception occurred 039 */ 040 @Override 041 public com.liferay.portlet.trash.model.TrashEntry addTrashEntry( 042 com.liferay.portlet.trash.model.TrashEntry trashEntry) 043 throws com.liferay.portal.kernel.exception.SystemException { 044 return _trashEntryLocalService.addTrashEntry(trashEntry); 045 } 046 047 /** 048 * Creates a new trash entry with the primary key. Does not add the trash entry to the database. 049 * 050 * @param entryId the primary key for the new trash entry 051 * @return the new trash entry 052 */ 053 @Override 054 public com.liferay.portlet.trash.model.TrashEntry createTrashEntry( 055 long entryId) { 056 return _trashEntryLocalService.createTrashEntry(entryId); 057 } 058 059 /** 060 * Deletes the trash entry with the primary key from the database. Also notifies the appropriate model listeners. 061 * 062 * @param entryId the primary key of the trash entry 063 * @return the trash entry that was removed 064 * @throws PortalException if a trash entry with the primary key could not be found 065 * @throws SystemException if a system exception occurred 066 */ 067 @Override 068 public com.liferay.portlet.trash.model.TrashEntry deleteTrashEntry( 069 long entryId) 070 throws com.liferay.portal.kernel.exception.PortalException, 071 com.liferay.portal.kernel.exception.SystemException { 072 return _trashEntryLocalService.deleteTrashEntry(entryId); 073 } 074 075 /** 076 * Deletes the trash entry from the database. Also notifies the appropriate model listeners. 077 * 078 * @param trashEntry the trash entry 079 * @return the trash entry that was removed 080 * @throws SystemException if a system exception occurred 081 */ 082 @Override 083 public com.liferay.portlet.trash.model.TrashEntry deleteTrashEntry( 084 com.liferay.portlet.trash.model.TrashEntry trashEntry) 085 throws com.liferay.portal.kernel.exception.SystemException { 086 return _trashEntryLocalService.deleteTrashEntry(trashEntry); 087 } 088 089 @Override 090 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() { 091 return _trashEntryLocalService.dynamicQuery(); 092 } 093 094 /** 095 * Performs a dynamic query on the database and returns the matching rows. 096 * 097 * @param dynamicQuery the dynamic query 098 * @return the matching rows 099 * @throws SystemException if a system exception occurred 100 */ 101 @Override 102 @SuppressWarnings("rawtypes") 103 public java.util.List dynamicQuery( 104 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 105 throws com.liferay.portal.kernel.exception.SystemException { 106 return _trashEntryLocalService.dynamicQuery(dynamicQuery); 107 } 108 109 /** 110 * Performs a dynamic query on the database and returns a range of the matching rows. 111 * 112 * <p> 113 * 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.portlet.trash.model.impl.TrashEntryModelImpl}. 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. 114 * </p> 115 * 116 * @param dynamicQuery the dynamic query 117 * @param start the lower bound of the range of model instances 118 * @param end the upper bound of the range of model instances (not inclusive) 119 * @return the range of matching rows 120 * @throws SystemException if a system exception occurred 121 */ 122 @Override 123 @SuppressWarnings("rawtypes") 124 public java.util.List dynamicQuery( 125 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 126 int end) throws com.liferay.portal.kernel.exception.SystemException { 127 return _trashEntryLocalService.dynamicQuery(dynamicQuery, start, end); 128 } 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.portlet.trash.model.impl.TrashEntryModelImpl}. 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 * @throws SystemException if a system exception occurred 143 */ 144 @Override 145 @SuppressWarnings("rawtypes") 146 public java.util.List dynamicQuery( 147 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 148 int end, 149 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 150 throws com.liferay.portal.kernel.exception.SystemException { 151 return _trashEntryLocalService.dynamicQuery(dynamicQuery, start, end, 152 orderByComparator); 153 } 154 155 /** 156 * Returns the number of rows that match the dynamic query. 157 * 158 * @param dynamicQuery the dynamic query 159 * @return the number of rows that match the dynamic query 160 * @throws SystemException if a system exception occurred 161 */ 162 @Override 163 public long dynamicQueryCount( 164 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 165 throws com.liferay.portal.kernel.exception.SystemException { 166 return _trashEntryLocalService.dynamicQueryCount(dynamicQuery); 167 } 168 169 /** 170 * Returns the number of rows that match the dynamic query. 171 * 172 * @param dynamicQuery the dynamic query 173 * @param projection the projection to apply to the query 174 * @return the number of rows that match the dynamic query 175 * @throws SystemException if a system exception occurred 176 */ 177 @Override 178 public long dynamicQueryCount( 179 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 180 com.liferay.portal.kernel.dao.orm.Projection projection) 181 throws com.liferay.portal.kernel.exception.SystemException { 182 return _trashEntryLocalService.dynamicQueryCount(dynamicQuery, 183 projection); 184 } 185 186 @Override 187 public com.liferay.portlet.trash.model.TrashEntry fetchTrashEntry( 188 long entryId) 189 throws com.liferay.portal.kernel.exception.SystemException { 190 return _trashEntryLocalService.fetchTrashEntry(entryId); 191 } 192 193 /** 194 * Returns the trash entry with the primary key. 195 * 196 * @param entryId the primary key of the trash entry 197 * @return the trash entry 198 * @throws PortalException if a trash entry with the primary key could not be found 199 * @throws SystemException if a system exception occurred 200 */ 201 @Override 202 public com.liferay.portlet.trash.model.TrashEntry getTrashEntry( 203 long entryId) 204 throws com.liferay.portal.kernel.exception.PortalException, 205 com.liferay.portal.kernel.exception.SystemException { 206 return _trashEntryLocalService.getTrashEntry(entryId); 207 } 208 209 @Override 210 public com.liferay.portal.model.PersistedModel getPersistedModel( 211 java.io.Serializable primaryKeyObj) 212 throws com.liferay.portal.kernel.exception.PortalException, 213 com.liferay.portal.kernel.exception.SystemException { 214 return _trashEntryLocalService.getPersistedModel(primaryKeyObj); 215 } 216 217 /** 218 * Returns a range of all the trash entries. 219 * 220 * <p> 221 * 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.portlet.trash.model.impl.TrashEntryModelImpl}. 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. 222 * </p> 223 * 224 * @param start the lower bound of the range of trash entries 225 * @param end the upper bound of the range of trash entries (not inclusive) 226 * @return the range of trash entries 227 * @throws SystemException if a system exception occurred 228 */ 229 @Override 230 public java.util.List<com.liferay.portlet.trash.model.TrashEntry> getTrashEntries( 231 int start, int end) 232 throws com.liferay.portal.kernel.exception.SystemException { 233 return _trashEntryLocalService.getTrashEntries(start, end); 234 } 235 236 /** 237 * Returns the number of trash entries. 238 * 239 * @return the number of trash entries 240 * @throws SystemException if a system exception occurred 241 */ 242 @Override 243 public int getTrashEntriesCount() 244 throws com.liferay.portal.kernel.exception.SystemException { 245 return _trashEntryLocalService.getTrashEntriesCount(); 246 } 247 248 /** 249 * Updates the trash entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 250 * 251 * @param trashEntry the trash entry 252 * @return the trash entry that was updated 253 * @throws SystemException if a system exception occurred 254 */ 255 @Override 256 public com.liferay.portlet.trash.model.TrashEntry updateTrashEntry( 257 com.liferay.portlet.trash.model.TrashEntry trashEntry) 258 throws com.liferay.portal.kernel.exception.SystemException { 259 return _trashEntryLocalService.updateTrashEntry(trashEntry); 260 } 261 262 /** 263 * Returns the Spring bean ID for this bean. 264 * 265 * @return the Spring bean ID for this bean 266 */ 267 @Override 268 public java.lang.String getBeanIdentifier() { 269 return _trashEntryLocalService.getBeanIdentifier(); 270 } 271 272 /** 273 * Sets the Spring bean ID for this bean. 274 * 275 * @param beanIdentifier the Spring bean ID for this bean 276 */ 277 @Override 278 public void setBeanIdentifier(java.lang.String beanIdentifier) { 279 _trashEntryLocalService.setBeanIdentifier(beanIdentifier); 280 } 281 282 /** 283 * Moves an entry to trash. 284 * 285 * @param userId the primary key of the user removing the entity 286 * @param groupId the primary key of the entry's group 287 * @param className the class name of the entity 288 * @param classPK the primary key of the entity 289 * @param status the status of the entity prior to being moved to trash 290 * @param statusOVPs the primary keys and statuses of any of the entry's 291 versions (e.g., {@link 292 com.liferay.portlet.documentlibrary.model.DLFileVersion}) 293 * @param typeSettingsProperties the type settings properties 294 * @return the trashEntry 295 * @throws PortalException if a user with the primary key could not be found 296 * @throws SystemException if a system exception occurred 297 */ 298 @Override 299 public com.liferay.portlet.trash.model.TrashEntry addTrashEntry( 300 long userId, long groupId, java.lang.String className, long classPK, 301 int status, 302 java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.Long, java.lang.Integer>> statusOVPs, 303 com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties) 304 throws com.liferay.portal.kernel.exception.PortalException, 305 com.liferay.portal.kernel.exception.SystemException { 306 return _trashEntryLocalService.addTrashEntry(userId, groupId, 307 className, classPK, status, statusOVPs, typeSettingsProperties); 308 } 309 310 @Override 311 public void checkEntries() 312 throws com.liferay.portal.kernel.exception.PortalException, 313 com.liferay.portal.kernel.exception.SystemException { 314 _trashEntryLocalService.checkEntries(); 315 } 316 317 /** 318 * Deletes the trash entry with the primary key. 319 * 320 * @param entryId the primary key of the trash entry 321 * @return the trash entry with the primary key 322 * @throws PortalException if a trash entry with the primary key could not 323 be found 324 * @throws SystemException if a system exception occurred 325 */ 326 @Override 327 public com.liferay.portlet.trash.model.TrashEntry deleteEntry(long entryId) 328 throws com.liferay.portal.kernel.exception.PortalException, 329 com.liferay.portal.kernel.exception.SystemException { 330 return _trashEntryLocalService.deleteEntry(entryId); 331 } 332 333 /** 334 * Deletes the trash entry with the entity class name and primary key. 335 * 336 * @param className the class name of entity 337 * @param classPK the primary key of the entry 338 * @return the trash entry with the entity class name and primary key 339 * @throws PortalException if a trash entry with the primary key could not 340 be found 341 * @throws SystemException if a system exception occurred 342 */ 343 @Override 344 public com.liferay.portlet.trash.model.TrashEntry deleteEntry( 345 java.lang.String className, long classPK) 346 throws com.liferay.portal.kernel.exception.PortalException, 347 com.liferay.portal.kernel.exception.SystemException { 348 return _trashEntryLocalService.deleteEntry(className, classPK); 349 } 350 351 @Override 352 public com.liferay.portlet.trash.model.TrashEntry deleteEntry( 353 com.liferay.portlet.trash.model.TrashEntry trashEntry) 354 throws com.liferay.portal.kernel.exception.SystemException { 355 return _trashEntryLocalService.deleteEntry(trashEntry); 356 } 357 358 /** 359 * Returns the trash entry with the primary key. 360 * 361 * @param entryId the primary key of the entry 362 * @return the trash entry with the primary key 363 * @throws SystemException if a system exception occurred 364 */ 365 @Override 366 public com.liferay.portlet.trash.model.TrashEntry fetchEntry(long entryId) 367 throws com.liferay.portal.kernel.exception.SystemException { 368 return _trashEntryLocalService.fetchEntry(entryId); 369 } 370 371 /** 372 * Returns the trash entry with the entity class name and primary key. 373 * 374 * @param className the class name of the entity 375 * @param classPK the primary key of the entity 376 * @return the trash entry with the entity class name and primary key 377 * @throws SystemException if a system exception occurred 378 */ 379 @Override 380 public com.liferay.portlet.trash.model.TrashEntry fetchEntry( 381 java.lang.String className, long classPK) 382 throws com.liferay.portal.kernel.exception.SystemException { 383 return _trashEntryLocalService.fetchEntry(className, classPK); 384 } 385 386 /** 387 * Returns the trash entries with the matching group ID. 388 * 389 * @param groupId the primary key of the group 390 * @return the trash entries with the group ID 391 * @throws SystemException if a system exception occurred 392 */ 393 @Override 394 public java.util.List<com.liferay.portlet.trash.model.TrashEntry> getEntries( 395 long groupId) 396 throws com.liferay.portal.kernel.exception.SystemException { 397 return _trashEntryLocalService.getEntries(groupId); 398 } 399 400 /** 401 * Returns a range of all the trash entries matching the group ID. 402 * 403 * @param groupId the primary key of the group 404 * @param start the lower bound of the range of trash entries to return 405 * @param end the upper bound of the range of trash entries to return (not 406 inclusive) 407 * @return the range of matching trash entries 408 * @throws SystemException if a system exception occurred 409 */ 410 @Override 411 public java.util.List<com.liferay.portlet.trash.model.TrashEntry> getEntries( 412 long groupId, int start, int end) 413 throws com.liferay.portal.kernel.exception.SystemException { 414 return _trashEntryLocalService.getEntries(groupId, start, end); 415 } 416 417 /** 418 * Returns a range of all the trash entries matching the group ID. 419 * 420 * @param groupId the primary key of the group 421 * @param start the lower bound of the range of trash entries to return 422 * @param end the upper bound of the range of trash entries to return (not 423 inclusive) 424 * @param obc the comparator to order the trash entries (optionally 425 <code>null</code>) 426 * @return the range of matching trash entries ordered by comparator 427 <code>obc</code> 428 * @throws SystemException if a system exception occurred 429 */ 430 @Override 431 public java.util.List<com.liferay.portlet.trash.model.TrashEntry> getEntries( 432 long groupId, int start, int end, 433 com.liferay.portal.kernel.util.OrderByComparator obc) 434 throws com.liferay.portal.kernel.exception.SystemException { 435 return _trashEntryLocalService.getEntries(groupId, start, end, obc); 436 } 437 438 /** 439 * Returns the number of trash entries with the group ID. 440 * 441 * @param groupId the primary key of the group 442 * @return the number of matching trash entries 443 * @throws SystemException if a system exception occurred 444 */ 445 @Override 446 public int getEntriesCount(long groupId) 447 throws com.liferay.portal.kernel.exception.SystemException { 448 return _trashEntryLocalService.getEntriesCount(groupId); 449 } 450 451 /** 452 * Returns the trash entry with the primary key. 453 * 454 * @param entryId the primary key of the trash entry 455 * @return the trash entry with the primary key 456 * @throws PortalException if a trash entry with the primary key could not 457 be found 458 * @throws SystemException if a system exception occurred 459 */ 460 @Override 461 public com.liferay.portlet.trash.model.TrashEntry getEntry(long entryId) 462 throws com.liferay.portal.kernel.exception.PortalException, 463 com.liferay.portal.kernel.exception.SystemException { 464 return _trashEntryLocalService.getEntry(entryId); 465 } 466 467 /** 468 * Returns the entry with the entity class name and primary key. 469 * 470 * @param className the class name of the entity 471 * @param classPK the primary key of the entity 472 * @return the trash entry with the entity class name and primary key 473 * @throws PortalException if a trash entry with the primary key could not 474 be found 475 * @throws SystemException if a system exception occurred 476 */ 477 @Override 478 public com.liferay.portlet.trash.model.TrashEntry getEntry( 479 java.lang.String className, long classPK) 480 throws com.liferay.portal.kernel.exception.PortalException, 481 com.liferay.portal.kernel.exception.SystemException { 482 return _trashEntryLocalService.getEntry(className, classPK); 483 } 484 485 /** 486 * Returns all the trash versions associated with the trash entry. 487 * 488 * @param entryId the primary key of the trash entry 489 * @return all the trash versions associated with the trash entry 490 * @throws SystemException if a system exception occurred 491 */ 492 @Override 493 public java.util.List<com.liferay.portlet.trash.model.TrashVersion> getVersions( 494 long entryId) 495 throws com.liferay.portal.kernel.exception.SystemException { 496 return _trashEntryLocalService.getVersions(entryId); 497 } 498 499 /** 500 * Returns all the trash versions associated with the trash entry. 501 * 502 * @param className the class name of the trash entity 503 * @param classPK the primary key of the trash entity 504 * @return all the trash versions associated with the trash entry 505 * @throws SystemException if a system exception occurred 506 */ 507 @Override 508 public java.util.List<com.liferay.portlet.trash.model.TrashVersion> getVersions( 509 java.lang.String className, long classPK) 510 throws com.liferay.portal.kernel.exception.SystemException { 511 return _trashEntryLocalService.getVersions(className, classPK); 512 } 513 514 @Override 515 public com.liferay.portal.kernel.search.Hits search(long companyId, 516 long groupId, long userId, java.lang.String keywords, int start, 517 int end, com.liferay.portal.kernel.search.Sort sort) 518 throws com.liferay.portal.kernel.exception.SystemException { 519 return _trashEntryLocalService.search(companyId, groupId, userId, 520 keywords, start, end, sort); 521 } 522 523 /** 524 * @deprecated As of 6.1.0, replaced by {@link #getWrappedService} 525 */ 526 public TrashEntryLocalService getWrappedTrashEntryLocalService() { 527 return _trashEntryLocalService; 528 } 529 530 /** 531 * @deprecated As of 6.1.0, replaced by {@link #setWrappedService} 532 */ 533 public void setWrappedTrashEntryLocalService( 534 TrashEntryLocalService trashEntryLocalService) { 535 _trashEntryLocalService = trashEntryLocalService; 536 } 537 538 @Override 539 public TrashEntryLocalService getWrappedService() { 540 return _trashEntryLocalService; 541 } 542 543 @Override 544 public void setWrappedService(TrashEntryLocalService trashEntryLocalService) { 545 _trashEntryLocalService = trashEntryLocalService; 546 } 547 548 private TrashEntryLocalService _trashEntryLocalService; 549 }