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 file entry type local service. This utility wraps {@link com.liferay.portlet.documentlibrary.service.impl.DLFileEntryTypeLocalServiceImpl} 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 DLFileEntryTypeLocalService
030     * @see com.liferay.portlet.documentlibrary.service.base.DLFileEntryTypeLocalServiceBaseImpl
031     * @see com.liferay.portlet.documentlibrary.service.impl.DLFileEntryTypeLocalServiceImpl
032     * @generated
033     */
034    public class DLFileEntryTypeLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLFileEntryTypeLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the document library file entry type to the database. Also notifies the appropriate model listeners.
043            *
044            * @param dlFileEntryType the document library file entry type
045            * @return the document library file entry type that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.documentlibrary.model.DLFileEntryType addDLFileEntryType(
049                    com.liferay.portlet.documentlibrary.model.DLFileEntryType dlFileEntryType)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addDLFileEntryType(dlFileEntryType);
052            }
053    
054            /**
055            * Creates a new document library file entry type with the primary key. Does not add the document library file entry type to the database.
056            *
057            * @param fileEntryTypeId the primary key for the new document library file entry type
058            * @return the new document library file entry type
059            */
060            public static com.liferay.portlet.documentlibrary.model.DLFileEntryType createDLFileEntryType(
061                    long fileEntryTypeId) {
062                    return getService().createDLFileEntryType(fileEntryTypeId);
063            }
064    
065            /**
066            * Deletes the document library file entry type with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param fileEntryTypeId the primary key of the document library file entry type
069            * @throws PortalException if a document library file entry type with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteDLFileEntryType(long fileEntryTypeId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteDLFileEntryType(fileEntryTypeId);
076            }
077    
078            /**
079            * Deletes the document library file entry type from the database. Also notifies the appropriate model listeners.
080            *
081            * @param dlFileEntryType the document library file entry type
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteDLFileEntryType(
085                    com.liferay.portlet.documentlibrary.model.DLFileEntryType dlFileEntryType)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteDLFileEntryType(dlFileEntryType);
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.DLFileEntryType fetchDLFileEntryType(
162                    long fileEntryTypeId)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().fetchDLFileEntryType(fileEntryTypeId);
165            }
166    
167            /**
168            * Returns the document library file entry type with the primary key.
169            *
170            * @param fileEntryTypeId the primary key of the document library file entry type
171            * @return the document library file entry type
172            * @throws PortalException if a document library file entry type 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.DLFileEntryType getDLFileEntryType(
176                    long fileEntryTypeId)
177                    throws com.liferay.portal.kernel.exception.PortalException,
178                            com.liferay.portal.kernel.exception.SystemException {
179                    return getService().getDLFileEntryType(fileEntryTypeId);
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 the document library file entry type with the UUID in the group.
191            *
192            * @param uuid the UUID of document library file entry type
193            * @param groupId the group id of the document library file entry type
194            * @return the document library file entry type
195            * @throws PortalException if a document library file entry type with the UUID in the group could not be found
196            * @throws SystemException if a system exception occurred
197            */
198            public static com.liferay.portlet.documentlibrary.model.DLFileEntryType getDLFileEntryTypeByUuidAndGroupId(
199                    java.lang.String uuid, long groupId)
200                    throws com.liferay.portal.kernel.exception.PortalException,
201                            com.liferay.portal.kernel.exception.SystemException {
202                    return getService().getDLFileEntryTypeByUuidAndGroupId(uuid, groupId);
203            }
204    
205            /**
206            * Returns a range of all the document library file entry types.
207            *
208            * <p>
209            * 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.
210            * </p>
211            *
212            * @param start the lower bound of the range of document library file entry types
213            * @param end the upper bound of the range of document library file entry types (not inclusive)
214            * @return the range of document library file entry types
215            * @throws SystemException if a system exception occurred
216            */
217            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntryType> getDLFileEntryTypes(
218                    int start, int end)
219                    throws com.liferay.portal.kernel.exception.SystemException {
220                    return getService().getDLFileEntryTypes(start, end);
221            }
222    
223            /**
224            * Returns the number of document library file entry types.
225            *
226            * @return the number of document library file entry types
227            * @throws SystemException if a system exception occurred
228            */
229            public static int getDLFileEntryTypesCount()
230                    throws com.liferay.portal.kernel.exception.SystemException {
231                    return getService().getDLFileEntryTypesCount();
232            }
233    
234            /**
235            * Updates the document library file entry type in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
236            *
237            * @param dlFileEntryType the document library file entry type
238            * @return the document library file entry type that was updated
239            * @throws SystemException if a system exception occurred
240            */
241            public static com.liferay.portlet.documentlibrary.model.DLFileEntryType updateDLFileEntryType(
242                    com.liferay.portlet.documentlibrary.model.DLFileEntryType dlFileEntryType)
243                    throws com.liferay.portal.kernel.exception.SystemException {
244                    return getService().updateDLFileEntryType(dlFileEntryType);
245            }
246    
247            /**
248            * Updates the document library file entry type in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
249            *
250            * @param dlFileEntryType the document library file entry type
251            * @param merge whether to merge the document library file entry type 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.
252            * @return the document library file entry type that was updated
253            * @throws SystemException if a system exception occurred
254            */
255            public static com.liferay.portlet.documentlibrary.model.DLFileEntryType updateDLFileEntryType(
256                    com.liferay.portlet.documentlibrary.model.DLFileEntryType dlFileEntryType,
257                    boolean merge)
258                    throws com.liferay.portal.kernel.exception.SystemException {
259                    return getService().updateDLFileEntryType(dlFileEntryType, merge);
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.DLFileEntryType addFileEntryType(
281                    long userId, long groupId, java.lang.String name,
282                    java.lang.String description, long[] ddmStructureIds,
283                    com.liferay.portal.service.ServiceContext serviceContext)
284                    throws com.liferay.portal.kernel.exception.PortalException,
285                            com.liferay.portal.kernel.exception.SystemException {
286                    return getService()
287                                       .addFileEntryType(userId, groupId, name, description,
288                            ddmStructureIds, serviceContext);
289            }
290    
291            public static void cascadeFileEntryTypes(long userId,
292                    com.liferay.portlet.documentlibrary.model.DLFolder dlFolder)
293                    throws com.liferay.portal.kernel.exception.PortalException,
294                            com.liferay.portal.kernel.exception.SystemException {
295                    getService().cascadeFileEntryTypes(userId, dlFolder);
296            }
297    
298            public static void deleteFileEntryType(
299                    com.liferay.portlet.documentlibrary.model.DLFileEntryType dlFileEntryType)
300                    throws com.liferay.portal.kernel.exception.PortalException,
301                            com.liferay.portal.kernel.exception.SystemException {
302                    getService().deleteFileEntryType(dlFileEntryType);
303            }
304    
305            public static void deleteFileEntryType(long fileEntryTypeId)
306                    throws com.liferay.portal.kernel.exception.PortalException,
307                            com.liferay.portal.kernel.exception.SystemException {
308                    getService().deleteFileEntryType(fileEntryTypeId);
309            }
310    
311            public static void deleteFileEntryTypes(long groupId)
312                    throws com.liferay.portal.kernel.exception.PortalException,
313                            com.liferay.portal.kernel.exception.SystemException {
314                    getService().deleteFileEntryTypes(groupId);
315            }
316    
317            public static com.liferay.portlet.documentlibrary.model.DLFileEntryType fetchFileEntryType(
318                    long fileEntryTypeId)
319                    throws com.liferay.portal.kernel.exception.SystemException {
320                    return getService().fetchFileEntryType(fileEntryTypeId);
321            }
322    
323            public static long getDefaultFileEntryTypeId(long folderId)
324                    throws com.liferay.portal.kernel.exception.PortalException,
325                            com.liferay.portal.kernel.exception.SystemException {
326                    return getService().getDefaultFileEntryTypeId(folderId);
327            }
328    
329            public static com.liferay.portlet.documentlibrary.model.DLFileEntryType getFileEntryType(
330                    long fileEntryTypeId)
331                    throws com.liferay.portal.kernel.exception.PortalException,
332                            com.liferay.portal.kernel.exception.SystemException {
333                    return getService().getFileEntryType(fileEntryTypeId);
334            }
335    
336            public static com.liferay.portlet.documentlibrary.model.DLFileEntryType getFileEntryType(
337                    long groupId, java.lang.String name)
338                    throws com.liferay.portal.kernel.exception.PortalException,
339                            com.liferay.portal.kernel.exception.SystemException {
340                    return getService().getFileEntryType(groupId, name);
341            }
342    
343            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntryType> getFileEntryTypes(
344                    long[] groupIds)
345                    throws com.liferay.portal.kernel.exception.SystemException {
346                    return getService().getFileEntryTypes(groupIds);
347            }
348    
349            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntryType> getFolderFileEntryTypes(
350                    long[] groupIds, long folderId, boolean inherited)
351                    throws com.liferay.portal.kernel.exception.PortalException,
352                            com.liferay.portal.kernel.exception.SystemException {
353                    return getService()
354                                       .getFolderFileEntryTypes(groupIds, folderId, inherited);
355            }
356    
357            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntryType> search(
358                    long companyId, long[] groupIds, java.lang.String keywords,
359                    boolean includeBasicFileEntryType, int start, int end,
360                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
361                    throws com.liferay.portal.kernel.exception.SystemException {
362                    return getService()
363                                       .search(companyId, groupIds, keywords,
364                            includeBasicFileEntryType, start, end, orderByComparator);
365            }
366    
367            public static int searchCount(long companyId, long[] groupIds,
368                    java.lang.String keywords, boolean includeBasicFileEntryType)
369                    throws com.liferay.portal.kernel.exception.SystemException {
370                    return getService()
371                                       .searchCount(companyId, groupIds, keywords,
372                            includeBasicFileEntryType);
373            }
374    
375            public static void unsetFolderFileEntryTypes(long folderId)
376                    throws com.liferay.portal.kernel.exception.SystemException {
377                    getService().unsetFolderFileEntryTypes(folderId);
378            }
379    
380            public static com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntryFileEntryType(
381                    com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry,
382                    com.liferay.portal.service.ServiceContext serviceContext)
383                    throws com.liferay.portal.kernel.exception.PortalException,
384                            com.liferay.portal.kernel.exception.SystemException {
385                    return getService()
386                                       .updateFileEntryFileEntryType(dlFileEntry, serviceContext);
387            }
388    
389            public static void updateFileEntryType(long userId, long fileEntryTypeId,
390                    java.lang.String name, java.lang.String description,
391                    long[] ddmStructureIds,
392                    com.liferay.portal.service.ServiceContext serviceContext)
393                    throws com.liferay.portal.kernel.exception.PortalException,
394                            com.liferay.portal.kernel.exception.SystemException {
395                    getService()
396                            .updateFileEntryType(userId, fileEntryTypeId, name, description,
397                            ddmStructureIds, serviceContext);
398            }
399    
400            public static void updateFolderFileEntryTypes(
401                    com.liferay.portlet.documentlibrary.model.DLFolder dlFolder,
402                    java.util.List<java.lang.Long> fileEntryTypeIds,
403                    long defaultFileEntryTypeId,
404                    com.liferay.portal.service.ServiceContext serviceContext)
405                    throws com.liferay.portal.kernel.exception.PortalException,
406                            com.liferay.portal.kernel.exception.SystemException {
407                    getService()
408                            .updateFolderFileEntryTypes(dlFolder, fileEntryTypeIds,
409                            defaultFileEntryTypeId, serviceContext);
410            }
411    
412            public static DLFileEntryTypeLocalService getService() {
413                    if (_service == null) {
414                            _service = (DLFileEntryTypeLocalService)PortalBeanLocatorUtil.locate(DLFileEntryTypeLocalService.class.getName());
415    
416                            ReferenceRegistry.registerReference(DLFileEntryTypeLocalServiceUtil.class,
417                                    "_service");
418                            MethodCache.remove(DLFileEntryTypeLocalService.class);
419                    }
420    
421                    return _service;
422            }
423    
424            public void setService(DLFileEntryTypeLocalService service) {
425                    MethodCache.remove(DLFileEntryTypeLocalService.class);
426    
427                    _service = service;
428    
429                    ReferenceRegistry.registerReference(DLFileEntryTypeLocalServiceUtil.class,
430                            "_service");
431                    MethodCache.remove(DLFileEntryTypeLocalService.class);
432            }
433    
434            private static DLFileEntryTypeLocalService _service;
435    }