001    /**
002     * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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.
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.
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.
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            * 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.
255            *
256            * @param dlFileEntryType the document library file entry type
257            * @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.
258            * @return the document library file entry type that was updated
259            * @throws SystemException if a system exception occurred
260            */
261            public static com.liferay.portlet.documentlibrary.model.DLFileEntryType updateDLFileEntryType(
262                    com.liferay.portlet.documentlibrary.model.DLFileEntryType dlFileEntryType,
263                    boolean merge)
264                    throws com.liferay.portal.kernel.exception.SystemException {
265                    return getService().updateDLFileEntryType(dlFileEntryType, merge);
266            }
267    
268            /**
269            * Returns the Spring bean ID for this bean.
270            *
271            * @return the Spring bean ID for this bean
272            */
273            public static java.lang.String getBeanIdentifier() {
274                    return getService().getBeanIdentifier();
275            }
276    
277            /**
278            * Sets the Spring bean ID for this bean.
279            *
280            * @param beanIdentifier the Spring bean ID for this bean
281            */
282            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
283                    getService().setBeanIdentifier(beanIdentifier);
284            }
285    
286            public static com.liferay.portlet.documentlibrary.model.DLFileEntryType addFileEntryType(
287                    long userId, long groupId, java.lang.String name,
288                    java.lang.String description, long[] ddmStructureIds,
289                    com.liferay.portal.service.ServiceContext serviceContext)
290                    throws com.liferay.portal.kernel.exception.PortalException,
291                            com.liferay.portal.kernel.exception.SystemException {
292                    return getService()
293                                       .addFileEntryType(userId, groupId, name, description,
294                            ddmStructureIds, serviceContext);
295            }
296    
297            public static void cascadeFileEntryTypes(long userId,
298                    com.liferay.portlet.documentlibrary.model.DLFolder dlFolder)
299                    throws com.liferay.portal.kernel.exception.PortalException,
300                            com.liferay.portal.kernel.exception.SystemException {
301                    getService().cascadeFileEntryTypes(userId, dlFolder);
302            }
303    
304            public static void deleteFileEntryType(
305                    com.liferay.portlet.documentlibrary.model.DLFileEntryType dlFileEntryType)
306                    throws com.liferay.portal.kernel.exception.PortalException,
307                            com.liferay.portal.kernel.exception.SystemException {
308                    getService().deleteFileEntryType(dlFileEntryType);
309            }
310    
311            public static void deleteFileEntryType(long fileEntryTypeId)
312                    throws com.liferay.portal.kernel.exception.PortalException,
313                            com.liferay.portal.kernel.exception.SystemException {
314                    getService().deleteFileEntryType(fileEntryTypeId);
315            }
316    
317            public static void deleteFileEntryTypes(long groupId)
318                    throws com.liferay.portal.kernel.exception.PortalException,
319                            com.liferay.portal.kernel.exception.SystemException {
320                    getService().deleteFileEntryTypes(groupId);
321            }
322    
323            public static com.liferay.portlet.documentlibrary.model.DLFileEntryType fetchFileEntryType(
324                    long fileEntryTypeId)
325                    throws com.liferay.portal.kernel.exception.SystemException {
326                    return getService().fetchFileEntryType(fileEntryTypeId);
327            }
328    
329            public static long getDefaultFileEntryTypeId(long folderId)
330                    throws com.liferay.portal.kernel.exception.PortalException,
331                            com.liferay.portal.kernel.exception.SystemException {
332                    return getService().getDefaultFileEntryTypeId(folderId);
333            }
334    
335            public static com.liferay.portlet.documentlibrary.model.DLFileEntryType getFileEntryType(
336                    long fileEntryTypeId)
337                    throws com.liferay.portal.kernel.exception.PortalException,
338                            com.liferay.portal.kernel.exception.SystemException {
339                    return getService().getFileEntryType(fileEntryTypeId);
340            }
341    
342            public static com.liferay.portlet.documentlibrary.model.DLFileEntryType getFileEntryType(
343                    long groupId, java.lang.String name)
344                    throws com.liferay.portal.kernel.exception.PortalException,
345                            com.liferay.portal.kernel.exception.SystemException {
346                    return getService().getFileEntryType(groupId, name);
347            }
348    
349            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntryType> getFileEntryTypes(
350                    long[] groupIds)
351                    throws com.liferay.portal.kernel.exception.SystemException {
352                    return getService().getFileEntryTypes(groupIds);
353            }
354    
355            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntryType> getFolderFileEntryTypes(
356                    long[] groupIds, long folderId, boolean inherited)
357                    throws com.liferay.portal.kernel.exception.PortalException,
358                            com.liferay.portal.kernel.exception.SystemException {
359                    return getService()
360                                       .getFolderFileEntryTypes(groupIds, folderId, inherited);
361            }
362    
363            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntryType> search(
364                    long companyId, long[] groupIds, java.lang.String keywords,
365                    boolean includeBasicFileEntryType, int start, int end,
366                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
367                    throws com.liferay.portal.kernel.exception.SystemException {
368                    return getService()
369                                       .search(companyId, groupIds, keywords,
370                            includeBasicFileEntryType, start, end, orderByComparator);
371            }
372    
373            public static int searchCount(long companyId, long[] groupIds,
374                    java.lang.String keywords, boolean includeBasicFileEntryType)
375                    throws com.liferay.portal.kernel.exception.SystemException {
376                    return getService()
377                                       .searchCount(companyId, groupIds, keywords,
378                            includeBasicFileEntryType);
379            }
380    
381            public static void unsetFolderFileEntryTypes(long folderId)
382                    throws com.liferay.portal.kernel.exception.SystemException {
383                    getService().unsetFolderFileEntryTypes(folderId);
384            }
385    
386            public static com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntryFileEntryType(
387                    com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry,
388                    com.liferay.portal.service.ServiceContext serviceContext)
389                    throws com.liferay.portal.kernel.exception.PortalException,
390                            com.liferay.portal.kernel.exception.SystemException {
391                    return getService()
392                                       .updateFileEntryFileEntryType(dlFileEntry, serviceContext);
393            }
394    
395            public static void updateFileEntryType(long userId, long fileEntryTypeId,
396                    java.lang.String name, java.lang.String description,
397                    long[] ddmStructureIds,
398                    com.liferay.portal.service.ServiceContext serviceContext)
399                    throws com.liferay.portal.kernel.exception.PortalException,
400                            com.liferay.portal.kernel.exception.SystemException {
401                    getService()
402                            .updateFileEntryType(userId, fileEntryTypeId, name, description,
403                            ddmStructureIds, serviceContext);
404            }
405    
406            public static void updateFolderFileEntryTypes(
407                    com.liferay.portlet.documentlibrary.model.DLFolder dlFolder,
408                    java.util.List<java.lang.Long> fileEntryTypeIds,
409                    long defaultFileEntryTypeId,
410                    com.liferay.portal.service.ServiceContext serviceContext)
411                    throws com.liferay.portal.kernel.exception.PortalException,
412                            com.liferay.portal.kernel.exception.SystemException {
413                    getService()
414                            .updateFolderFileEntryTypes(dlFolder, fileEntryTypeIds,
415                            defaultFileEntryTypeId, serviceContext);
416            }
417    
418            public static DLFileEntryTypeLocalService getService() {
419                    if (_service == null) {
420                            _service = (DLFileEntryTypeLocalService)PortalBeanLocatorUtil.locate(DLFileEntryTypeLocalService.class.getName());
421    
422                            ReferenceRegistry.registerReference(DLFileEntryTypeLocalServiceUtil.class,
423                                    "_service");
424                    }
425    
426                    return _service;
427            }
428    
429            /**
430             * @deprecated
431             */
432            public void setService(DLFileEntryTypeLocalService service) {
433            }
434    
435            private static DLFileEntryTypeLocalService _service;
436    }