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.asset.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 asset category local service. This utility wraps {@link com.liferay.portlet.asset.service.impl.AssetCategoryLocalServiceImpl} 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 AssetCategoryLocalService
029     * @see com.liferay.portlet.asset.service.base.AssetCategoryLocalServiceBaseImpl
030     * @see com.liferay.portlet.asset.service.impl.AssetCategoryLocalServiceImpl
031     * @generated
032     */
033    public class AssetCategoryLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.asset.service.impl.AssetCategoryLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
038             */
039    
040            /**
041            * Adds the asset category to the database. Also notifies the appropriate model listeners.
042            *
043            * @param assetCategory the asset category
044            * @return the asset category that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portlet.asset.model.AssetCategory addAssetCategory(
048                    com.liferay.portlet.asset.model.AssetCategory assetCategory)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addAssetCategory(assetCategory);
051            }
052    
053            /**
054            * Creates a new asset category with the primary key. Does not add the asset category to the database.
055            *
056            * @param categoryId the primary key for the new asset category
057            * @return the new asset category
058            */
059            public static com.liferay.portlet.asset.model.AssetCategory createAssetCategory(
060                    long categoryId) {
061                    return getService().createAssetCategory(categoryId);
062            }
063    
064            /**
065            * Deletes the asset category with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param categoryId the primary key of the asset category
068            * @return the asset category that was removed
069            * @throws PortalException if a asset category with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static com.liferay.portlet.asset.model.AssetCategory deleteAssetCategory(
073                    long categoryId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteAssetCategory(categoryId);
077            }
078    
079            /**
080            * Deletes the asset category from the database. Also notifies the appropriate model listeners.
081            *
082            * @param assetCategory the asset category
083            * @return the asset category that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portlet.asset.model.AssetCategory deleteAssetCategory(
087                    com.liferay.portlet.asset.model.AssetCategory assetCategory)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deleteAssetCategory(assetCategory);
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.asset.model.impl.AssetCategoryModelImpl}. 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.asset.model.impl.AssetCategoryModelImpl}. 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.asset.model.AssetCategory fetchAssetCategory(
168                    long categoryId)
169                    throws com.liferay.portal.kernel.exception.SystemException {
170                    return getService().fetchAssetCategory(categoryId);
171            }
172    
173            /**
174            * Returns the asset category with the primary key.
175            *
176            * @param categoryId the primary key of the asset category
177            * @return the asset category
178            * @throws PortalException if a asset category with the primary key could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            public static com.liferay.portlet.asset.model.AssetCategory getAssetCategory(
182                    long categoryId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getAssetCategory(categoryId);
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 asset category with the UUID in the group.
197            *
198            * @param uuid the UUID of asset category
199            * @param groupId the group id of the asset category
200            * @return the asset category
201            * @throws PortalException if a asset category 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.asset.model.AssetCategory getAssetCategoryByUuidAndGroupId(
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().getAssetCategoryByUuidAndGroupId(uuid, groupId);
209            }
210    
211            /**
212            * Returns a range of all the asset categories.
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.asset.model.impl.AssetCategoryModelImpl}. 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 asset categories
219            * @param end the upper bound of the range of asset categories (not inclusive)
220            * @return the range of asset categories
221            * @throws SystemException if a system exception occurred
222            */
223            public static java.util.List<com.liferay.portlet.asset.model.AssetCategory> getAssetCategories(
224                    int start, int end)
225                    throws com.liferay.portal.kernel.exception.SystemException {
226                    return getService().getAssetCategories(start, end);
227            }
228    
229            /**
230            * Returns the number of asset categories.
231            *
232            * @return the number of asset categories
233            * @throws SystemException if a system exception occurred
234            */
235            public static int getAssetCategoriesCount()
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService().getAssetCategoriesCount();
238            }
239    
240            /**
241            * Updates the asset category in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
242            *
243            * @param assetCategory the asset category
244            * @return the asset category that was updated
245            * @throws SystemException if a system exception occurred
246            */
247            public static com.liferay.portlet.asset.model.AssetCategory updateAssetCategory(
248                    com.liferay.portlet.asset.model.AssetCategory assetCategory)
249                    throws com.liferay.portal.kernel.exception.SystemException {
250                    return getService().updateAssetCategory(assetCategory);
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.asset.model.AssetCategory addCategory(
272                    long userId, long parentCategoryId,
273                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
274                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
275                    long vocabularyId, java.lang.String[] categoryProperties,
276                    com.liferay.portal.service.ServiceContext serviceContext)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException {
279                    return getService()
280                                       .addCategory(userId, parentCategoryId, titleMap,
281                            descriptionMap, vocabularyId, categoryProperties, serviceContext);
282            }
283    
284            public static void addCategoryResources(
285                    com.liferay.portlet.asset.model.AssetCategory category,
286                    boolean addGroupPermissions, boolean addGuestPermissions)
287                    throws com.liferay.portal.kernel.exception.PortalException,
288                            com.liferay.portal.kernel.exception.SystemException {
289                    getService()
290                            .addCategoryResources(category, addGroupPermissions,
291                            addGuestPermissions);
292            }
293    
294            public static void addCategoryResources(
295                    com.liferay.portlet.asset.model.AssetCategory category,
296                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
297                    throws com.liferay.portal.kernel.exception.PortalException,
298                            com.liferay.portal.kernel.exception.SystemException {
299                    getService()
300                            .addCategoryResources(category, groupPermissions, guestPermissions);
301            }
302    
303            public static void deleteCategory(
304                    com.liferay.portlet.asset.model.AssetCategory category)
305                    throws com.liferay.portal.kernel.exception.PortalException,
306                            com.liferay.portal.kernel.exception.SystemException {
307                    getService().deleteCategory(category);
308            }
309    
310            public static void deleteCategory(long categoryId)
311                    throws com.liferay.portal.kernel.exception.PortalException,
312                            com.liferay.portal.kernel.exception.SystemException {
313                    getService().deleteCategory(categoryId);
314            }
315    
316            public static void deleteVocabularyCategories(long vocabularyId)
317                    throws com.liferay.portal.kernel.exception.PortalException,
318                            com.liferay.portal.kernel.exception.SystemException {
319                    getService().deleteVocabularyCategories(vocabularyId);
320            }
321    
322            public static com.liferay.portlet.asset.model.AssetCategory fetchCategory(
323                    long categoryId)
324                    throws com.liferay.portal.kernel.exception.SystemException {
325                    return getService().fetchCategory(categoryId);
326            }
327    
328            public static java.util.List<com.liferay.portlet.asset.model.AssetCategory> getCategories()
329                    throws com.liferay.portal.kernel.exception.SystemException {
330                    return getService().getCategories();
331            }
332    
333            public static java.util.List<com.liferay.portlet.asset.model.AssetCategory> getCategories(
334                    long classNameId, long classPK)
335                    throws com.liferay.portal.kernel.exception.SystemException {
336                    return getService().getCategories(classNameId, classPK);
337            }
338    
339            public static java.util.List<com.liferay.portlet.asset.model.AssetCategory> getCategories(
340                    java.lang.String className, long classPK)
341                    throws com.liferay.portal.kernel.exception.SystemException {
342                    return getService().getCategories(className, classPK);
343            }
344    
345            public static com.liferay.portlet.asset.model.AssetCategory getCategory(
346                    long categoryId)
347                    throws com.liferay.portal.kernel.exception.PortalException,
348                            com.liferay.portal.kernel.exception.SystemException {
349                    return getService().getCategory(categoryId);
350            }
351    
352            public static com.liferay.portlet.asset.model.AssetCategory getCategory(
353                    java.lang.String uuid, long groupId)
354                    throws com.liferay.portal.kernel.exception.PortalException,
355                            com.liferay.portal.kernel.exception.SystemException {
356                    return getService().getCategory(uuid, groupId);
357            }
358    
359            public static long[] getCategoryIds(java.lang.String className, long classPK)
360                    throws com.liferay.portal.kernel.exception.SystemException {
361                    return getService().getCategoryIds(className, classPK);
362            }
363    
364            public static java.lang.String[] getCategoryNames()
365                    throws com.liferay.portal.kernel.exception.SystemException {
366                    return getService().getCategoryNames();
367            }
368    
369            public static java.lang.String[] getCategoryNames(long classNameId,
370                    long classPK)
371                    throws com.liferay.portal.kernel.exception.SystemException {
372                    return getService().getCategoryNames(classNameId, classPK);
373            }
374    
375            public static java.lang.String[] getCategoryNames(
376                    java.lang.String className, long classPK)
377                    throws com.liferay.portal.kernel.exception.SystemException {
378                    return getService().getCategoryNames(className, classPK);
379            }
380    
381            public static java.util.List<com.liferay.portlet.asset.model.AssetCategory> getChildCategories(
382                    long parentCategoryId)
383                    throws com.liferay.portal.kernel.exception.SystemException {
384                    return getService().getChildCategories(parentCategoryId);
385            }
386    
387            public static java.util.List<com.liferay.portlet.asset.model.AssetCategory> getChildCategories(
388                    long parentCategoryId, int start, int end,
389                    com.liferay.portal.kernel.util.OrderByComparator obc)
390                    throws com.liferay.portal.kernel.exception.SystemException {
391                    return getService().getChildCategories(parentCategoryId, start, end, obc);
392            }
393    
394            public static int getChildCategoriesCount(long parentCategoryId)
395                    throws com.liferay.portal.kernel.exception.SystemException {
396                    return getService().getChildCategoriesCount(parentCategoryId);
397            }
398    
399            public static java.util.List<com.liferay.portlet.asset.model.AssetCategory> getEntryCategories(
400                    long entryId)
401                    throws com.liferay.portal.kernel.exception.SystemException {
402                    return getService().getEntryCategories(entryId);
403            }
404    
405            public static java.util.List<com.liferay.portlet.asset.model.AssetCategory> getVocabularyCategories(
406                    long vocabularyId, int start, int end,
407                    com.liferay.portal.kernel.util.OrderByComparator obc)
408                    throws com.liferay.portal.kernel.exception.SystemException {
409                    return getService()
410                                       .getVocabularyCategories(vocabularyId, start, end, obc);
411            }
412    
413            public static java.util.List<com.liferay.portlet.asset.model.AssetCategory> getVocabularyCategories(
414                    long parentCategoryId, long vocabularyId, int start, int end,
415                    com.liferay.portal.kernel.util.OrderByComparator obc)
416                    throws com.liferay.portal.kernel.exception.SystemException {
417                    return getService()
418                                       .getVocabularyCategories(parentCategoryId, vocabularyId,
419                            start, end, obc);
420            }
421    
422            public static int getVocabularyCategoriesCount(long vocabularyId)
423                    throws com.liferay.portal.kernel.exception.SystemException {
424                    return getService().getVocabularyCategoriesCount(vocabularyId);
425            }
426    
427            public static java.util.List<com.liferay.portlet.asset.model.AssetCategory> getVocabularyRootCategories(
428                    long vocabularyId, int start, int end,
429                    com.liferay.portal.kernel.util.OrderByComparator obc)
430                    throws com.liferay.portal.kernel.exception.SystemException {
431                    return getService()
432                                       .getVocabularyRootCategories(vocabularyId, start, end, obc);
433            }
434    
435            public static void mergeCategories(long fromCategoryId, long toCategoryId)
436                    throws com.liferay.portal.kernel.exception.PortalException,
437                            com.liferay.portal.kernel.exception.SystemException {
438                    getService().mergeCategories(fromCategoryId, toCategoryId);
439            }
440    
441            public static com.liferay.portlet.asset.model.AssetCategory moveCategory(
442                    long categoryId, long parentCategoryId, long vocabularyId,
443                    com.liferay.portal.service.ServiceContext serviceContext)
444                    throws com.liferay.portal.kernel.exception.PortalException,
445                            com.liferay.portal.kernel.exception.SystemException {
446                    return getService()
447                                       .moveCategory(categoryId, parentCategoryId, vocabularyId,
448                            serviceContext);
449            }
450    
451            public static void rebuildTree(long groupId, boolean force)
452                    throws com.liferay.portal.kernel.exception.SystemException {
453                    getService().rebuildTree(groupId, force);
454            }
455    
456            public static java.util.List<com.liferay.portlet.asset.model.AssetCategory> search(
457                    long groupId, java.lang.String name,
458                    java.lang.String[] categoryProperties, int start, int end)
459                    throws com.liferay.portal.kernel.exception.SystemException {
460                    return getService().search(groupId, name, categoryProperties, start, end);
461            }
462    
463            public static com.liferay.portlet.asset.model.AssetCategory updateCategory(
464                    long userId, long categoryId, long parentCategoryId,
465                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
466                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
467                    long vocabularyId, java.lang.String[] categoryProperties,
468                    com.liferay.portal.service.ServiceContext serviceContext)
469                    throws com.liferay.portal.kernel.exception.PortalException,
470                            com.liferay.portal.kernel.exception.SystemException {
471                    return getService()
472                                       .updateCategory(userId, categoryId, parentCategoryId,
473                            titleMap, descriptionMap, vocabularyId, categoryProperties,
474                            serviceContext);
475            }
476    
477            public static AssetCategoryLocalService getService() {
478                    if (_service == null) {
479                            _service = (AssetCategoryLocalService)PortalBeanLocatorUtil.locate(AssetCategoryLocalService.class.getName());
480    
481                            ReferenceRegistry.registerReference(AssetCategoryLocalServiceUtil.class,
482                                    "_service");
483                    }
484    
485                    return _service;
486            }
487    
488            /**
489             * @deprecated
490             */
491            public void setService(AssetCategoryLocalService service) {
492            }
493    
494            private static AssetCategoryLocalService _service;
495    }