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