001    /**
002     * Copyright (c) 2000-2013 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.bean.PortalBeanLocatorUtil;
020    import com.liferay.portal.kernel.util.ReferenceRegistry;
021    
022    /**
023     * Provides the local service utility for DLFileEntryMetadata. This utility wraps
024     * {@link com.liferay.portlet.documentlibrary.service.impl.DLFileEntryMetadataLocalServiceImpl} and is the
025     * primary access point for service operations in application layer code running
026     * on the local server. Methods of this service will not have security checks
027     * based on the propagated JAAS credentials because this service can only be
028     * accessed from within the same VM.
029     *
030     * @author Brian Wing Shun Chan
031     * @see DLFileEntryMetadataLocalService
032     * @see com.liferay.portlet.documentlibrary.service.base.DLFileEntryMetadataLocalServiceBaseImpl
033     * @see com.liferay.portlet.documentlibrary.service.impl.DLFileEntryMetadataLocalServiceImpl
034     * @generated
035     */
036    @ProviderType
037    public class DLFileEntryMetadataLocalServiceUtil {
038            /*
039             * NOTE FOR DEVELOPERS:
040             *
041             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLFileEntryMetadataLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
042             */
043    
044            /**
045            * Adds the document library file entry metadata to the database. Also notifies the appropriate model listeners.
046            *
047            * @param dlFileEntryMetadata the document library file entry metadata
048            * @return the document library file entry metadata that was added
049            * @throws SystemException if a system exception occurred
050            */
051            public static com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata addDLFileEntryMetadata(
052                    com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata dlFileEntryMetadata)
053                    throws com.liferay.portal.kernel.exception.SystemException {
054                    return getService().addDLFileEntryMetadata(dlFileEntryMetadata);
055            }
056    
057            /**
058            * Creates a new document library file entry metadata with the primary key. Does not add the document library file entry metadata to the database.
059            *
060            * @param fileEntryMetadataId the primary key for the new document library file entry metadata
061            * @return the new document library file entry metadata
062            */
063            public static com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata createDLFileEntryMetadata(
064                    long fileEntryMetadataId) {
065                    return getService().createDLFileEntryMetadata(fileEntryMetadataId);
066            }
067    
068            /**
069            * Deletes the document library file entry metadata with the primary key from the database. Also notifies the appropriate model listeners.
070            *
071            * @param fileEntryMetadataId the primary key of the document library file entry metadata
072            * @return the document library file entry metadata that was removed
073            * @throws PortalException if a document library file entry metadata with the primary key could not be found
074            * @throws SystemException if a system exception occurred
075            */
076            public static com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata deleteDLFileEntryMetadata(
077                    long fileEntryMetadataId)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException {
080                    return getService().deleteDLFileEntryMetadata(fileEntryMetadataId);
081            }
082    
083            /**
084            * Deletes the document library file entry metadata from the database. Also notifies the appropriate model listeners.
085            *
086            * @param dlFileEntryMetadata the document library file entry metadata
087            * @return the document library file entry metadata that was removed
088            * @throws SystemException if a system exception occurred
089            */
090            public static com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata deleteDLFileEntryMetadata(
091                    com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata dlFileEntryMetadata)
092                    throws com.liferay.portal.kernel.exception.SystemException {
093                    return getService().deleteDLFileEntryMetadata(dlFileEntryMetadata);
094            }
095    
096            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
097                    return getService().dynamicQuery();
098            }
099    
100            /**
101            * Performs a dynamic query on the database and returns the matching rows.
102            *
103            * @param dynamicQuery the dynamic query
104            * @return the matching rows
105            * @throws SystemException if a system exception occurred
106            */
107            @SuppressWarnings("rawtypes")
108            public static java.util.List dynamicQuery(
109                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
110                    throws com.liferay.portal.kernel.exception.SystemException {
111                    return getService().dynamicQuery(dynamicQuery);
112            }
113    
114            /**
115            * Performs a dynamic query on the database and returns a range of the matching rows.
116            *
117            * <p>
118            * 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.
119            * </p>
120            *
121            * @param dynamicQuery the dynamic query
122            * @param start the lower bound of the range of model instances
123            * @param end the upper bound of the range of model instances (not inclusive)
124            * @return the range of matching rows
125            * @throws SystemException if a system exception occurred
126            */
127            @SuppressWarnings("rawtypes")
128            public static java.util.List dynamicQuery(
129                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
130                    int end) throws com.liferay.portal.kernel.exception.SystemException {
131                    return getService().dynamicQuery(dynamicQuery, start, end);
132            }
133    
134            /**
135            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
136            *
137            * <p>
138            * 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.
139            * </p>
140            *
141            * @param dynamicQuery the dynamic query
142            * @param start the lower bound of the range of model instances
143            * @param end the upper bound of the range of model instances (not inclusive)
144            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
145            * @return the ordered range of matching rows
146            * @throws SystemException if a system exception occurred
147            */
148            @SuppressWarnings("rawtypes")
149            public static java.util.List dynamicQuery(
150                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
151                    int end,
152                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService()
155                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
156            }
157    
158            /**
159            * Returns the number of rows that match the dynamic query.
160            *
161            * @param dynamicQuery the dynamic query
162            * @return the number of rows that match the dynamic query
163            * @throws SystemException if a system exception occurred
164            */
165            public static long dynamicQueryCount(
166                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
167                    throws com.liferay.portal.kernel.exception.SystemException {
168                    return getService().dynamicQueryCount(dynamicQuery);
169            }
170    
171            /**
172            * Returns the number of rows that match the dynamic query.
173            *
174            * @param dynamicQuery the dynamic query
175            * @param projection the projection to apply to the query
176            * @return the number of rows that match the dynamic query
177            * @throws SystemException if a system exception occurred
178            */
179            public static long dynamicQueryCount(
180                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
181                    com.liferay.portal.kernel.dao.orm.Projection projection)
182                    throws com.liferay.portal.kernel.exception.SystemException {
183                    return getService().dynamicQueryCount(dynamicQuery, projection);
184            }
185    
186            public static com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata fetchDLFileEntryMetadata(
187                    long fileEntryMetadataId)
188                    throws com.liferay.portal.kernel.exception.SystemException {
189                    return getService().fetchDLFileEntryMetadata(fileEntryMetadataId);
190            }
191    
192            /**
193            * Returns the document library file entry metadata with the primary key.
194            *
195            * @param fileEntryMetadataId the primary key of the document library file entry metadata
196            * @return the document library file entry metadata
197            * @throws PortalException if a document library file entry metadata with the primary key could not be found
198            * @throws SystemException if a system exception occurred
199            */
200            public static com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata getDLFileEntryMetadata(
201                    long fileEntryMetadataId)
202                    throws com.liferay.portal.kernel.exception.PortalException,
203                            com.liferay.portal.kernel.exception.SystemException {
204                    return getService().getDLFileEntryMetadata(fileEntryMetadataId);
205            }
206    
207            public static com.liferay.portal.model.PersistedModel getPersistedModel(
208                    java.io.Serializable primaryKeyObj)
209                    throws com.liferay.portal.kernel.exception.PortalException,
210                            com.liferay.portal.kernel.exception.SystemException {
211                    return getService().getPersistedModel(primaryKeyObj);
212            }
213    
214            /**
215            * Returns a range of all the document library file entry metadatas.
216            *
217            * <p>
218            * 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.
219            * </p>
220            *
221            * @param start the lower bound of the range of document library file entry metadatas
222            * @param end the upper bound of the range of document library file entry metadatas (not inclusive)
223            * @return the range of document library file entry metadatas
224            * @throws SystemException if a system exception occurred
225            */
226            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata> getDLFileEntryMetadatas(
227                    int start, int end)
228                    throws com.liferay.portal.kernel.exception.SystemException {
229                    return getService().getDLFileEntryMetadatas(start, end);
230            }
231    
232            /**
233            * Returns the number of document library file entry metadatas.
234            *
235            * @return the number of document library file entry metadatas
236            * @throws SystemException if a system exception occurred
237            */
238            public static int getDLFileEntryMetadatasCount()
239                    throws com.liferay.portal.kernel.exception.SystemException {
240                    return getService().getDLFileEntryMetadatasCount();
241            }
242    
243            /**
244            * 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.
245            *
246            * @param dlFileEntryMetadata the document library file entry metadata
247            * @return the document library file entry metadata that was updated
248            * @throws SystemException if a system exception occurred
249            */
250            public static com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata updateDLFileEntryMetadata(
251                    com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata dlFileEntryMetadata)
252                    throws com.liferay.portal.kernel.exception.SystemException {
253                    return getService().updateDLFileEntryMetadata(dlFileEntryMetadata);
254            }
255    
256            /**
257            * Returns the Spring bean ID for this bean.
258            *
259            * @return the Spring bean ID for this bean
260            */
261            public static java.lang.String getBeanIdentifier() {
262                    return getService().getBeanIdentifier();
263            }
264    
265            /**
266            * Sets the Spring bean ID for this bean.
267            *
268            * @param beanIdentifier the Spring bean ID for this bean
269            */
270            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
271                    getService().setBeanIdentifier(beanIdentifier);
272            }
273    
274            public static void deleteFileEntryMetadata(long fileEntryId)
275                    throws com.liferay.portal.kernel.exception.PortalException,
276                            com.liferay.portal.kernel.exception.SystemException {
277                    getService().deleteFileEntryMetadata(fileEntryId);
278            }
279    
280            public static void deleteFileVersionFileEntryMetadata(long fileVersionId)
281                    throws com.liferay.portal.kernel.exception.PortalException,
282                            com.liferay.portal.kernel.exception.SystemException {
283                    getService().deleteFileVersionFileEntryMetadata(fileVersionId);
284            }
285    
286            public static com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata fetchFileEntryMetadata(
287                    long fileEntryMetadataId)
288                    throws com.liferay.portal.kernel.exception.SystemException {
289                    return getService().fetchFileEntryMetadata(fileEntryMetadataId);
290            }
291    
292            public static com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata fetchFileEntryMetadata(
293                    long ddmStructureId, long fileVersionId)
294                    throws com.liferay.portal.kernel.exception.SystemException {
295                    return getService().fetchFileEntryMetadata(ddmStructureId, fileVersionId);
296            }
297    
298            public static com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata getFileEntryMetadata(
299                    long fileEntryMetadataId)
300                    throws com.liferay.portal.kernel.exception.PortalException,
301                            com.liferay.portal.kernel.exception.SystemException {
302                    return getService().getFileEntryMetadata(fileEntryMetadataId);
303            }
304    
305            public static com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata getFileEntryMetadata(
306                    long ddmStructureId, long fileVersionId)
307                    throws com.liferay.portal.kernel.exception.PortalException,
308                            com.liferay.portal.kernel.exception.SystemException {
309                    return getService().getFileEntryMetadata(ddmStructureId, fileVersionId);
310            }
311    
312            /**
313            * @deprecated As of 6.2.0, replaced by {@link
314            #getFileVersionFileEntryMetadatasCount(long)}
315            */
316            public static long getFileEntryMetadataCount(long fileEntryId,
317                    long fileVersionId)
318                    throws com.liferay.portal.kernel.exception.SystemException {
319                    return getService().getFileEntryMetadataCount(fileEntryId, fileVersionId);
320            }
321    
322            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntryMetadata> getFileVersionFileEntryMetadatas(
323                    long fileVersionId)
324                    throws com.liferay.portal.kernel.exception.SystemException {
325                    return getService().getFileVersionFileEntryMetadatas(fileVersionId);
326            }
327    
328            public static long getFileVersionFileEntryMetadatasCount(long fileVersionId)
329                    throws com.liferay.portal.kernel.exception.SystemException {
330                    return getService().getFileVersionFileEntryMetadatasCount(fileVersionId);
331            }
332    
333            public static void updateFileEntryMetadata(long companyId,
334                    java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> ddmStructures,
335                    long fileEntryTypeId, long fileEntryId, long fileVersionId,
336                    java.util.Map<java.lang.String, com.liferay.portlet.dynamicdatamapping.storage.Fields> fieldsMap,
337                    com.liferay.portal.service.ServiceContext serviceContext)
338                    throws com.liferay.portal.kernel.exception.PortalException,
339                            com.liferay.portal.kernel.exception.SystemException {
340                    getService()
341                            .updateFileEntryMetadata(companyId, ddmStructures, fileEntryTypeId,
342                            fileEntryId, fileVersionId, fieldsMap, serviceContext);
343            }
344    
345            public static void updateFileEntryMetadata(long fileEntryTypeId,
346                    long fileEntryId, long fileVersionId,
347                    java.util.Map<java.lang.String, com.liferay.portlet.dynamicdatamapping.storage.Fields> fieldsMap,
348                    com.liferay.portal.service.ServiceContext serviceContext)
349                    throws com.liferay.portal.kernel.exception.PortalException,
350                            com.liferay.portal.kernel.exception.SystemException {
351                    getService()
352                            .updateFileEntryMetadata(fileEntryTypeId, fileEntryId,
353                            fileVersionId, fieldsMap, serviceContext);
354            }
355    
356            public static DLFileEntryMetadataLocalService getService() {
357                    if (_service == null) {
358                            _service = (DLFileEntryMetadataLocalService)PortalBeanLocatorUtil.locate(DLFileEntryMetadataLocalService.class.getName());
359    
360                            ReferenceRegistry.registerReference(DLFileEntryMetadataLocalServiceUtil.class,
361                                    "_service");
362                    }
363    
364                    return _service;
365            }
366    
367            /**
368             * @deprecated As of 6.2.0
369             */
370            public void setService(DLFileEntryMetadataLocalService service) {
371            }
372    
373            private static DLFileEntryMetadataLocalService _service;
374    }