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.MethodCache;
019    import com.liferay.portal.kernel.util.ReferenceRegistry;
020    
021    /**
022     * 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.
023     *
024     * <p>
025     * 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.
026     * </p>
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            * @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 void deleteDLContent(long contentId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteDLContent(contentId);
076            }
077    
078            /**
079            * Deletes the document library content from the database. Also notifies the appropriate model listeners.
080            *
081            * @param dlContent the document library content
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteDLContent(
085                    com.liferay.portlet.documentlibrary.model.DLContent dlContent)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteDLContent(dlContent);
088            }
089    
090            /**
091            * Performs a dynamic query on the database and returns the matching rows.
092            *
093            * @param dynamicQuery the dynamic query
094            * @return the matching rows
095            * @throws SystemException if a system exception occurred
096            */
097            @SuppressWarnings("rawtypes")
098            public static java.util.List dynamicQuery(
099                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
100                    throws com.liferay.portal.kernel.exception.SystemException {
101                    return getService().dynamicQuery(dynamicQuery);
102            }
103    
104            /**
105            * Performs a dynamic query on the database and returns a range of the matching rows.
106            *
107            * <p>
108            * 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.
109            * </p>
110            *
111            * @param dynamicQuery the dynamic query
112            * @param start the lower bound of the range of model instances
113            * @param end the upper bound of the range of model instances (not inclusive)
114            * @return the range of matching rows
115            * @throws SystemException if a system exception occurred
116            */
117            @SuppressWarnings("rawtypes")
118            public static java.util.List dynamicQuery(
119                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
120                    int end) throws com.liferay.portal.kernel.exception.SystemException {
121                    return getService().dynamicQuery(dynamicQuery, start, end);
122            }
123    
124            /**
125            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
126            *
127            * <p>
128            * 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.
129            * </p>
130            *
131            * @param dynamicQuery the dynamic query
132            * @param start the lower bound of the range of model instances
133            * @param end the upper bound of the range of model instances (not inclusive)
134            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
135            * @return the ordered range of matching rows
136            * @throws SystemException if a system exception occurred
137            */
138            @SuppressWarnings("rawtypes")
139            public static java.util.List dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException {
144                    return getService()
145                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
146            }
147    
148            /**
149            * Returns the number of rows that match the dynamic query.
150            *
151            * @param dynamicQuery the dynamic query
152            * @return the number of rows that match the dynamic query
153            * @throws SystemException if a system exception occurred
154            */
155            public static long dynamicQueryCount(
156                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
157                    throws com.liferay.portal.kernel.exception.SystemException {
158                    return getService().dynamicQueryCount(dynamicQuery);
159            }
160    
161            public static com.liferay.portlet.documentlibrary.model.DLContent fetchDLContent(
162                    long contentId)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().fetchDLContent(contentId);
165            }
166    
167            /**
168            * Returns the document library content with the primary key.
169            *
170            * @param contentId the primary key of the document library content
171            * @return the document library content
172            * @throws PortalException if a document library content with the primary key could not be found
173            * @throws SystemException if a system exception occurred
174            */
175            public static com.liferay.portlet.documentlibrary.model.DLContent getDLContent(
176                    long contentId)
177                    throws com.liferay.portal.kernel.exception.PortalException,
178                            com.liferay.portal.kernel.exception.SystemException {
179                    return getService().getDLContent(contentId);
180            }
181    
182            public static com.liferay.portal.model.PersistedModel getPersistedModel(
183                    java.io.Serializable primaryKeyObj)
184                    throws com.liferay.portal.kernel.exception.PortalException,
185                            com.liferay.portal.kernel.exception.SystemException {
186                    return getService().getPersistedModel(primaryKeyObj);
187            }
188    
189            /**
190            * Returns a range of all the document library contents.
191            *
192            * <p>
193            * 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.
194            * </p>
195            *
196            * @param start the lower bound of the range of document library contents
197            * @param end the upper bound of the range of document library contents (not inclusive)
198            * @return the range of document library contents
199            * @throws SystemException if a system exception occurred
200            */
201            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLContent> getDLContents(
202                    int start, int end)
203                    throws com.liferay.portal.kernel.exception.SystemException {
204                    return getService().getDLContents(start, end);
205            }
206    
207            /**
208            * Returns the number of document library contents.
209            *
210            * @return the number of document library contents
211            * @throws SystemException if a system exception occurred
212            */
213            public static int getDLContentsCount()
214                    throws com.liferay.portal.kernel.exception.SystemException {
215                    return getService().getDLContentsCount();
216            }
217    
218            /**
219            * Updates the document library content in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
220            *
221            * @param dlContent the document library content
222            * @return the document library content that was updated
223            * @throws SystemException if a system exception occurred
224            */
225            public static com.liferay.portlet.documentlibrary.model.DLContent updateDLContent(
226                    com.liferay.portlet.documentlibrary.model.DLContent dlContent)
227                    throws com.liferay.portal.kernel.exception.SystemException {
228                    return getService().updateDLContent(dlContent);
229            }
230    
231            /**
232            * Updates the document library content in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
233            *
234            * @param dlContent the document library content
235            * @param merge whether to merge the document library content with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
236            * @return the document library content that was updated
237            * @throws SystemException if a system exception occurred
238            */
239            public static com.liferay.portlet.documentlibrary.model.DLContent updateDLContent(
240                    com.liferay.portlet.documentlibrary.model.DLContent dlContent,
241                    boolean merge)
242                    throws com.liferay.portal.kernel.exception.SystemException {
243                    return getService().updateDLContent(dlContent, merge);
244            }
245    
246            public static com.liferay.portlet.documentlibrary.model.DLContentDataBlobModel getDataBlobModel(
247                    java.io.Serializable primaryKey)
248                    throws com.liferay.portal.kernel.exception.SystemException {
249                    return getService().getDataBlobModel(primaryKey);
250            }
251    
252            /**
253            * Returns the Spring bean ID for this bean.
254            *
255            * @return the Spring bean ID for this bean
256            */
257            public static java.lang.String getBeanIdentifier() {
258                    return getService().getBeanIdentifier();
259            }
260    
261            /**
262            * Sets the Spring bean ID for this bean.
263            *
264            * @param beanIdentifier the Spring bean ID for this bean
265            */
266            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
267                    getService().setBeanIdentifier(beanIdentifier);
268            }
269    
270            public static com.liferay.portlet.documentlibrary.model.DLContent addContent(
271                    long companyId, long repositoryId, java.lang.String path,
272                    java.lang.String version, byte[] bytes)
273                    throws com.liferay.portal.kernel.exception.SystemException {
274                    return getService()
275                                       .addContent(companyId, repositoryId, path, version, bytes);
276            }
277    
278            public static com.liferay.portlet.documentlibrary.model.DLContent addContent(
279                    long companyId, long repositoryId, java.lang.String path,
280                    java.lang.String version, java.io.InputStream inputStream, long size)
281                    throws com.liferay.portal.kernel.exception.SystemException {
282                    return getService()
283                                       .addContent(companyId, repositoryId, path, version,
284                            inputStream, size);
285            }
286    
287            public static void deleteContent(long companyId, long repositoryId,
288                    java.lang.String path, java.lang.String version)
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException {
291                    getService().deleteContent(companyId, repositoryId, path, version);
292            }
293    
294            public static void deleteContents(long companyId, long repositoryId,
295                    java.lang.String path)
296                    throws com.liferay.portal.kernel.exception.SystemException {
297                    getService().deleteContents(companyId, repositoryId, path);
298            }
299    
300            public static void deleteContentsByDirectory(long companyId,
301                    long repositoryId, java.lang.String dirName)
302                    throws com.liferay.portal.kernel.exception.SystemException {
303                    getService().deleteContentsByDirectory(companyId, repositoryId, dirName);
304            }
305    
306            public static com.liferay.portlet.documentlibrary.model.DLContent getContent(
307                    long companyId, long repositoryId, java.lang.String path)
308                    throws com.liferay.portal.kernel.exception.SystemException,
309                            com.liferay.portlet.documentlibrary.NoSuchContentException {
310                    return getService().getContent(companyId, repositoryId, path);
311            }
312    
313            public static com.liferay.portlet.documentlibrary.model.DLContent getContent(
314                    long companyId, long repositoryId, java.lang.String path,
315                    java.lang.String version)
316                    throws com.liferay.portal.kernel.exception.SystemException,
317                            com.liferay.portlet.documentlibrary.NoSuchContentException {
318                    return getService().getContent(companyId, repositoryId, path, version);
319            }
320    
321            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLContent> getContents(
322                    long companyId, long repositoryId)
323                    throws com.liferay.portal.kernel.exception.SystemException {
324                    return getService().getContents(companyId, repositoryId);
325            }
326    
327            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLContent> getContents(
328                    long companyId, long repositoryId, java.lang.String path)
329                    throws com.liferay.portal.kernel.exception.SystemException {
330                    return getService().getContents(companyId, repositoryId, path);
331            }
332    
333            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLContent> getContentsByDirectory(
334                    long companyId, long repositoryId, java.lang.String dirName)
335                    throws com.liferay.portal.kernel.exception.SystemException {
336                    return getService()
337                                       .getContentsByDirectory(companyId, repositoryId, dirName);
338            }
339    
340            public static boolean hasContent(long companyId, long repositoryId,
341                    java.lang.String path, java.lang.String version)
342                    throws com.liferay.portal.kernel.exception.SystemException {
343                    return getService().hasContent(companyId, repositoryId, path, version);
344            }
345    
346            public static void updateDLContent(long companyId, long oldRepositoryId,
347                    long newRepositoryId, java.lang.String oldPath, java.lang.String newPath)
348                    throws com.liferay.portal.kernel.exception.SystemException {
349                    getService()
350                            .updateDLContent(companyId, oldRepositoryId, newRepositoryId,
351                            oldPath, newPath);
352            }
353    
354            public static DLContentLocalService getService() {
355                    if (_service == null) {
356                            _service = (DLContentLocalService)PortalBeanLocatorUtil.locate(DLContentLocalService.class.getName());
357    
358                            ReferenceRegistry.registerReference(DLContentLocalServiceUtil.class,
359                                    "_service");
360                            MethodCache.remove(DLContentLocalService.class);
361                    }
362    
363                    return _service;
364            }
365    
366            public void setService(DLContentLocalService service) {
367                    MethodCache.remove(DLContentLocalService.class);
368    
369                    _service = service;
370    
371                    ReferenceRegistry.registerReference(DLContentLocalServiceUtil.class,
372                            "_service");
373                    MethodCache.remove(DLContentLocalService.class);
374            }
375    
376            private static DLContentLocalService _service;
377    }