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.documentlibrary.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 DLSyncEvent. 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 DLSyncEventLocalServiceUtil
036     * @see com.liferay.portlet.documentlibrary.service.base.DLSyncEventLocalServiceBaseImpl
037     * @see com.liferay.portlet.documentlibrary.service.impl.DLSyncEventLocalServiceImpl
038     * @generated
039     */
040    @ProviderType
041    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
042            PortalException.class, SystemException.class})
043    public interface DLSyncEventLocalService extends BaseLocalService,
044            PersistedModelLocalService {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * Never modify or reference this interface directly. Always use {@link DLSyncEventLocalServiceUtil} to access the d l sync event local service. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLSyncEventLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
049             */
050    
051            /**
052            * Adds the d l sync event to the database. Also notifies the appropriate model listeners.
053            *
054            * @param dlSyncEvent the d l sync event
055            * @return the d l sync event that was added
056            */
057            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
058            public com.liferay.portlet.documentlibrary.model.DLSyncEvent addDLSyncEvent(
059                    com.liferay.portlet.documentlibrary.model.DLSyncEvent dlSyncEvent);
060    
061            public com.liferay.portlet.documentlibrary.model.DLSyncEvent addDLSyncEvent(
062                    java.lang.String event, java.lang.String type, long typePK);
063    
064            /**
065            * Creates a new d l sync event with the primary key. Does not add the d l sync event to the database.
066            *
067            * @param syncEventId the primary key for the new d l sync event
068            * @return the new d l sync event
069            */
070            public com.liferay.portlet.documentlibrary.model.DLSyncEvent createDLSyncEvent(
071                    long syncEventId);
072    
073            /**
074            * Deletes the d l sync event from the database. Also notifies the appropriate model listeners.
075            *
076            * @param dlSyncEvent the d l sync event
077            * @return the d l sync event that was removed
078            */
079            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
080            public com.liferay.portlet.documentlibrary.model.DLSyncEvent deleteDLSyncEvent(
081                    com.liferay.portlet.documentlibrary.model.DLSyncEvent dlSyncEvent);
082    
083            /**
084            * Deletes the d l sync event with the primary key from the database. Also notifies the appropriate model listeners.
085            *
086            * @param syncEventId the primary key of the d l sync event
087            * @return the d l sync event that was removed
088            * @throws PortalException if a d l sync event with the primary key could not be found
089            */
090            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
091            public com.liferay.portlet.documentlibrary.model.DLSyncEvent deleteDLSyncEvent(
092                    long syncEventId) throws PortalException;
093    
094            public void deleteDLSyncEvents();
095    
096            /**
097            * @throws PortalException
098            */
099            @Override
100            public com.liferay.portal.model.PersistedModel deletePersistedModel(
101                    com.liferay.portal.model.PersistedModel persistedModel)
102                    throws PortalException;
103    
104            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
105    
106            /**
107            * Performs a dynamic query on the database and returns the matching rows.
108            *
109            * @param dynamicQuery the dynamic query
110            * @return the matching rows
111            */
112            public <T> java.util.List<T> dynamicQuery(
113                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
114    
115            /**
116            * Performs a dynamic query on the database and returns a range of the matching rows.
117            *
118            * <p>
119            * 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.documentlibrary.model.impl.DLSyncEventModelImpl}. 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.
120            * </p>
121            *
122            * @param dynamicQuery the dynamic query
123            * @param start the lower bound of the range of model instances
124            * @param end the upper bound of the range of model instances (not inclusive)
125            * @return the range of matching rows
126            */
127            public <T> java.util.List<T> dynamicQuery(
128                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
129                    int end);
130    
131            /**
132            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
133            *
134            * <p>
135            * 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.documentlibrary.model.impl.DLSyncEventModelImpl}. 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.
136            * </p>
137            *
138            * @param dynamicQuery the dynamic query
139            * @param start the lower bound of the range of model instances
140            * @param end the upper bound of the range of model instances (not inclusive)
141            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
142            * @return the ordered range of matching rows
143            */
144            public <T> java.util.List<T> dynamicQuery(
145                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
146                    int end,
147                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
148    
149            /**
150            * Returns the number of rows matching the dynamic query.
151            *
152            * @param dynamicQuery the dynamic query
153            * @return the number of rows matching the dynamic query
154            */
155            public long dynamicQueryCount(
156                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
157    
158            /**
159            * Returns the number of rows matching the dynamic query.
160            *
161            * @param dynamicQuery the dynamic query
162            * @param projection the projection to apply to the query
163            * @return the number of rows matching the dynamic query
164            */
165            public long dynamicQueryCount(
166                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
167                    com.liferay.portal.kernel.dao.orm.Projection projection);
168    
169            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170            public com.liferay.portlet.documentlibrary.model.DLSyncEvent fetchDLSyncEvent(
171                    long syncEventId);
172    
173            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
174            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
175    
176            /**
177            * Returns the d l sync event with the primary key.
178            *
179            * @param syncEventId the primary key of the d l sync event
180            * @return the d l sync event
181            * @throws PortalException if a d l sync event with the primary key could not be found
182            */
183            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184            public com.liferay.portlet.documentlibrary.model.DLSyncEvent getDLSyncEvent(
185                    long syncEventId) throws PortalException;
186    
187            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
188            public java.util.List<com.liferay.portlet.documentlibrary.model.DLSyncEvent> getDLSyncEvents(
189                    long modifiedTime);
190    
191            /**
192            * Returns a range of all the d l sync events.
193            *
194            * <p>
195            * 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.documentlibrary.model.impl.DLSyncEventModelImpl}. 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.
196            * </p>
197            *
198            * @param start the lower bound of the range of d l sync events
199            * @param end the upper bound of the range of d l sync events (not inclusive)
200            * @return the range of d l sync events
201            */
202            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
203            public java.util.List<com.liferay.portlet.documentlibrary.model.DLSyncEvent> getDLSyncEvents(
204                    int start, int end);
205    
206            /**
207            * Returns the number of d l sync events.
208            *
209            * @return the number of d l sync events
210            */
211            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
212            public int getDLSyncEventsCount();
213    
214            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
215            public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
216    
217            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
218            public java.util.List<com.liferay.portlet.documentlibrary.model.DLSyncEvent> getLatestDLSyncEvents();
219    
220            /**
221            * Returns the OSGi service identifier.
222            *
223            * @return the OSGi service identifier
224            */
225            public java.lang.String getOSGiServiceIdentifier();
226    
227            @Override
228            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
229            public com.liferay.portal.model.PersistedModel getPersistedModel(
230                    java.io.Serializable primaryKeyObj) throws PortalException;
231    
232            /**
233            * Updates the d l sync event in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
234            *
235            * @param dlSyncEvent the d l sync event
236            * @return the d l sync event that was updated
237            */
238            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
239            public com.liferay.portlet.documentlibrary.model.DLSyncEvent updateDLSyncEvent(
240                    com.liferay.portlet.documentlibrary.model.DLSyncEvent dlSyncEvent);
241    }