001    /**
002     * Copyright (c) 2000-2013 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.
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.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.
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            * Updates the asset vocabulary in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
255            *
256            * @param assetVocabulary the asset vocabulary
257            * @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.
258            * @return the asset vocabulary that was updated
259            * @throws SystemException if a system exception occurred
260            */
261            public static com.liferay.portlet.asset.model.AssetVocabulary updateAssetVocabulary(
262                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary,
263                    boolean merge)
264                    throws com.liferay.portal.kernel.exception.SystemException {
265                    return getService().updateAssetVocabulary(assetVocabulary, 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.AssetVocabulary addDefaultVocabulary(
287                    long groupId)
288                    throws com.liferay.portal.kernel.exception.PortalException,
289                            com.liferay.portal.kernel.exception.SystemException {
290                    return getService().addDefaultVocabulary(groupId);
291            }
292    
293            /**
294            * @deprecated
295            */
296            public static com.liferay.portlet.asset.model.AssetVocabulary addVocabulary(
297                    long userId,
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, titleMap, descriptionMap, settings,
306                            serviceContext);
307            }
308    
309            public static com.liferay.portlet.asset.model.AssetVocabulary addVocabulary(
310                    long userId, java.lang.String title,
311                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
312                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
313                    java.lang.String settings,
314                    com.liferay.portal.service.ServiceContext serviceContext)
315                    throws com.liferay.portal.kernel.exception.PortalException,
316                            com.liferay.portal.kernel.exception.SystemException {
317                    return getService()
318                                       .addVocabulary(userId, title, titleMap, descriptionMap,
319                            settings, serviceContext);
320            }
321    
322            public static com.liferay.portlet.asset.model.AssetVocabulary addVocabulary(
323                    long userId, java.lang.String title,
324                    com.liferay.portal.service.ServiceContext serviceContext)
325                    throws com.liferay.portal.kernel.exception.PortalException,
326                            com.liferay.portal.kernel.exception.SystemException {
327                    return getService().addVocabulary(userId, title, serviceContext);
328            }
329    
330            public static void addVocabularyResources(
331                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary,
332                    boolean addGroupPermissions, boolean addGuestPermissions)
333                    throws com.liferay.portal.kernel.exception.PortalException,
334                            com.liferay.portal.kernel.exception.SystemException {
335                    getService()
336                            .addVocabularyResources(vocabulary, addGroupPermissions,
337                            addGuestPermissions);
338            }
339    
340            public static void addVocabularyResources(
341                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary,
342                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
343                    throws com.liferay.portal.kernel.exception.PortalException,
344                            com.liferay.portal.kernel.exception.SystemException {
345                    getService()
346                            .addVocabularyResources(vocabulary, groupPermissions,
347                            guestPermissions);
348            }
349    
350            public static void deleteVocabularies(long groupId)
351                    throws com.liferay.portal.kernel.exception.PortalException,
352                            com.liferay.portal.kernel.exception.SystemException {
353                    getService().deleteVocabularies(groupId);
354            }
355    
356            public static void deleteVocabulary(
357                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary)
358                    throws com.liferay.portal.kernel.exception.PortalException,
359                            com.liferay.portal.kernel.exception.SystemException {
360                    getService().deleteVocabulary(vocabulary);
361            }
362    
363            public static void deleteVocabulary(long vocabularyId)
364                    throws com.liferay.portal.kernel.exception.PortalException,
365                            com.liferay.portal.kernel.exception.SystemException {
366                    getService().deleteVocabulary(vocabularyId);
367            }
368    
369            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getCompanyVocabularies(
370                    long companyId)
371                    throws com.liferay.portal.kernel.exception.SystemException {
372                    return getService().getCompanyVocabularies(companyId);
373            }
374    
375            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupsVocabularies(
376                    long[] groupIds)
377                    throws com.liferay.portal.kernel.exception.PortalException,
378                            com.liferay.portal.kernel.exception.SystemException {
379                    return getService().getGroupsVocabularies(groupIds);
380            }
381    
382            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupsVocabularies(
383                    long[] groupIds, java.lang.String className)
384                    throws com.liferay.portal.kernel.exception.PortalException,
385                            com.liferay.portal.kernel.exception.SystemException {
386                    return getService().getGroupsVocabularies(groupIds, className);
387            }
388    
389            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
390                    long groupId)
391                    throws com.liferay.portal.kernel.exception.PortalException,
392                            com.liferay.portal.kernel.exception.SystemException {
393                    return getService().getGroupVocabularies(groupId);
394            }
395    
396            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
397                    long groupId, boolean addDefaultVocabulary)
398                    throws com.liferay.portal.kernel.exception.PortalException,
399                            com.liferay.portal.kernel.exception.SystemException {
400                    return getService().getGroupVocabularies(groupId, addDefaultVocabulary);
401            }
402    
403            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
404                    long groupId, java.lang.String name, int start, int end,
405                    com.liferay.portal.kernel.util.OrderByComparator obc)
406                    throws com.liferay.portal.kernel.exception.SystemException {
407                    return getService().getGroupVocabularies(groupId, name, start, end, obc);
408            }
409    
410            public static com.liferay.portlet.asset.model.AssetVocabulary getGroupVocabulary(
411                    long groupId, java.lang.String name)
412                    throws com.liferay.portal.kernel.exception.PortalException,
413                            com.liferay.portal.kernel.exception.SystemException {
414                    return getService().getGroupVocabulary(groupId, name);
415            }
416    
417            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getVocabularies(
418                    long[] vocabularyIds)
419                    throws com.liferay.portal.kernel.exception.PortalException,
420                            com.liferay.portal.kernel.exception.SystemException {
421                    return getService().getVocabularies(vocabularyIds);
422            }
423    
424            public static com.liferay.portlet.asset.model.AssetVocabulary getVocabulary(
425                    long vocabularyId)
426                    throws com.liferay.portal.kernel.exception.PortalException,
427                            com.liferay.portal.kernel.exception.SystemException {
428                    return getService().getVocabulary(vocabularyId);
429            }
430    
431            /**
432            * @deprecated
433            */
434            public static com.liferay.portlet.asset.model.AssetVocabulary updateVocabulary(
435                    long vocabularyId,
436                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
437                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
438                    java.lang.String settings,
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                                       .updateVocabulary(vocabularyId, titleMap, descriptionMap,
444                            settings, serviceContext);
445            }
446    
447            public static com.liferay.portlet.asset.model.AssetVocabulary updateVocabulary(
448                    long vocabularyId, java.lang.String title,
449                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
450                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
451                    java.lang.String settings,
452                    com.liferay.portal.service.ServiceContext serviceContext)
453                    throws com.liferay.portal.kernel.exception.PortalException,
454                            com.liferay.portal.kernel.exception.SystemException {
455                    return getService()
456                                       .updateVocabulary(vocabularyId, title, titleMap,
457                            descriptionMap, settings, serviceContext);
458            }
459    
460            public static AssetVocabularyLocalService getService() {
461                    if (_service == null) {
462                            _service = (AssetVocabularyLocalService)PortalBeanLocatorUtil.locate(AssetVocabularyLocalService.class.getName());
463    
464                            ReferenceRegistry.registerReference(AssetVocabularyLocalServiceUtil.class,
465                                    "_service");
466                    }
467    
468                    return _service;
469            }
470    
471            /**
472             * @deprecated
473             */
474            public void setService(AssetVocabularyLocalService service) {
475            }
476    
477            private static AssetVocabularyLocalService _service;
478    }