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.exception.PortalException; 020 import com.liferay.portal.kernel.exception.SystemException; 021 import com.liferay.portal.kernel.search.IndexableType; 022 import com.liferay.portal.kernel.transaction.Isolation; 023 import com.liferay.portal.kernel.transaction.Propagation; 024 import com.liferay.portal.kernel.transaction.Transactional; 025 import com.liferay.portal.service.BaseLocalService; 026 import com.liferay.portal.service.PersistedModelLocalService; 027 028 /** 029 * Provides the local service interface for TrashEntry. Methods of this 030 * service will not have security checks based on the propagated JAAS 031 * credentials because this service can only be accessed from within the same 032 * VM. 033 * 034 * @author Brian Wing Shun Chan 035 * @see TrashEntryLocalServiceUtil 036 * @see com.liferay.portlet.trash.service.base.TrashEntryLocalServiceBaseImpl 037 * @see com.liferay.portlet.trash.service.impl.TrashEntryLocalServiceImpl 038 * @generated 039 */ 040 @ProviderType 041 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 042 PortalException.class, SystemException.class}) 043 public interface TrashEntryLocalService extends BaseLocalService, 044 PersistedModelLocalService { 045 /* 046 * NOTE FOR DEVELOPERS: 047 * 048 * Never modify or reference this interface directly. Always use {@link TrashEntryLocalServiceUtil} to access the trash entry local service. Add custom service methods to {@link com.liferay.portlet.trash.service.impl.TrashEntryLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 049 */ 050 051 /** 052 * Adds the trash entry to the database. Also notifies the appropriate model listeners. 053 * 054 * @param trashEntry the trash entry 055 * @return the trash entry that was added 056 * @throws SystemException if a system exception occurred 057 */ 058 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 059 public com.liferay.portlet.trash.model.TrashEntry addTrashEntry( 060 com.liferay.portlet.trash.model.TrashEntry trashEntry) 061 throws com.liferay.portal.kernel.exception.SystemException; 062 063 /** 064 * Creates a new trash entry with the primary key. Does not add the trash entry to the database. 065 * 066 * @param entryId the primary key for the new trash entry 067 * @return the new trash entry 068 */ 069 public com.liferay.portlet.trash.model.TrashEntry createTrashEntry( 070 long entryId); 071 072 /** 073 * Deletes the trash entry with the primary key from the database. Also notifies the appropriate model listeners. 074 * 075 * @param entryId the primary key of the trash entry 076 * @return the trash entry that was removed 077 * @throws PortalException if a trash entry with the primary key could not be found 078 * @throws SystemException if a system exception occurred 079 */ 080 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 081 public com.liferay.portlet.trash.model.TrashEntry deleteTrashEntry( 082 long entryId) 083 throws com.liferay.portal.kernel.exception.PortalException, 084 com.liferay.portal.kernel.exception.SystemException; 085 086 /** 087 * Deletes the trash entry from the database. Also notifies the appropriate model listeners. 088 * 089 * @param trashEntry the trash entry 090 * @return the trash entry that was removed 091 * @throws SystemException if a system exception occurred 092 */ 093 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 094 public com.liferay.portlet.trash.model.TrashEntry deleteTrashEntry( 095 com.liferay.portlet.trash.model.TrashEntry trashEntry) 096 throws com.liferay.portal.kernel.exception.SystemException; 097 098 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 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 java.util.List dynamicQuery( 109 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 110 throws com.liferay.portal.kernel.exception.SystemException; 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 @SuppressWarnings("rawtypes") 126 public java.util.List dynamicQuery( 127 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 128 int end) throws com.liferay.portal.kernel.exception.SystemException; 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 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 151 /** 152 * Returns the number of rows that match the dynamic query. 153 * 154 * @param dynamicQuery the dynamic query 155 * @return the number of rows that match the dynamic query 156 * @throws SystemException if a system exception occurred 157 */ 158 public long dynamicQueryCount( 159 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 160 throws com.liferay.portal.kernel.exception.SystemException; 161 162 /** 163 * Returns the number of rows that match the dynamic query. 164 * 165 * @param dynamicQuery the dynamic query 166 * @param projection the projection to apply to the query 167 * @return the number of rows that match the dynamic query 168 * @throws SystemException if a system exception occurred 169 */ 170 public long dynamicQueryCount( 171 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 172 com.liferay.portal.kernel.dao.orm.Projection projection) 173 throws com.liferay.portal.kernel.exception.SystemException; 174 175 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 176 public com.liferay.portlet.trash.model.TrashEntry fetchTrashEntry( 177 long entryId) 178 throws com.liferay.portal.kernel.exception.SystemException; 179 180 /** 181 * Returns the trash entry with the primary key. 182 * 183 * @param entryId the primary key of the trash entry 184 * @return the trash entry 185 * @throws PortalException if a trash entry with the primary key could not be found 186 * @throws SystemException if a system exception occurred 187 */ 188 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 189 public com.liferay.portlet.trash.model.TrashEntry getTrashEntry( 190 long entryId) 191 throws com.liferay.portal.kernel.exception.PortalException, 192 com.liferay.portal.kernel.exception.SystemException; 193 194 @Override 195 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 196 public com.liferay.portal.model.PersistedModel getPersistedModel( 197 java.io.Serializable primaryKeyObj) 198 throws com.liferay.portal.kernel.exception.PortalException, 199 com.liferay.portal.kernel.exception.SystemException; 200 201 /** 202 * Returns a range of all the trash entries. 203 * 204 * <p> 205 * 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. 206 * </p> 207 * 208 * @param start the lower bound of the range of trash entries 209 * @param end the upper bound of the range of trash entries (not inclusive) 210 * @return the range of trash entries 211 * @throws SystemException if a system exception occurred 212 */ 213 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 214 public java.util.List<com.liferay.portlet.trash.model.TrashEntry> getTrashEntries( 215 int start, int end) 216 throws com.liferay.portal.kernel.exception.SystemException; 217 218 /** 219 * Returns the number of trash entries. 220 * 221 * @return the number of trash entries 222 * @throws SystemException if a system exception occurred 223 */ 224 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 225 public int getTrashEntriesCount() 226 throws com.liferay.portal.kernel.exception.SystemException; 227 228 /** 229 * Updates the trash entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 230 * 231 * @param trashEntry the trash entry 232 * @return the trash entry that was updated 233 * @throws SystemException if a system exception occurred 234 */ 235 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 236 public com.liferay.portlet.trash.model.TrashEntry updateTrashEntry( 237 com.liferay.portlet.trash.model.TrashEntry trashEntry) 238 throws com.liferay.portal.kernel.exception.SystemException; 239 240 /** 241 * Returns the Spring bean ID for this bean. 242 * 243 * @return the Spring bean ID for this bean 244 */ 245 public java.lang.String getBeanIdentifier(); 246 247 /** 248 * Sets the Spring bean ID for this bean. 249 * 250 * @param beanIdentifier the Spring bean ID for this bean 251 */ 252 public void setBeanIdentifier(java.lang.String beanIdentifier); 253 254 /** 255 * Moves an entry to trash. 256 * 257 * @param userId the primary key of the user removing the entity 258 * @param groupId the primary key of the entry's group 259 * @param className the class name of the entity 260 * @param classPK the primary key of the entity 261 * @param status the status of the entity prior to being moved to trash 262 * @param statusOVPs the primary keys and statuses of any of the entry's 263 versions (e.g., {@link 264 com.liferay.portlet.documentlibrary.model.DLFileVersion}) 265 * @param typeSettingsProperties the type settings properties 266 * @return the trashEntry 267 * @throws PortalException if a user with the primary key could not be found 268 * @throws SystemException if a system exception occurred 269 */ 270 public com.liferay.portlet.trash.model.TrashEntry addTrashEntry( 271 long userId, long groupId, java.lang.String className, long classPK, 272 java.lang.String classUuid, java.lang.String referrerClassName, 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 279 public void checkEntries() 280 throws com.liferay.portal.kernel.exception.PortalException, 281 com.liferay.portal.kernel.exception.SystemException; 282 283 /** 284 * Deletes the trash entry with the primary key. 285 * 286 * @param entryId the primary key of the trash entry 287 * @return the trash entry with the primary key 288 * @throws PortalException if a trash entry with the primary key could not 289 be found 290 * @throws SystemException if a system exception occurred 291 */ 292 public com.liferay.portlet.trash.model.TrashEntry deleteEntry(long entryId) 293 throws com.liferay.portal.kernel.exception.PortalException, 294 com.liferay.portal.kernel.exception.SystemException; 295 296 /** 297 * Deletes the trash entry with the entity class name and primary key. 298 * 299 * @param className the class name of entity 300 * @param classPK the primary key of the entry 301 * @return the trash entry with the entity class name and primary key 302 * @throws PortalException if a trash entry with the primary key could not 303 be found 304 * @throws SystemException if a system exception occurred 305 */ 306 public com.liferay.portlet.trash.model.TrashEntry deleteEntry( 307 java.lang.String className, long classPK) 308 throws com.liferay.portal.kernel.exception.PortalException, 309 com.liferay.portal.kernel.exception.SystemException; 310 311 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 312 public com.liferay.portlet.trash.model.TrashEntry deleteEntry( 313 com.liferay.portlet.trash.model.TrashEntry trashEntry) 314 throws com.liferay.portal.kernel.exception.SystemException; 315 316 /** 317 * Returns the trash entry with the primary key. 318 * 319 * @param entryId the primary key of the entry 320 * @return the trash entry with the primary key 321 * @throws SystemException if a system exception occurred 322 */ 323 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 324 public com.liferay.portlet.trash.model.TrashEntry fetchEntry(long entryId) 325 throws com.liferay.portal.kernel.exception.SystemException; 326 327 /** 328 * Returns the trash entry with the entity class name and primary key. 329 * 330 * @param className the class name of the entity 331 * @param classPK the primary key of the entity 332 * @return the trash entry with the entity class name and primary key 333 * @throws SystemException if a system exception occurred 334 */ 335 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 336 public com.liferay.portlet.trash.model.TrashEntry fetchEntry( 337 java.lang.String className, long classPK) 338 throws com.liferay.portal.kernel.exception.SystemException; 339 340 /** 341 * Returns the trash entries with the matching group ID. 342 * 343 * @param groupId the primary key of the group 344 * @return the trash entries with the group ID 345 * @throws SystemException if a system exception occurred 346 */ 347 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 348 public java.util.List<com.liferay.portlet.trash.model.TrashEntry> getEntries( 349 long groupId) 350 throws com.liferay.portal.kernel.exception.SystemException; 351 352 /** 353 * Returns a range of all the trash entries matching the group ID. 354 * 355 * @param groupId the primary key of the group 356 * @param start the lower bound of the range of trash entries to return 357 * @param end the upper bound of the range of trash entries to return (not 358 inclusive) 359 * @return the range of matching trash entries 360 * @throws SystemException if a system exception occurred 361 */ 362 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 363 public java.util.List<com.liferay.portlet.trash.model.TrashEntry> getEntries( 364 long groupId, int start, int end) 365 throws com.liferay.portal.kernel.exception.SystemException; 366 367 /** 368 * Returns a range of all the trash entries matching the group ID. 369 * 370 * @param groupId the primary key of the group 371 * @param start the lower bound of the range of trash entries to return 372 * @param end the upper bound of the range of trash entries to return (not 373 inclusive) 374 * @param obc the comparator to order the trash entries (optionally 375 <code>null</code>) 376 * @return the range of matching trash entries ordered by comparator 377 <code>obc</code> 378 * @throws SystemException if a system exception occurred 379 */ 380 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 381 public java.util.List<com.liferay.portlet.trash.model.TrashEntry> getEntries( 382 long groupId, int start, int end, 383 com.liferay.portal.kernel.util.OrderByComparator obc) 384 throws com.liferay.portal.kernel.exception.SystemException; 385 386 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 387 public java.util.List<com.liferay.portlet.trash.model.TrashEntry> getEntries( 388 long groupId, java.lang.String className) 389 throws com.liferay.portal.kernel.exception.SystemException; 390 391 /** 392 * Returns the number of trash entries with the group ID. 393 * 394 * @param groupId the primary key of the group 395 * @return the number of matching trash entries 396 * @throws SystemException if a system exception occurred 397 */ 398 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 399 public int getEntriesCount(long groupId) 400 throws com.liferay.portal.kernel.exception.SystemException; 401 402 /** 403 * Returns the trash entry with the primary key. 404 * 405 * @param entryId the primary key of the trash entry 406 * @return the trash entry with the primary key 407 * @throws PortalException if a trash entry with the primary key could not 408 be found 409 * @throws SystemException if a system exception occurred 410 */ 411 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 412 public com.liferay.portlet.trash.model.TrashEntry getEntry(long entryId) 413 throws com.liferay.portal.kernel.exception.PortalException, 414 com.liferay.portal.kernel.exception.SystemException; 415 416 /** 417 * Returns the entry with the entity class name and primary key. 418 * 419 * @param className the class name of the entity 420 * @param classPK the primary key of the entity 421 * @return the trash entry with the entity class name and primary key 422 * @throws PortalException if a trash entry with the primary key could not 423 be found 424 * @throws SystemException if a system exception occurred 425 */ 426 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 427 public com.liferay.portlet.trash.model.TrashEntry getEntry( 428 java.lang.String className, long classPK) 429 throws com.liferay.portal.kernel.exception.PortalException, 430 com.liferay.portal.kernel.exception.SystemException; 431 432 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 433 public com.liferay.portal.kernel.search.Hits search(long companyId, 434 long groupId, long userId, java.lang.String keywords, int start, 435 int end, com.liferay.portal.kernel.search.Sort sort) 436 throws com.liferay.portal.kernel.exception.SystemException; 437 }