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 DLFileEntryMetadata. 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 DLFileEntryMetadataLocalServiceUtil
036     * @see com.liferay.portlet.documentlibrary.service.base.DLFileEntryMetadataLocalServiceBaseImpl
037     * @see com.liferay.portlet.documentlibrary.service.impl.DLFileEntryMetadataLocalServiceImpl
038     * @generated
039     */
040    @ProviderType
041    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
042            PortalException.class, SystemException.class})
043    public interface DLFileEntryMetadataLocalService extends BaseLocalService,
044            PersistedModelLocalService {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * Never modify or reference this interface directly. Always use {@link DLFileEntryMetadataLocalServiceUtil} to access the document library file entry metadata local service. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLFileEntryMetadataLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
049             */
050    
051            /**
052            * Adds the document library file entry metadata to the database. Also notifies the appropriate model listeners.
053            *
054            * @param dlFileEntryMetadata the document library file entry metadata
055            * @return the document library file entry metadata that was added
056            */
057            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
058            public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata addDLFileEntryMetadata(
059                    com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata dlFileEntryMetadata);
060    
061            /**
062            * Creates a new document library file entry metadata with the primary key. Does not add the document library file entry metadata to the database.
063            *
064            * @param fileEntryMetadataId the primary key for the new document library file entry metadata
065            * @return the new document library file entry metadata
066            */
067            public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata createDLFileEntryMetadata(
068                    long fileEntryMetadataId);
069    
070            /**
071            * Deletes the document library file entry metadata from the database. Also notifies the appropriate model listeners.
072            *
073            * @param dlFileEntryMetadata the document library file entry metadata
074            * @return the document library file entry metadata that was removed
075            */
076            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
077            public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata deleteDLFileEntryMetadata(
078                    com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata dlFileEntryMetadata);
079    
080            /**
081            * Deletes the document library file entry metadata with the primary key from the database. Also notifies the appropriate model listeners.
082            *
083            * @param fileEntryMetadataId the primary key of the document library file entry metadata
084            * @return the document library file entry metadata that was removed
085            * @throws PortalException if a document library file entry metadata with the primary key could not be found
086            */
087            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
088            public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata deleteDLFileEntryMetadata(
089                    long fileEntryMetadataId) throws PortalException;
090    
091            public void deleteFileEntryMetadata(long fileEntryId)
092                    throws PortalException;
093    
094            public void deleteFileEntryMetadata(
095                    com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata fileEntryMetadata)
096                    throws PortalException;
097    
098            public void deleteFileVersionFileEntryMetadata(long fileVersionId)
099                    throws PortalException;
100    
101            /**
102            * @throws PortalException
103            */
104            @Override
105            public com.liferay.portal.model.PersistedModel deletePersistedModel(
106                    com.liferay.portal.model.PersistedModel persistedModel)
107                    throws PortalException;
108    
109            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
110    
111            /**
112            * Performs a dynamic query on the database and returns the matching rows.
113            *
114            * @param dynamicQuery the dynamic query
115            * @return the matching rows
116            */
117            public <T> java.util.List<T> dynamicQuery(
118                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
119    
120            /**
121            * Performs a dynamic query on the database and returns a range of the matching rows.
122            *
123            * <p>
124            * 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.DLFileEntryMetadataModelImpl}. 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.
125            * </p>
126            *
127            * @param dynamicQuery the dynamic query
128            * @param start the lower bound of the range of model instances
129            * @param end the upper bound of the range of model instances (not inclusive)
130            * @return the range of matching rows
131            */
132            public <T> java.util.List<T> dynamicQuery(
133                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
134                    int end);
135    
136            /**
137            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
138            *
139            * <p>
140            * 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.DLFileEntryMetadataModelImpl}. 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.
141            * </p>
142            *
143            * @param dynamicQuery the dynamic query
144            * @param start the lower bound of the range of model instances
145            * @param end the upper bound of the range of model instances (not inclusive)
146            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
147            * @return the ordered range of matching rows
148            */
149            public <T> java.util.List<T> dynamicQuery(
150                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
151                    int end,
152                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
153    
154            /**
155            * Returns the number of rows matching the dynamic query.
156            *
157            * @param dynamicQuery the dynamic query
158            * @return the number of rows matching the dynamic query
159            */
160            public long dynamicQueryCount(
161                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
162    
163            /**
164            * Returns the number of rows matching the dynamic query.
165            *
166            * @param dynamicQuery the dynamic query
167            * @param projection the projection to apply to the query
168            * @return the number of rows matching the dynamic query
169            */
170            public long dynamicQueryCount(
171                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
172                    com.liferay.portal.kernel.dao.orm.Projection projection);
173    
174            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
175            public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata fetchDLFileEntryMetadata(
176                    long fileEntryMetadataId);
177    
178            /**
179            * Returns the document library file entry metadata with the matching UUID and company.
180            *
181            * @param uuid the document library file entry metadata's UUID
182            * @param companyId the primary key of the company
183            * @return the matching document library file entry metadata, or <code>null</code> if a matching document library file entry metadata could not be found
184            */
185            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
186            public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata fetchDLFileEntryMetadataByUuidAndCompanyId(
187                    java.lang.String uuid, long companyId);
188    
189            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
190            public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata fetchFileEntryMetadata(
191                    long ddmStructureId, long fileVersionId);
192    
193            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
194            public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata fetchFileEntryMetadata(
195                    long fileEntryMetadataId);
196    
197            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
198            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
199    
200            /**
201            * Returns the document library file entry metadata with the primary key.
202            *
203            * @param fileEntryMetadataId the primary key of the document library file entry metadata
204            * @return the document library file entry metadata
205            * @throws PortalException if a document library file entry metadata with the primary key could not be found
206            */
207            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
208            public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata getDLFileEntryMetadata(
209                    long fileEntryMetadataId) throws PortalException;
210    
211            /**
212            * Returns the document library file entry metadata with the matching UUID and company.
213            *
214            * @param uuid the document library file entry metadata's UUID
215            * @param companyId the primary key of the company
216            * @return the matching document library file entry metadata
217            * @throws PortalException if a matching document library file entry metadata could not be found
218            */
219            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
220            public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata getDLFileEntryMetadataByUuidAndCompanyId(
221                    java.lang.String uuid, long companyId) throws PortalException;
222    
223            /**
224            * Returns a range of all the document library file entry metadatas.
225            *
226            * <p>
227            * 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.DLFileEntryMetadataModelImpl}. 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.
228            * </p>
229            *
230            * @param start the lower bound of the range of document library file entry metadatas
231            * @param end the upper bound of the range of document library file entry metadatas (not inclusive)
232            * @return the range of document library file entry metadatas
233            */
234            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
235            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata> getDLFileEntryMetadatas(
236                    int start, int end);
237    
238            /**
239            * Returns the number of document library file entry metadatas.
240            *
241            * @return the number of document library file entry metadatas
242            */
243            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
244            public int getDLFileEntryMetadatasCount();
245    
246            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
247            public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata getFileEntryMetadata(
248                    long ddmStructureId, long fileVersionId) throws PortalException;
249    
250            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
251            public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata getFileEntryMetadata(
252                    long fileEntryMetadataId) throws PortalException;
253    
254            /**
255            * @deprecated As of 6.2.0, replaced by {@link
256            #getFileVersionFileEntryMetadatasCount(long)}
257            */
258            @java.lang.Deprecated
259            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
260            public long getFileEntryMetadataCount(long fileEntryId, long fileVersionId);
261    
262            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
263            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata> getFileVersionFileEntryMetadatas(
264                    long fileVersionId);
265    
266            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
267            public long getFileVersionFileEntryMetadatasCount(long fileVersionId);
268    
269            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
270            public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
271    
272            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
273            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata> getMismatchedCompanyIdFileEntryMetadatas();
274    
275            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
276            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata> getNoStructuresFileEntryMetadatas();
277    
278            /**
279            * Returns the OSGi service identifier.
280            *
281            * @return the OSGi service identifier
282            */
283            public java.lang.String getOSGiServiceIdentifier();
284    
285            @Override
286            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
287            public com.liferay.portal.model.PersistedModel getPersistedModel(
288                    java.io.Serializable primaryKeyObj) throws PortalException;
289    
290            /**
291            * Updates the document library file entry metadata in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
292            *
293            * @param dlFileEntryMetadata the document library file entry metadata
294            * @return the document library file entry metadata that was updated
295            */
296            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
297            public com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata updateDLFileEntryMetadata(
298                    com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata dlFileEntryMetadata);
299    
300            public void updateFileEntryMetadata(long companyId,
301                    java.util.List<com.liferay.portlet.dynamicdatamapping.DDMStructure> ddmStructures,
302                    long fileEntryId, long fileVersionId,
303                    java.util.Map<java.lang.String, com.liferay.portlet.dynamicdatamapping.DDMFormValues> ddmFormValuesMap,
304                    com.liferay.portal.service.ServiceContext serviceContext)
305                    throws PortalException;
306    
307            public void updateFileEntryMetadata(long fileEntryTypeId, long fileEntryId,
308                    long fileVersionId,
309                    java.util.Map<java.lang.String, com.liferay.portlet.dynamicdatamapping.DDMFormValues> ddmFormValuesMap,
310                    com.liferay.portal.service.ServiceContext serviceContext)
311                    throws PortalException;
312    }