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