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 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.
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 AssetVocabularyLocalService
029     * @see com.liferay.portlet.asset.service.base.AssetVocabularyLocalServiceBaseImpl
030     * @see com.liferay.portlet.asset.service.impl.AssetVocabularyLocalServiceImpl
031     * @generated
032     */
033    public class AssetVocabularyLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * 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.
038             */
039    
040            /**
041            * Adds the asset vocabulary to the database. Also notifies the appropriate model listeners.
042            *
043            * @param assetVocabulary the asset vocabulary
044            * @return the asset vocabulary that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portlet.asset.model.AssetVocabulary addAssetVocabulary(
048                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addAssetVocabulary(assetVocabulary);
051            }
052    
053            /**
054            * Creates a new asset vocabulary with the primary key. Does not add the asset vocabulary to the database.
055            *
056            * @param vocabularyId the primary key for the new asset vocabulary
057            * @return the new asset vocabulary
058            */
059            public static com.liferay.portlet.asset.model.AssetVocabulary createAssetVocabulary(
060                    long vocabularyId) {
061                    return getService().createAssetVocabulary(vocabularyId);
062            }
063    
064            /**
065            * Deletes the asset vocabulary with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param vocabularyId the primary key of the asset vocabulary
068            * @return the asset vocabulary that was removed
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 com.liferay.portlet.asset.model.AssetVocabulary deleteAssetVocabulary(
073                    long vocabularyId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteAssetVocabulary(vocabularyId);
077            }
078    
079            /**
080            * Deletes the asset vocabulary from the database. Also notifies the appropriate model listeners.
081            *
082            * @param assetVocabulary the asset vocabulary
083            * @return the asset vocabulary that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portlet.asset.model.AssetVocabulary deleteAssetVocabulary(
087                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deleteAssetVocabulary(assetVocabulary);
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.AssetVocabularyModelImpl}. 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.AssetVocabularyModelImpl}. 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.AssetVocabulary fetchAssetVocabulary(
168                    long vocabularyId)
169                    throws com.liferay.portal.kernel.exception.SystemException {
170                    return getService().fetchAssetVocabulary(vocabularyId);
171            }
172    
173            /**
174            * Returns the asset vocabulary with the primary key.
175            *
176            * @param vocabularyId the primary key of the asset vocabulary
177            * @return the asset vocabulary
178            * @throws PortalException if a asset vocabulary 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.AssetVocabulary getAssetVocabulary(
182                    long vocabularyId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getAssetVocabulary(vocabularyId);
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 vocabulary with the UUID in the group.
197            *
198            * @param uuid the UUID of asset vocabulary
199            * @param groupId the group id of the asset vocabulary
200            * @return the asset vocabulary
201            * @throws PortalException if a asset vocabulary 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.AssetVocabulary getAssetVocabularyByUuidAndGroupId(
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().getAssetVocabularyByUuidAndGroupId(uuid, groupId);
209            }
210    
211            /**
212            * Returns a range of all the asset vocabularies.
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.AssetVocabularyModelImpl}. 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 vocabularies
219            * @param end the upper bound of the range of asset vocabularies (not inclusive)
220            * @return the range of asset vocabularies
221            * @throws SystemException if a system exception occurred
222            */
223            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getAssetVocabularies(
224                    int start, int end)
225                    throws com.liferay.portal.kernel.exception.SystemException {
226                    return getService().getAssetVocabularies(start, end);
227            }
228    
229            /**
230            * Returns the number of asset vocabularies.
231            *
232            * @return the number of asset vocabularies
233            * @throws SystemException if a system exception occurred
234            */
235            public static int getAssetVocabulariesCount()
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService().getAssetVocabulariesCount();
238            }
239    
240            /**
241            * Updates the asset vocabulary in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
242            *
243            * @param assetVocabulary the asset vocabulary
244            * @return the asset vocabulary that was updated
245            * @throws SystemException if a system exception occurred
246            */
247            public static com.liferay.portlet.asset.model.AssetVocabulary updateAssetVocabulary(
248                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary)
249                    throws com.liferay.portal.kernel.exception.SystemException {
250                    return getService().updateAssetVocabulary(assetVocabulary);
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            /**
272            * @deprecated
273            */
274            public static com.liferay.portlet.asset.model.AssetVocabulary addVocabulary(
275                    long userId,
276                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
277                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
278                    java.lang.String settings,
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                                       .addVocabulary(userId, titleMap, descriptionMap, settings,
284                            serviceContext);
285            }
286    
287            public static com.liferay.portlet.asset.model.AssetVocabulary addVocabulary(
288                    long userId, java.lang.String title,
289                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
290                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
291                    java.lang.String settings,
292                    com.liferay.portal.service.ServiceContext serviceContext)
293                    throws com.liferay.portal.kernel.exception.PortalException,
294                            com.liferay.portal.kernel.exception.SystemException {
295                    return getService()
296                                       .addVocabulary(userId, title, titleMap, descriptionMap,
297                            settings, serviceContext);
298            }
299    
300            public static void addVocabularyResources(
301                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary,
302                    boolean addGroupPermissions, boolean addGuestPermissions)
303                    throws com.liferay.portal.kernel.exception.PortalException,
304                            com.liferay.portal.kernel.exception.SystemException {
305                    getService()
306                            .addVocabularyResources(vocabulary, addGroupPermissions,
307                            addGuestPermissions);
308            }
309    
310            public static void addVocabularyResources(
311                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary,
312                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
313                    throws com.liferay.portal.kernel.exception.PortalException,
314                            com.liferay.portal.kernel.exception.SystemException {
315                    getService()
316                            .addVocabularyResources(vocabulary, groupPermissions,
317                            guestPermissions);
318            }
319    
320            public static void deleteVocabularies(long groupId)
321                    throws com.liferay.portal.kernel.exception.PortalException,
322                            com.liferay.portal.kernel.exception.SystemException {
323                    getService().deleteVocabularies(groupId);
324            }
325    
326            public static void deleteVocabulary(
327                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary)
328                    throws com.liferay.portal.kernel.exception.PortalException,
329                            com.liferay.portal.kernel.exception.SystemException {
330                    getService().deleteVocabulary(vocabulary);
331            }
332    
333            public static void deleteVocabulary(long vocabularyId)
334                    throws com.liferay.portal.kernel.exception.PortalException,
335                            com.liferay.portal.kernel.exception.SystemException {
336                    getService().deleteVocabulary(vocabularyId);
337            }
338    
339            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getCompanyVocabularies(
340                    long companyId)
341                    throws com.liferay.portal.kernel.exception.SystemException {
342                    return getService().getCompanyVocabularies(companyId);
343            }
344    
345            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupsVocabularies(
346                    long[] groupIds)
347                    throws com.liferay.portal.kernel.exception.PortalException,
348                            com.liferay.portal.kernel.exception.SystemException {
349                    return getService().getGroupsVocabularies(groupIds);
350            }
351    
352            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupsVocabularies(
353                    long[] groupIds, java.lang.String className)
354                    throws com.liferay.portal.kernel.exception.PortalException,
355                            com.liferay.portal.kernel.exception.SystemException {
356                    return getService().getGroupsVocabularies(groupIds, className);
357            }
358    
359            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
360                    long groupId)
361                    throws com.liferay.portal.kernel.exception.PortalException,
362                            com.liferay.portal.kernel.exception.SystemException {
363                    return getService().getGroupVocabularies(groupId);
364            }
365    
366            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
367                    long groupId, boolean createDefaultVocabulary)
368                    throws com.liferay.portal.kernel.exception.PortalException,
369                            com.liferay.portal.kernel.exception.SystemException {
370                    return getService()
371                                       .getGroupVocabularies(groupId, createDefaultVocabulary);
372            }
373    
374            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
375                    long groupId, java.lang.String name, int start, int end,
376                    com.liferay.portal.kernel.util.OrderByComparator obc)
377                    throws com.liferay.portal.kernel.exception.SystemException {
378                    return getService().getGroupVocabularies(groupId, name, start, end, obc);
379            }
380    
381            public static com.liferay.portlet.asset.model.AssetVocabulary getGroupVocabulary(
382                    long groupId, java.lang.String name)
383                    throws com.liferay.portal.kernel.exception.PortalException,
384                            com.liferay.portal.kernel.exception.SystemException {
385                    return getService().getGroupVocabulary(groupId, name);
386            }
387    
388            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getVocabularies(
389                    long[] vocabularyIds)
390                    throws com.liferay.portal.kernel.exception.PortalException,
391                            com.liferay.portal.kernel.exception.SystemException {
392                    return getService().getVocabularies(vocabularyIds);
393            }
394    
395            public static com.liferay.portlet.asset.model.AssetVocabulary getVocabulary(
396                    long vocabularyId)
397                    throws com.liferay.portal.kernel.exception.PortalException,
398                            com.liferay.portal.kernel.exception.SystemException {
399                    return getService().getVocabulary(vocabularyId);
400            }
401    
402            /**
403            * @deprecated
404            */
405            public static com.liferay.portlet.asset.model.AssetVocabulary updateVocabulary(
406                    long vocabularyId,
407                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
408                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
409                    java.lang.String settings,
410                    com.liferay.portal.service.ServiceContext serviceContext)
411                    throws com.liferay.portal.kernel.exception.PortalException,
412                            com.liferay.portal.kernel.exception.SystemException {
413                    return getService()
414                                       .updateVocabulary(vocabularyId, titleMap, descriptionMap,
415                            settings, serviceContext);
416            }
417    
418            public static com.liferay.portlet.asset.model.AssetVocabulary updateVocabulary(
419                    long vocabularyId, java.lang.String title,
420                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
421                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
422                    java.lang.String settings,
423                    com.liferay.portal.service.ServiceContext serviceContext)
424                    throws com.liferay.portal.kernel.exception.PortalException,
425                            com.liferay.portal.kernel.exception.SystemException {
426                    return getService()
427                                       .updateVocabulary(vocabularyId, title, titleMap,
428                            descriptionMap, settings, serviceContext);
429            }
430    
431            public static AssetVocabularyLocalService getService() {
432                    if (_service == null) {
433                            _service = (AssetVocabularyLocalService)PortalBeanLocatorUtil.locate(AssetVocabularyLocalService.class.getName());
434    
435                            ReferenceRegistry.registerReference(AssetVocabularyLocalServiceUtil.class,
436                                    "_service");
437                    }
438    
439                    return _service;
440            }
441    
442            /**
443             * @deprecated
444             */
445            public void setService(AssetVocabularyLocalService service) {
446            }
447    
448            private static AssetVocabularyLocalService _service;
449    }