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            public TrashVersion addTrashVersion(long trashEntryId,
065                    java.lang.String className, long classPK, int status,
066                    UnicodeProperties typeSettingsProperties);
067    
068            /**
069            * Adds the trash version to the database. Also notifies the appropriate model listeners.
070            *
071            * @param trashVersion the trash version
072            * @return the trash version that was added
073            */
074            @Indexable(type = IndexableType.REINDEX)
075            public TrashVersion addTrashVersion(TrashVersion trashVersion);
076    
077            /**
078            * Creates a new trash version with the primary key. Does not add the trash version to the database.
079            *
080            * @param versionId the primary key for the new trash version
081            * @return the new trash version
082            */
083            public TrashVersion createTrashVersion(long versionId);
084    
085            /**
086            * @throws PortalException
087            */
088            @Override
089            public PersistedModel deletePersistedModel(PersistedModel persistedModel)
090                    throws PortalException;
091    
092            public TrashVersion deleteTrashVersion(java.lang.String className,
093                    long classPK);
094    
095            /**
096            * Deletes the trash version from the database. Also notifies the appropriate model listeners.
097            *
098            * @param trashVersion the trash version
099            * @return the trash version that was removed
100            */
101            @Indexable(type = IndexableType.DELETE)
102            public TrashVersion deleteTrashVersion(TrashVersion trashVersion);
103    
104            /**
105            * Deletes the trash version with the primary key from the database. Also notifies the appropriate model listeners.
106            *
107            * @param versionId the primary key of the trash version
108            * @return the trash version that was removed
109            * @throws PortalException if a trash version with the primary key could not be found
110            */
111            @Indexable(type = IndexableType.DELETE)
112            public TrashVersion deleteTrashVersion(long versionId)
113                    throws PortalException;
114    
115            public DynamicQuery dynamicQuery();
116    
117            /**
118            * Performs a dynamic query on the database and returns the matching rows.
119            *
120            * @param dynamicQuery the dynamic query
121            * @return the matching rows
122            */
123            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery);
124    
125            /**
126            * Performs a dynamic query on the database and returns a range of the matching rows.
127            *
128            * <p>
129            * 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.
130            * </p>
131            *
132            * @param dynamicQuery the dynamic query
133            * @param start the lower bound of the range of model instances
134            * @param end the upper bound of the range of model instances (not inclusive)
135            * @return the range of matching rows
136            */
137            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
138                    int end);
139    
140            /**
141            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
142            *
143            * <p>
144            * 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.
145            * </p>
146            *
147            * @param dynamicQuery the dynamic query
148            * @param start the lower bound of the range of model instances
149            * @param end the upper bound of the range of model instances (not inclusive)
150            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
151            * @return the ordered range of matching rows
152            */
153            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
154                    int end, OrderByComparator<T> orderByComparator);
155    
156            /**
157            * Returns the number of rows matching the dynamic query.
158            *
159            * @param dynamicQuery the dynamic query
160            * @return the number of rows matching the dynamic query
161            */
162            public long dynamicQueryCount(DynamicQuery dynamicQuery);
163    
164            /**
165            * Returns the number of rows matching the dynamic query.
166            *
167            * @param dynamicQuery the dynamic query
168            * @param projection the projection to apply to the query
169            * @return the number of rows matching the dynamic query
170            */
171            public long dynamicQueryCount(DynamicQuery dynamicQuery,
172                    Projection projection);
173    
174            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
175            public TrashVersion fetchTrashVersion(long versionId);
176    
177            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
178            public TrashVersion fetchVersion(java.lang.String className, long classPK);
179    
180            /**
181            * @deprecated As of 7.0.0, replaced by {@link #fetchVersion(String, long)}
182            */
183            @java.lang.Deprecated
184            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
185            public TrashVersion fetchVersion(long entryId, java.lang.String className,
186                    long classPK);
187    
188            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
189            public ActionableDynamicQuery getActionableDynamicQuery();
190    
191            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
192            public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
193    
194            /**
195            * Returns the OSGi service identifier.
196            *
197            * @return the OSGi service identifier
198            */
199            public java.lang.String getOSGiServiceIdentifier();
200    
201            @Override
202            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
203            public PersistedModel getPersistedModel(Serializable primaryKeyObj)
204                    throws PortalException;
205    
206            /**
207            * Returns the trash version with the primary key.
208            *
209            * @param versionId the primary key of the trash version
210            * @return the trash version
211            * @throws PortalException if a trash version with the primary key could not be found
212            */
213            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
214            public TrashVersion getTrashVersion(long versionId)
215                    throws PortalException;
216    
217            /**
218            * Returns a range of all the trash versions.
219            *
220            * <p>
221            * 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.
222            * </p>
223            *
224            * @param start the lower bound of the range of trash versions
225            * @param end the upper bound of the range of trash versions (not inclusive)
226            * @return the range of trash versions
227            */
228            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
229            public List<TrashVersion> getTrashVersions(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 List<TrashVersion> getVersions(long entryId);
241    
242            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
243            public List<TrashVersion> getVersions(long entryId,
244                    java.lang.String className);
245    
246            /**
247            * Updates the trash version in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
248            *
249            * @param trashVersion the trash version
250            * @return the trash version that was updated
251            */
252            @Indexable(type = IndexableType.REINDEX)
253            public TrashVersion updateTrashVersion(TrashVersion trashVersion);
254    }