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