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