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 DLContent. This utility wraps
024     * {@link com.liferay.portlet.documentlibrary.service.impl.DLContentLocalServiceImpl} 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 DLContentLocalService
032     * @see com.liferay.portlet.documentlibrary.service.base.DLContentLocalServiceBaseImpl
033     * @see com.liferay.portlet.documentlibrary.service.impl.DLContentLocalServiceImpl
034     * @generated
035     */
036    @ProviderType
037    public class DLContentLocalServiceUtil {
038            /*
039             * NOTE FOR DEVELOPERS:
040             *
041             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLContentLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
042             */
043    
044            /**
045            * Adds the document library content to the database. Also notifies the appropriate model listeners.
046            *
047            * @param dlContent the document library content
048            * @return the document library content that was added
049            * @throws SystemException if a system exception occurred
050            */
051            public static com.liferay.portlet.documentlibrary.model.DLContent addDLContent(
052                    com.liferay.portlet.documentlibrary.model.DLContent dlContent)
053                    throws com.liferay.portal.kernel.exception.SystemException {
054                    return getService().addDLContent(dlContent);
055            }
056    
057            /**
058            * Creates a new document library content with the primary key. Does not add the document library content to the database.
059            *
060            * @param contentId the primary key for the new document library content
061            * @return the new document library content
062            */
063            public static com.liferay.portlet.documentlibrary.model.DLContent createDLContent(
064                    long contentId) {
065                    return getService().createDLContent(contentId);
066            }
067    
068            /**
069            * Deletes the document library content with the primary key from the database. Also notifies the appropriate model listeners.
070            *
071            * @param contentId the primary key of the document library content
072            * @return the document library content that was removed
073            * @throws PortalException if a document library content 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.DLContent deleteDLContent(
077                    long contentId)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException {
080                    return getService().deleteDLContent(contentId);
081            }
082    
083            /**
084            * Deletes the document library content from the database. Also notifies the appropriate model listeners.
085            *
086            * @param dlContent the document library content
087            * @return the document library content that was removed
088            * @throws SystemException if a system exception occurred
089            */
090            public static com.liferay.portlet.documentlibrary.model.DLContent deleteDLContent(
091                    com.liferay.portlet.documentlibrary.model.DLContent dlContent)
092                    throws com.liferay.portal.kernel.exception.SystemException {
093                    return getService().deleteDLContent(dlContent);
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.DLContentModelImpl}. 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.DLContentModelImpl}. 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.DLContent fetchDLContent(
187                    long contentId)
188                    throws com.liferay.portal.kernel.exception.SystemException {
189                    return getService().fetchDLContent(contentId);
190            }
191    
192            /**
193            * Returns the document library content with the primary key.
194            *
195            * @param contentId the primary key of the document library content
196            * @return the document library content
197            * @throws PortalException if a document library content 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.DLContent getDLContent(
201                    long contentId)
202                    throws com.liferay.portal.kernel.exception.PortalException,
203                            com.liferay.portal.kernel.exception.SystemException {
204                    return getService().getDLContent(contentId);
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 contents.
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.DLContentModelImpl}. 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 contents
222            * @param end the upper bound of the range of document library contents (not inclusive)
223            * @return the range of document library contents
224            * @throws SystemException if a system exception occurred
225            */
226            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLContent> getDLContents(
227                    int start, int end)
228                    throws com.liferay.portal.kernel.exception.SystemException {
229                    return getService().getDLContents(start, end);
230            }
231    
232            /**
233            * Returns the number of document library contents.
234            *
235            * @return the number of document library contents
236            * @throws SystemException if a system exception occurred
237            */
238            public static int getDLContentsCount()
239                    throws com.liferay.portal.kernel.exception.SystemException {
240                    return getService().getDLContentsCount();
241            }
242    
243            /**
244            * Updates the document library content in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
245            *
246            * @param dlContent the document library content
247            * @return the document library content that was updated
248            * @throws SystemException if a system exception occurred
249            */
250            public static com.liferay.portlet.documentlibrary.model.DLContent updateDLContent(
251                    com.liferay.portlet.documentlibrary.model.DLContent dlContent)
252                    throws com.liferay.portal.kernel.exception.SystemException {
253                    return getService().updateDLContent(dlContent);
254            }
255    
256            public static com.liferay.portlet.documentlibrary.model.DLContentDataBlobModel getDataBlobModel(
257                    java.io.Serializable primaryKey)
258                    throws com.liferay.portal.kernel.exception.SystemException {
259                    return getService().getDataBlobModel(primaryKey);
260            }
261    
262            /**
263            * Returns the Spring bean ID for this bean.
264            *
265            * @return the Spring bean ID for this bean
266            */
267            public static java.lang.String getBeanIdentifier() {
268                    return getService().getBeanIdentifier();
269            }
270    
271            /**
272            * Sets the Spring bean ID for this bean.
273            *
274            * @param beanIdentifier the Spring bean ID for this bean
275            */
276            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
277                    getService().setBeanIdentifier(beanIdentifier);
278            }
279    
280            public static com.liferay.portlet.documentlibrary.model.DLContent addContent(
281                    long companyId, long repositoryId, java.lang.String path,
282                    java.lang.String version, byte[] bytes)
283                    throws com.liferay.portal.kernel.exception.SystemException {
284                    return getService()
285                                       .addContent(companyId, repositoryId, path, version, bytes);
286            }
287    
288            public static com.liferay.portlet.documentlibrary.model.DLContent addContent(
289                    long companyId, long repositoryId, java.lang.String path,
290                    java.lang.String version, java.io.InputStream inputStream, long size)
291                    throws com.liferay.portal.kernel.exception.SystemException {
292                    return getService()
293                                       .addContent(companyId, repositoryId, path, version,
294                            inputStream, size);
295            }
296    
297            public static void deleteContent(long companyId, long repositoryId,
298                    java.lang.String path, java.lang.String version)
299                    throws com.liferay.portal.kernel.exception.PortalException,
300                            com.liferay.portal.kernel.exception.SystemException {
301                    getService().deleteContent(companyId, repositoryId, path, version);
302            }
303    
304            public static void deleteContents(long companyId, long repositoryId,
305                    java.lang.String path)
306                    throws com.liferay.portal.kernel.exception.SystemException {
307                    getService().deleteContents(companyId, repositoryId, path);
308            }
309    
310            public static void deleteContentsByDirectory(long companyId,
311                    long repositoryId, java.lang.String dirName)
312                    throws com.liferay.portal.kernel.exception.SystemException {
313                    getService().deleteContentsByDirectory(companyId, repositoryId, dirName);
314            }
315    
316            public static com.liferay.portlet.documentlibrary.model.DLContent getContent(
317                    long companyId, long repositoryId, java.lang.String path)
318                    throws com.liferay.portal.kernel.exception.SystemException,
319                            com.liferay.portlet.documentlibrary.NoSuchContentException {
320                    return getService().getContent(companyId, repositoryId, path);
321            }
322    
323            public static com.liferay.portlet.documentlibrary.model.DLContent getContent(
324                    long companyId, long repositoryId, java.lang.String path,
325                    java.lang.String version)
326                    throws com.liferay.portal.kernel.exception.SystemException,
327                            com.liferay.portlet.documentlibrary.NoSuchContentException {
328                    return getService().getContent(companyId, repositoryId, path, version);
329            }
330    
331            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLContent> getContents(
332                    long companyId, long repositoryId)
333                    throws com.liferay.portal.kernel.exception.SystemException {
334                    return getService().getContents(companyId, repositoryId);
335            }
336    
337            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLContent> getContents(
338                    long companyId, long repositoryId, java.lang.String path)
339                    throws com.liferay.portal.kernel.exception.SystemException {
340                    return getService().getContents(companyId, repositoryId, path);
341            }
342    
343            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLContent> getContentsByDirectory(
344                    long companyId, long repositoryId, java.lang.String dirName)
345                    throws com.liferay.portal.kernel.exception.SystemException {
346                    return getService()
347                                       .getContentsByDirectory(companyId, repositoryId, dirName);
348            }
349    
350            public static boolean hasContent(long companyId, long repositoryId,
351                    java.lang.String path, java.lang.String version)
352                    throws com.liferay.portal.kernel.exception.SystemException {
353                    return getService().hasContent(companyId, repositoryId, path, version);
354            }
355    
356            public static void updateDLContent(long companyId, long oldRepositoryId,
357                    long newRepositoryId, java.lang.String oldPath, java.lang.String newPath)
358                    throws com.liferay.portal.kernel.exception.SystemException {
359                    getService()
360                            .updateDLContent(companyId, oldRepositoryId, newRepositoryId,
361                            oldPath, newPath);
362            }
363    
364            public static DLContentLocalService getService() {
365                    if (_service == null) {
366                            _service = (DLContentLocalService)PortalBeanLocatorUtil.locate(DLContentLocalService.class.getName());
367    
368                            ReferenceRegistry.registerReference(DLContentLocalServiceUtil.class,
369                                    "_service");
370                    }
371    
372                    return _service;
373            }
374    
375            /**
376             * @deprecated As of 6.2.0
377             */
378            public void setService(DLContentLocalService service) {
379            }
380    
381            private static DLContentLocalService _service;
382    }