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.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.
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.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.
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            * Updates the asset category in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
255            *
256            * @param assetCategory the asset category
257            * @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.
258            * @return the asset category that was updated
259            * @throws SystemException if a system exception occurred
260            */
261            public static com.liferay.portlet.asset.model.AssetCategory updateAssetCategory(
262                    com.liferay.portlet.asset.model.AssetCategory assetCategory,
263                    boolean merge)
264                    throws com.liferay.portal.kernel.exception.SystemException {
265                    return getService().updateAssetCategory(assetCategory, 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.asset.model.AssetCategory addCategory(
287                    long userId, long parentCategoryId,
288                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
289                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
290                    long vocabularyId, java.lang.String[] categoryProperties,
291                    com.liferay.portal.service.ServiceContext serviceContext)
292                    throws com.liferay.portal.kernel.exception.PortalException,
293                            com.liferay.portal.kernel.exception.SystemException {
294                    return getService()
295                                       .addCategory(userId, parentCategoryId, titleMap,
296                            descriptionMap, vocabularyId, categoryProperties, serviceContext);
297            }
298    
299            public static void addCategoryResources(
300                    com.liferay.portlet.asset.model.AssetCategory category,
301                    boolean addGroupPermissions, boolean addGuestPermissions)
302                    throws com.liferay.portal.kernel.exception.PortalException,
303                            com.liferay.portal.kernel.exception.SystemException {
304                    getService()
305                            .addCategoryResources(category, addGroupPermissions,
306                            addGuestPermissions);
307            }
308    
309            public static void addCategoryResources(
310                    com.liferay.portlet.asset.model.AssetCategory category,
311                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
312                    throws com.liferay.portal.kernel.exception.PortalException,
313                            com.liferay.portal.kernel.exception.SystemException {
314                    getService()
315                            .addCategoryResources(category, groupPermissions, guestPermissions);
316            }
317    
318            public static void deleteCategory(
319                    com.liferay.portlet.asset.model.AssetCategory category)
320                    throws com.liferay.portal.kernel.exception.PortalException,
321                            com.liferay.portal.kernel.exception.SystemException {
322                    getService().deleteCategory(category);
323            }
324    
325            public static void deleteCategory(long categoryId)
326                    throws com.liferay.portal.kernel.exception.PortalException,
327                            com.liferay.portal.kernel.exception.SystemException {
328                    getService().deleteCategory(categoryId);
329            }
330    
331            public static void deleteVocabularyCategories(long vocabularyId)
332                    throws com.liferay.portal.kernel.exception.PortalException,
333                            com.liferay.portal.kernel.exception.SystemException {
334                    getService().deleteVocabularyCategories(vocabularyId);
335            }
336    
337            public static com.liferay.portlet.asset.model.AssetCategory fetchCategory(
338                    long categoryId)
339                    throws com.liferay.portal.kernel.exception.SystemException {
340                    return getService().fetchCategory(categoryId);
341            }
342    
343            public static java.util.List<com.liferay.portlet.asset.model.AssetCategory> getCategories()
344                    throws com.liferay.portal.kernel.exception.SystemException {
345                    return getService().getCategories();
346            }
347    
348            public static java.util.List<com.liferay.portlet.asset.model.AssetCategory> getCategories(
349                    long classNameId, long classPK)
350                    throws com.liferay.portal.kernel.exception.SystemException {
351                    return getService().getCategories(classNameId, classPK);
352            }
353    
354            public static java.util.List<com.liferay.portlet.asset.model.AssetCategory> getCategories(
355                    java.lang.String className, long classPK)
356                    throws com.liferay.portal.kernel.exception.SystemException {
357                    return getService().getCategories(className, classPK);
358            }
359    
360            public static com.liferay.portlet.asset.model.AssetCategory getCategory(
361                    long categoryId)
362                    throws com.liferay.portal.kernel.exception.PortalException,
363                            com.liferay.portal.kernel.exception.SystemException {
364                    return getService().getCategory(categoryId);
365            }
366    
367            public static long[] getCategoryIds(java.lang.String className, long classPK)
368                    throws com.liferay.portal.kernel.exception.SystemException {
369                    return getService().getCategoryIds(className, classPK);
370            }
371    
372            public static java.lang.String[] getCategoryNames()
373                    throws com.liferay.portal.kernel.exception.SystemException {
374                    return getService().getCategoryNames();
375            }
376    
377            public static java.lang.String[] getCategoryNames(long classNameId,
378                    long classPK)
379                    throws com.liferay.portal.kernel.exception.SystemException {
380                    return getService().getCategoryNames(classNameId, classPK);
381            }
382    
383            public static java.lang.String[] getCategoryNames(
384                    java.lang.String className, long classPK)
385                    throws com.liferay.portal.kernel.exception.SystemException {
386                    return getService().getCategoryNames(className, classPK);
387            }
388    
389            public static java.util.List<com.liferay.portlet.asset.model.AssetCategory> getChildCategories(
390                    long parentCategoryId)
391                    throws com.liferay.portal.kernel.exception.SystemException {
392                    return getService().getChildCategories(parentCategoryId);
393            }
394    
395            public static java.util.List<com.liferay.portlet.asset.model.AssetCategory> getChildCategories(
396                    long parentCategoryId, int start, int end,
397                    com.liferay.portal.kernel.util.OrderByComparator obc)
398                    throws com.liferay.portal.kernel.exception.SystemException {
399                    return getService().getChildCategories(parentCategoryId, start, end, obc);
400            }
401    
402            public static int getChildCategoriesCount(long parentCategoryId)
403                    throws com.liferay.portal.kernel.exception.SystemException {
404                    return getService().getChildCategoriesCount(parentCategoryId);
405            }
406    
407            public static java.util.List<com.liferay.portlet.asset.model.AssetCategory> getEntryCategories(
408                    long entryId)
409                    throws com.liferay.portal.kernel.exception.SystemException {
410                    return getService().getEntryCategories(entryId);
411            }
412    
413            public static java.util.List<com.liferay.portlet.asset.model.AssetCategory> getVocabularyCategories(
414                    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(vocabularyId, start, end, obc);
419            }
420    
421            public static java.util.List<com.liferay.portlet.asset.model.AssetCategory> getVocabularyCategories(
422                    long parentCategoryId, long vocabularyId, int start, int end,
423                    com.liferay.portal.kernel.util.OrderByComparator obc)
424                    throws com.liferay.portal.kernel.exception.SystemException {
425                    return getService()
426                                       .getVocabularyCategories(parentCategoryId, vocabularyId,
427                            start, end, obc);
428            }
429    
430            public static int getVocabularyCategoriesCount(long vocabularyId)
431                    throws com.liferay.portal.kernel.exception.SystemException {
432                    return getService().getVocabularyCategoriesCount(vocabularyId);
433            }
434    
435            public static java.util.List<com.liferay.portlet.asset.model.AssetCategory> getVocabularyRootCategories(
436                    long vocabularyId, int start, int end,
437                    com.liferay.portal.kernel.util.OrderByComparator obc)
438                    throws com.liferay.portal.kernel.exception.SystemException {
439                    return getService()
440                                       .getVocabularyRootCategories(vocabularyId, start, end, obc);
441            }
442    
443            public static void mergeCategories(long fromCategoryId, long toCategoryId)
444                    throws com.liferay.portal.kernel.exception.PortalException,
445                            com.liferay.portal.kernel.exception.SystemException {
446                    getService().mergeCategories(fromCategoryId, toCategoryId);
447            }
448    
449            public static com.liferay.portlet.asset.model.AssetCategory moveCategory(
450                    long categoryId, long parentCategoryId, long vocabularyId,
451                    com.liferay.portal.service.ServiceContext serviceContext)
452                    throws com.liferay.portal.kernel.exception.PortalException,
453                            com.liferay.portal.kernel.exception.SystemException {
454                    return getService()
455                                       .moveCategory(categoryId, parentCategoryId, vocabularyId,
456                            serviceContext);
457            }
458    
459            public static void rebuildTree(long groupId, boolean force)
460                    throws com.liferay.portal.kernel.exception.SystemException {
461                    getService().rebuildTree(groupId, force);
462            }
463    
464            public static java.util.List<com.liferay.portlet.asset.model.AssetCategory> search(
465                    long groupId, java.lang.String name,
466                    java.lang.String[] categoryProperties, int start, int end)
467                    throws com.liferay.portal.kernel.exception.SystemException {
468                    return getService().search(groupId, name, categoryProperties, start, end);
469            }
470    
471            public static com.liferay.portlet.asset.model.AssetCategory updateCategory(
472                    long userId, long categoryId, long parentCategoryId,
473                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
474                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
475                    long vocabularyId, java.lang.String[] categoryProperties,
476                    com.liferay.portal.service.ServiceContext serviceContext)
477                    throws com.liferay.portal.kernel.exception.PortalException,
478                            com.liferay.portal.kernel.exception.SystemException {
479                    return getService()
480                                       .updateCategory(userId, categoryId, parentCategoryId,
481                            titleMap, descriptionMap, vocabularyId, categoryProperties,
482                            serviceContext);
483            }
484    
485            public static AssetCategoryLocalService getService() {
486                    if (_service == null) {
487                            _service = (AssetCategoryLocalService)PortalBeanLocatorUtil.locate(AssetCategoryLocalService.class.getName());
488    
489                            ReferenceRegistry.registerReference(AssetCategoryLocalServiceUtil.class,
490                                    "_service");
491                    }
492    
493                    return _service;
494            }
495    
496            /**
497             * @deprecated
498             */
499            public void setService(AssetCategoryLocalService service) {
500            }
501    
502            private static AssetCategoryLocalService _service;
503    }