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