001 /** 002 * Copyright (c) 2000-present 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.trash.kernel.service; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery; 020 import com.liferay.portal.kernel.dao.orm.DynamicQuery; 021 import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery; 022 import com.liferay.portal.kernel.dao.orm.Projection; 023 import com.liferay.portal.kernel.exception.PortalException; 024 import com.liferay.portal.kernel.exception.SystemException; 025 import com.liferay.portal.kernel.model.PersistedModel; 026 import com.liferay.portal.kernel.search.Indexable; 027 import com.liferay.portal.kernel.search.IndexableType; 028 import com.liferay.portal.kernel.service.BaseLocalService; 029 import com.liferay.portal.kernel.service.PersistedModelLocalService; 030 import com.liferay.portal.kernel.transaction.Isolation; 031 import com.liferay.portal.kernel.transaction.Propagation; 032 import com.liferay.portal.kernel.transaction.Transactional; 033 import com.liferay.portal.kernel.util.OrderByComparator; 034 import com.liferay.portal.kernel.util.UnicodeProperties; 035 036 import com.liferay.trash.kernel.model.TrashVersion; 037 038 import java.io.Serializable; 039 040 import java.util.List; 041 042 /** 043 * Provides the local service interface for TrashVersion. Methods of this 044 * service will not have security checks based on the propagated JAAS 045 * credentials because this service can only be accessed from within the same 046 * VM. 047 * 048 * @author Brian Wing Shun Chan 049 * @see TrashVersionLocalServiceUtil 050 * @see com.liferay.portlet.trash.service.base.TrashVersionLocalServiceBaseImpl 051 * @see com.liferay.portlet.trash.service.impl.TrashVersionLocalServiceImpl 052 * @generated 053 */ 054 @ProviderType 055 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 056 PortalException.class, SystemException.class}) 057 public interface TrashVersionLocalService extends BaseLocalService, 058 PersistedModelLocalService { 059 /* 060 * NOTE FOR DEVELOPERS: 061 * 062 * Never modify or reference this interface directly. Always use {@link TrashVersionLocalServiceUtil} to access the trash version local service. Add custom service methods to {@link com.liferay.portlet.trash.service.impl.TrashVersionLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 063 */ 064 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 065 public ActionableDynamicQuery getActionableDynamicQuery(); 066 067 public DynamicQuery dynamicQuery(); 068 069 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 070 public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); 071 072 /** 073 * @throws PortalException 074 */ 075 @Override 076 public PersistedModel deletePersistedModel(PersistedModel persistedModel) 077 throws PortalException; 078 079 @Override 080 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 081 public PersistedModel getPersistedModel(Serializable primaryKeyObj) 082 throws PortalException; 083 084 /** 085 * Adds the trash version to the database. Also notifies the appropriate model listeners. 086 * 087 * @param trashVersion the trash version 088 * @return the trash version that was added 089 */ 090 @Indexable(type = IndexableType.REINDEX) 091 public TrashVersion addTrashVersion(TrashVersion trashVersion); 092 093 public TrashVersion addTrashVersion(long trashEntryId, 094 java.lang.String className, long classPK, int status, 095 UnicodeProperties typeSettingsProperties); 096 097 /** 098 * Creates a new trash version with the primary key. Does not add the trash version to the database. 099 * 100 * @param versionId the primary key for the new trash version 101 * @return the new trash version 102 */ 103 public TrashVersion createTrashVersion(long versionId); 104 105 /** 106 * Deletes the trash version from the database. Also notifies the appropriate model listeners. 107 * 108 * @param trashVersion the trash version 109 * @return the trash version that was removed 110 */ 111 @Indexable(type = IndexableType.DELETE) 112 public TrashVersion deleteTrashVersion(TrashVersion trashVersion); 113 114 public TrashVersion deleteTrashVersion(java.lang.String className, 115 long classPK); 116 117 /** 118 * Deletes the trash version with the primary key from the database. Also notifies the appropriate model listeners. 119 * 120 * @param versionId the primary key of the trash version 121 * @return the trash version that was removed 122 * @throws PortalException if a trash version with the primary key could not be found 123 */ 124 @Indexable(type = IndexableType.DELETE) 125 public TrashVersion deleteTrashVersion(long versionId) 126 throws PortalException; 127 128 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 129 public TrashVersion fetchTrashVersion(long versionId); 130 131 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 132 public TrashVersion fetchVersion(java.lang.String className, long classPK); 133 134 /** 135 * @deprecated As of 7.0.0, replaced by {@link #fetchVersion(String, long)} 136 */ 137 @java.lang.Deprecated 138 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 139 public TrashVersion fetchVersion(long entryId, java.lang.String className, 140 long classPK); 141 142 /** 143 * Returns the trash version with the primary key. 144 * 145 * @param versionId the primary key of the trash version 146 * @return the trash version 147 * @throws PortalException if a trash version with the primary key could not be found 148 */ 149 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 150 public TrashVersion getTrashVersion(long versionId) 151 throws PortalException; 152 153 /** 154 * Updates the trash version in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 155 * 156 * @param trashVersion the trash version 157 * @return the trash version that was updated 158 */ 159 @Indexable(type = IndexableType.REINDEX) 160 public TrashVersion updateTrashVersion(TrashVersion trashVersion); 161 162 /** 163 * Returns the number of trash versions. 164 * 165 * @return the number of trash versions 166 */ 167 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 168 public int getTrashVersionsCount(); 169 170 /** 171 * Returns the OSGi service identifier. 172 * 173 * @return the OSGi service identifier 174 */ 175 public java.lang.String getOSGiServiceIdentifier(); 176 177 /** 178 * Performs a dynamic query on the database and returns the matching rows. 179 * 180 * @param dynamicQuery the dynamic query 181 * @return the matching rows 182 */ 183 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery); 184 185 /** 186 * Performs a dynamic query on the database and returns a range of the matching rows. 187 * 188 * <p> 189 * 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.TrashVersionModelImpl}. 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. 190 * </p> 191 * 192 * @param dynamicQuery the dynamic query 193 * @param start the lower bound of the range of model instances 194 * @param end the upper bound of the range of model instances (not inclusive) 195 * @return the range of matching rows 196 */ 197 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, 198 int end); 199 200 /** 201 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 202 * 203 * <p> 204 * 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.TrashVersionModelImpl}. 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. 205 * </p> 206 * 207 * @param dynamicQuery the dynamic query 208 * @param start the lower bound of the range of model instances 209 * @param end the upper bound of the range of model instances (not inclusive) 210 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 211 * @return the ordered range of matching rows 212 */ 213 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, 214 int end, OrderByComparator<T> orderByComparator); 215 216 /** 217 * Returns a range of all the trash versions. 218 * 219 * <p> 220 * 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.TrashVersionModelImpl}. 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. 221 * </p> 222 * 223 * @param start the lower bound of the range of trash versions 224 * @param end the upper bound of the range of trash versions (not inclusive) 225 * @return the range of trash versions 226 */ 227 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 228 public List<TrashVersion> getTrashVersions(int start, int end); 229 230 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 231 public List<TrashVersion> getVersions(long entryId); 232 233 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 234 public List<TrashVersion> getVersions(long entryId, 235 java.lang.String className); 236 237 /** 238 * Returns the number of rows matching the dynamic query. 239 * 240 * @param dynamicQuery the dynamic query 241 * @return the number of rows matching the dynamic query 242 */ 243 public long dynamicQueryCount(DynamicQuery dynamicQuery); 244 245 /** 246 * Returns the number of rows matching the dynamic query. 247 * 248 * @param dynamicQuery the dynamic query 249 * @param projection the projection to apply to the query 250 * @return the number of rows matching the dynamic query 251 */ 252 public long dynamicQueryCount(DynamicQuery dynamicQuery, 253 Projection projection); 254 }