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.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 TrashVersion. 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 TrashVersionLocalServiceUtil
036     * @see com.liferay.portlet.trash.service.base.TrashVersionLocalServiceBaseImpl
037     * @see com.liferay.portlet.trash.service.impl.TrashVersionLocalServiceImpl
038     * @generated
039     */
040    @ProviderType
041    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
042            PortalException.class, SystemException.class})
043    public interface TrashVersionLocalService extends BaseLocalService,
044            PersistedModelLocalService {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * 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.
049             */
050            public com.liferay.portlet.trash.model.TrashVersion addTrashVersion(
051                    long trashEntryId, java.lang.String className, long classPK,
052                    int status,
053                    com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties);
054    
055            /**
056            * Adds the trash version to the database. Also notifies the appropriate model listeners.
057            *
058            * @param trashVersion the trash version
059            * @return the trash version that was added
060            */
061            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
062            public com.liferay.portlet.trash.model.TrashVersion addTrashVersion(
063                    com.liferay.portlet.trash.model.TrashVersion trashVersion);
064    
065            /**
066            * Creates a new trash version with the primary key. Does not add the trash version to the database.
067            *
068            * @param versionId the primary key for the new trash version
069            * @return the new trash version
070            */
071            public com.liferay.portlet.trash.model.TrashVersion createTrashVersion(
072                    long versionId);
073    
074            /**
075            * @throws PortalException
076            */
077            @Override
078            public com.liferay.portal.model.PersistedModel deletePersistedModel(
079                    com.liferay.portal.model.PersistedModel persistedModel)
080                    throws PortalException;
081    
082            public com.liferay.portlet.trash.model.TrashVersion deleteTrashVersion(
083                    java.lang.String className, long classPK);
084    
085            /**
086            * Deletes the trash version from the database. Also notifies the appropriate model listeners.
087            *
088            * @param trashVersion the trash version
089            * @return the trash version that was removed
090            */
091            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
092            public com.liferay.portlet.trash.model.TrashVersion deleteTrashVersion(
093                    com.liferay.portlet.trash.model.TrashVersion trashVersion);
094    
095            /**
096            * Deletes the trash version with the primary key from the database. Also notifies the appropriate model listeners.
097            *
098            * @param versionId the primary key of the trash version
099            * @return the trash version that was removed
100            * @throws PortalException if a trash version with the primary key could not be found
101            */
102            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
103            public com.liferay.portlet.trash.model.TrashVersion deleteTrashVersion(
104                    long versionId) throws PortalException;
105    
106            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
107    
108            /**
109            * Performs a dynamic query on the database and returns the matching rows.
110            *
111            * @param dynamicQuery the dynamic query
112            * @return the matching rows
113            */
114            public <T> java.util.List<T> dynamicQuery(
115                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
116    
117            /**
118            * Performs a dynamic query on the database and returns a range of the matching rows.
119            *
120            * <p>
121            * 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.
122            * </p>
123            *
124            * @param dynamicQuery the dynamic query
125            * @param start the lower bound of the range of model instances
126            * @param end the upper bound of the range of model instances (not inclusive)
127            * @return the range of matching rows
128            */
129            public <T> java.util.List<T> dynamicQuery(
130                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
131                    int end);
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.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.
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            */
146            public <T> java.util.List<T> dynamicQuery(
147                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
148                    int end,
149                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
150    
151            /**
152            * Returns the number of rows matching the dynamic query.
153            *
154            * @param dynamicQuery the dynamic query
155            * @return the number of rows matching the dynamic query
156            */
157            public long dynamicQueryCount(
158                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
159    
160            /**
161            * Returns the number of rows matching the dynamic query.
162            *
163            * @param dynamicQuery the dynamic query
164            * @param projection the projection to apply to the query
165            * @return the number of rows matching the dynamic query
166            */
167            public long dynamicQueryCount(
168                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
169                    com.liferay.portal.kernel.dao.orm.Projection projection);
170    
171            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
172            public com.liferay.portlet.trash.model.TrashVersion fetchTrashVersion(
173                    long versionId);
174    
175            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
176            public com.liferay.portlet.trash.model.TrashVersion fetchVersion(
177                    java.lang.String className, long classPK);
178    
179            /**
180            * @deprecated As of 7.0.0, replaced by {@link #fetchVersion(String, long)}
181            */
182            @java.lang.Deprecated
183            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184            public com.liferay.portlet.trash.model.TrashVersion fetchVersion(
185                    long entryId, java.lang.String className, long classPK);
186    
187            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
188            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
189    
190            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
191            public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
192    
193            /**
194            * Returns the OSGi service identifier.
195            *
196            * @return the OSGi service identifier
197            */
198            public java.lang.String getOSGiServiceIdentifier();
199    
200            @Override
201            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
202            public com.liferay.portal.model.PersistedModel getPersistedModel(
203                    java.io.Serializable primaryKeyObj) throws PortalException;
204    
205            /**
206            * Returns the trash version with the primary key.
207            *
208            * @param versionId the primary key of the trash version
209            * @return the trash version
210            * @throws PortalException if a trash version with the primary key could not be found
211            */
212            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
213            public com.liferay.portlet.trash.model.TrashVersion getTrashVersion(
214                    long versionId) throws PortalException;
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 java.util.List<com.liferay.portlet.trash.model.TrashVersion> getTrashVersions(
229                    int start, int end);
230    
231            /**
232            * Returns the number of trash versions.
233            *
234            * @return the number of trash versions
235            */
236            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
237            public int getTrashVersionsCount();
238    
239            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
240            public java.util.List<com.liferay.portlet.trash.model.TrashVersion> getVersions(
241                    long entryId);
242    
243            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
244            public java.util.List<com.liferay.portlet.trash.model.TrashVersion> getVersions(
245                    long entryId, java.lang.String className);
246    
247            /**
248            * Updates the trash version in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
249            *
250            * @param trashVersion the trash version
251            * @return the trash version that was updated
252            */
253            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
254            public com.liferay.portlet.trash.model.TrashVersion updateTrashVersion(
255                    com.liferay.portlet.trash.model.TrashVersion trashVersion);
256    }