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