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