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.MethodCache;
019    import com.liferay.portal.kernel.util.ReferenceRegistry;
020    
021    /**
022     * The utility for the asset vocabulary local service. This utility wraps {@link com.liferay.portlet.asset.service.impl.AssetVocabularyLocalServiceImpl} 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 AssetVocabularyLocalService
030     * @see com.liferay.portlet.asset.service.base.AssetVocabularyLocalServiceBaseImpl
031     * @see com.liferay.portlet.asset.service.impl.AssetVocabularyLocalServiceImpl
032     * @generated
033     */
034    public class AssetVocabularyLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.asset.service.impl.AssetVocabularyLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the asset vocabulary to the database. Also notifies the appropriate model listeners.
043            *
044            * @param assetVocabulary the asset vocabulary
045            * @return the asset vocabulary that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.asset.model.AssetVocabulary addAssetVocabulary(
049                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addAssetVocabulary(assetVocabulary);
052            }
053    
054            /**
055            * Creates a new asset vocabulary with the primary key. Does not add the asset vocabulary to the database.
056            *
057            * @param vocabularyId the primary key for the new asset vocabulary
058            * @return the new asset vocabulary
059            */
060            public static com.liferay.portlet.asset.model.AssetVocabulary createAssetVocabulary(
061                    long vocabularyId) {
062                    return getService().createAssetVocabulary(vocabularyId);
063            }
064    
065            /**
066            * Deletes the asset vocabulary with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param vocabularyId the primary key of the asset vocabulary
069            * @throws PortalException if a asset vocabulary with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteAssetVocabulary(long vocabularyId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteAssetVocabulary(vocabularyId);
076            }
077    
078            /**
079            * Deletes the asset vocabulary from the database. Also notifies the appropriate model listeners.
080            *
081            * @param assetVocabulary the asset vocabulary
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteAssetVocabulary(
085                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteAssetVocabulary(assetVocabulary);
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            public static com.liferay.portlet.asset.model.AssetVocabulary fetchAssetVocabulary(
162                    long vocabularyId)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().fetchAssetVocabulary(vocabularyId);
165            }
166    
167            /**
168            * Returns the asset vocabulary with the primary key.
169            *
170            * @param vocabularyId the primary key of the asset vocabulary
171            * @return the asset vocabulary
172            * @throws PortalException if a asset vocabulary with the primary key could not be found
173            * @throws SystemException if a system exception occurred
174            */
175            public static com.liferay.portlet.asset.model.AssetVocabulary getAssetVocabulary(
176                    long vocabularyId)
177                    throws com.liferay.portal.kernel.exception.PortalException,
178                            com.liferay.portal.kernel.exception.SystemException {
179                    return getService().getAssetVocabulary(vocabularyId);
180            }
181    
182            public static com.liferay.portal.model.PersistedModel getPersistedModel(
183                    java.io.Serializable primaryKeyObj)
184                    throws com.liferay.portal.kernel.exception.PortalException,
185                            com.liferay.portal.kernel.exception.SystemException {
186                    return getService().getPersistedModel(primaryKeyObj);
187            }
188    
189            /**
190            * Returns the asset vocabulary with the UUID in the group.
191            *
192            * @param uuid the UUID of asset vocabulary
193            * @param groupId the group id of the asset vocabulary
194            * @return the asset vocabulary
195            * @throws PortalException if a asset vocabulary with the UUID in the group could not be found
196            * @throws SystemException if a system exception occurred
197            */
198            public static com.liferay.portlet.asset.model.AssetVocabulary getAssetVocabularyByUuidAndGroupId(
199                    java.lang.String uuid, long groupId)
200                    throws com.liferay.portal.kernel.exception.PortalException,
201                            com.liferay.portal.kernel.exception.SystemException {
202                    return getService().getAssetVocabularyByUuidAndGroupId(uuid, groupId);
203            }
204    
205            /**
206            * Returns a range of all the asset vocabularies.
207            *
208            * <p>
209            * 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.
210            * </p>
211            *
212            * @param start the lower bound of the range of asset vocabularies
213            * @param end the upper bound of the range of asset vocabularies (not inclusive)
214            * @return the range of asset vocabularies
215            * @throws SystemException if a system exception occurred
216            */
217            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getAssetVocabularies(
218                    int start, int end)
219                    throws com.liferay.portal.kernel.exception.SystemException {
220                    return getService().getAssetVocabularies(start, end);
221            }
222    
223            /**
224            * Returns the number of asset vocabularies.
225            *
226            * @return the number of asset vocabularies
227            * @throws SystemException if a system exception occurred
228            */
229            public static int getAssetVocabulariesCount()
230                    throws com.liferay.portal.kernel.exception.SystemException {
231                    return getService().getAssetVocabulariesCount();
232            }
233    
234            /**
235            * Updates the asset vocabulary in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
236            *
237            * @param assetVocabulary the asset vocabulary
238            * @return the asset vocabulary that was updated
239            * @throws SystemException if a system exception occurred
240            */
241            public static com.liferay.portlet.asset.model.AssetVocabulary updateAssetVocabulary(
242                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary)
243                    throws com.liferay.portal.kernel.exception.SystemException {
244                    return getService().updateAssetVocabulary(assetVocabulary);
245            }
246    
247            /**
248            * Updates the asset vocabulary in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
249            *
250            * @param assetVocabulary the asset vocabulary
251            * @param merge whether to merge the asset vocabulary 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.
252            * @return the asset vocabulary that was updated
253            * @throws SystemException if a system exception occurred
254            */
255            public static com.liferay.portlet.asset.model.AssetVocabulary updateAssetVocabulary(
256                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary,
257                    boolean merge)
258                    throws com.liferay.portal.kernel.exception.SystemException {
259                    return getService().updateAssetVocabulary(assetVocabulary, merge);
260            }
261    
262            /**
263            * Returns the Spring bean ID for this bean.
264            *
265            * @return the Spring bean ID for this bean
266            */
267            public static java.lang.String getBeanIdentifier() {
268                    return getService().getBeanIdentifier();
269            }
270    
271            /**
272            * Sets the Spring bean ID for this bean.
273            *
274            * @param beanIdentifier the Spring bean ID for this bean
275            */
276            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
277                    getService().setBeanIdentifier(beanIdentifier);
278            }
279    
280            /**
281            * @deprecated
282            */
283            public static com.liferay.portlet.asset.model.AssetVocabulary addVocabulary(
284                    long userId,
285                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
286                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
287                    java.lang.String settings,
288                    com.liferay.portal.service.ServiceContext serviceContext)
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException {
291                    return getService()
292                                       .addVocabulary(userId, titleMap, descriptionMap, settings,
293                            serviceContext);
294            }
295    
296            public static com.liferay.portlet.asset.model.AssetVocabulary addVocabulary(
297                    long userId, java.lang.String title,
298                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
299                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
300                    java.lang.String settings,
301                    com.liferay.portal.service.ServiceContext serviceContext)
302                    throws com.liferay.portal.kernel.exception.PortalException,
303                            com.liferay.portal.kernel.exception.SystemException {
304                    return getService()
305                                       .addVocabulary(userId, title, titleMap, descriptionMap,
306                            settings, serviceContext);
307            }
308    
309            public static void addVocabularyResources(
310                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary,
311                    boolean addGroupPermissions, boolean addGuestPermissions)
312                    throws com.liferay.portal.kernel.exception.PortalException,
313                            com.liferay.portal.kernel.exception.SystemException {
314                    getService()
315                            .addVocabularyResources(vocabulary, addGroupPermissions,
316                            addGuestPermissions);
317            }
318    
319            public static void addVocabularyResources(
320                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary,
321                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
322                    throws com.liferay.portal.kernel.exception.PortalException,
323                            com.liferay.portal.kernel.exception.SystemException {
324                    getService()
325                            .addVocabularyResources(vocabulary, groupPermissions,
326                            guestPermissions);
327            }
328    
329            public static void deleteVocabularies(long groupId)
330                    throws com.liferay.portal.kernel.exception.PortalException,
331                            com.liferay.portal.kernel.exception.SystemException {
332                    getService().deleteVocabularies(groupId);
333            }
334    
335            public static void deleteVocabulary(
336                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary)
337                    throws com.liferay.portal.kernel.exception.PortalException,
338                            com.liferay.portal.kernel.exception.SystemException {
339                    getService().deleteVocabulary(vocabulary);
340            }
341    
342            public static void deleteVocabulary(long vocabularyId)
343                    throws com.liferay.portal.kernel.exception.PortalException,
344                            com.liferay.portal.kernel.exception.SystemException {
345                    getService().deleteVocabulary(vocabularyId);
346            }
347    
348            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getCompanyVocabularies(
349                    long companyId)
350                    throws com.liferay.portal.kernel.exception.SystemException {
351                    return getService().getCompanyVocabularies(companyId);
352            }
353    
354            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupsVocabularies(
355                    long[] groupIds)
356                    throws com.liferay.portal.kernel.exception.PortalException,
357                            com.liferay.portal.kernel.exception.SystemException {
358                    return getService().getGroupsVocabularies(groupIds);
359            }
360    
361            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupsVocabularies(
362                    long[] groupIds, java.lang.String className)
363                    throws com.liferay.portal.kernel.exception.PortalException,
364                            com.liferay.portal.kernel.exception.SystemException {
365                    return getService().getGroupsVocabularies(groupIds, className);
366            }
367    
368            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
369                    long groupId)
370                    throws com.liferay.portal.kernel.exception.PortalException,
371                            com.liferay.portal.kernel.exception.SystemException {
372                    return getService().getGroupVocabularies(groupId);
373            }
374    
375            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
376                    long groupId, boolean createDefaultVocabulary)
377                    throws com.liferay.portal.kernel.exception.PortalException,
378                            com.liferay.portal.kernel.exception.SystemException {
379                    return getService()
380                                       .getGroupVocabularies(groupId, createDefaultVocabulary);
381            }
382    
383            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
384                    long groupId, java.lang.String name, int start, int end,
385                    com.liferay.portal.kernel.util.OrderByComparator obc)
386                    throws com.liferay.portal.kernel.exception.SystemException {
387                    return getService().getGroupVocabularies(groupId, name, start, end, obc);
388            }
389    
390            public static com.liferay.portlet.asset.model.AssetVocabulary getGroupVocabulary(
391                    long groupId, java.lang.String name)
392                    throws com.liferay.portal.kernel.exception.PortalException,
393                            com.liferay.portal.kernel.exception.SystemException {
394                    return getService().getGroupVocabulary(groupId, name);
395            }
396    
397            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getVocabularies(
398                    long[] vocabularyIds)
399                    throws com.liferay.portal.kernel.exception.PortalException,
400                            com.liferay.portal.kernel.exception.SystemException {
401                    return getService().getVocabularies(vocabularyIds);
402            }
403    
404            public static com.liferay.portlet.asset.model.AssetVocabulary getVocabulary(
405                    long vocabularyId)
406                    throws com.liferay.portal.kernel.exception.PortalException,
407                            com.liferay.portal.kernel.exception.SystemException {
408                    return getService().getVocabulary(vocabularyId);
409            }
410    
411            /**
412            * @deprecated
413            */
414            public static com.liferay.portlet.asset.model.AssetVocabulary updateVocabulary(
415                    long vocabularyId,
416                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
417                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
418                    java.lang.String settings,
419                    com.liferay.portal.service.ServiceContext serviceContext)
420                    throws com.liferay.portal.kernel.exception.PortalException,
421                            com.liferay.portal.kernel.exception.SystemException {
422                    return getService()
423                                       .updateVocabulary(vocabularyId, titleMap, descriptionMap,
424                            settings, serviceContext);
425            }
426    
427            public static com.liferay.portlet.asset.model.AssetVocabulary updateVocabulary(
428                    long vocabularyId, java.lang.String title,
429                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
430                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
431                    java.lang.String settings,
432                    com.liferay.portal.service.ServiceContext serviceContext)
433                    throws com.liferay.portal.kernel.exception.PortalException,
434                            com.liferay.portal.kernel.exception.SystemException {
435                    return getService()
436                                       .updateVocabulary(vocabularyId, title, titleMap,
437                            descriptionMap, settings, serviceContext);
438            }
439    
440            public static AssetVocabularyLocalService getService() {
441                    if (_service == null) {
442                            _service = (AssetVocabularyLocalService)PortalBeanLocatorUtil.locate(AssetVocabularyLocalService.class.getName());
443    
444                            ReferenceRegistry.registerReference(AssetVocabularyLocalServiceUtil.class,
445                                    "_service");
446                            MethodCache.remove(AssetVocabularyLocalService.class);
447                    }
448    
449                    return _service;
450            }
451    
452            public void setService(AssetVocabularyLocalService service) {
453                    MethodCache.remove(AssetVocabularyLocalService.class);
454    
455                    _service = service;
456    
457                    ReferenceRegistry.registerReference(AssetVocabularyLocalServiceUtil.class,
458                            "_service");
459                    MethodCache.remove(AssetVocabularyLocalService.class);
460            }
461    
462            private static AssetVocabularyLocalService _service;
463    }