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 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            /**
287            * @deprecated
288            */
289            public static com.liferay.portlet.asset.model.AssetVocabulary addVocabulary(
290                    long userId,
291                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
292                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
293                    java.lang.String settings,
294                    com.liferay.portal.service.ServiceContext serviceContext)
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException {
297                    return getService()
298                                       .addVocabulary(userId, titleMap, descriptionMap, settings,
299                            serviceContext);
300            }
301    
302            public static com.liferay.portlet.asset.model.AssetVocabulary addVocabulary(
303                    long userId, java.lang.String title,
304                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
305                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
306                    java.lang.String settings,
307                    com.liferay.portal.service.ServiceContext serviceContext)
308                    throws com.liferay.portal.kernel.exception.PortalException,
309                            com.liferay.portal.kernel.exception.SystemException {
310                    return getService()
311                                       .addVocabulary(userId, title, titleMap, descriptionMap,
312                            settings, serviceContext);
313            }
314    
315            public static void addVocabularyResources(
316                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary,
317                    boolean addGroupPermissions, boolean addGuestPermissions)
318                    throws com.liferay.portal.kernel.exception.PortalException,
319                            com.liferay.portal.kernel.exception.SystemException {
320                    getService()
321                            .addVocabularyResources(vocabulary, addGroupPermissions,
322                            addGuestPermissions);
323            }
324    
325            public static void addVocabularyResources(
326                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary,
327                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
328                    throws com.liferay.portal.kernel.exception.PortalException,
329                            com.liferay.portal.kernel.exception.SystemException {
330                    getService()
331                            .addVocabularyResources(vocabulary, groupPermissions,
332                            guestPermissions);
333            }
334    
335            public static void deleteVocabularies(long groupId)
336                    throws com.liferay.portal.kernel.exception.PortalException,
337                            com.liferay.portal.kernel.exception.SystemException {
338                    getService().deleteVocabularies(groupId);
339            }
340    
341            public static void deleteVocabulary(
342                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary)
343                    throws com.liferay.portal.kernel.exception.PortalException,
344                            com.liferay.portal.kernel.exception.SystemException {
345                    getService().deleteVocabulary(vocabulary);
346            }
347    
348            public static void deleteVocabulary(long vocabularyId)
349                    throws com.liferay.portal.kernel.exception.PortalException,
350                            com.liferay.portal.kernel.exception.SystemException {
351                    getService().deleteVocabulary(vocabularyId);
352            }
353    
354            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getCompanyVocabularies(
355                    long companyId)
356                    throws com.liferay.portal.kernel.exception.SystemException {
357                    return getService().getCompanyVocabularies(companyId);
358            }
359    
360            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupsVocabularies(
361                    long[] groupIds)
362                    throws com.liferay.portal.kernel.exception.PortalException,
363                            com.liferay.portal.kernel.exception.SystemException {
364                    return getService().getGroupsVocabularies(groupIds);
365            }
366    
367            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupsVocabularies(
368                    long[] groupIds, java.lang.String className)
369                    throws com.liferay.portal.kernel.exception.PortalException,
370                            com.liferay.portal.kernel.exception.SystemException {
371                    return getService().getGroupsVocabularies(groupIds, className);
372            }
373    
374            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
375                    long groupId)
376                    throws com.liferay.portal.kernel.exception.PortalException,
377                            com.liferay.portal.kernel.exception.SystemException {
378                    return getService().getGroupVocabularies(groupId);
379            }
380    
381            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
382                    long groupId, boolean createDefaultVocabulary)
383                    throws com.liferay.portal.kernel.exception.PortalException,
384                            com.liferay.portal.kernel.exception.SystemException {
385                    return getService()
386                                       .getGroupVocabularies(groupId, createDefaultVocabulary);
387            }
388    
389            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
390                    long groupId, java.lang.String name, int start, int end,
391                    com.liferay.portal.kernel.util.OrderByComparator obc)
392                    throws com.liferay.portal.kernel.exception.SystemException {
393                    return getService().getGroupVocabularies(groupId, name, start, end, obc);
394            }
395    
396            public static com.liferay.portlet.asset.model.AssetVocabulary getGroupVocabulary(
397                    long groupId, java.lang.String name)
398                    throws com.liferay.portal.kernel.exception.PortalException,
399                            com.liferay.portal.kernel.exception.SystemException {
400                    return getService().getGroupVocabulary(groupId, name);
401            }
402    
403            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getVocabularies(
404                    long[] vocabularyIds)
405                    throws com.liferay.portal.kernel.exception.PortalException,
406                            com.liferay.portal.kernel.exception.SystemException {
407                    return getService().getVocabularies(vocabularyIds);
408            }
409    
410            public static com.liferay.portlet.asset.model.AssetVocabulary getVocabulary(
411                    long vocabularyId)
412                    throws com.liferay.portal.kernel.exception.PortalException,
413                            com.liferay.portal.kernel.exception.SystemException {
414                    return getService().getVocabulary(vocabularyId);
415            }
416    
417            /**
418            * @deprecated
419            */
420            public static com.liferay.portlet.asset.model.AssetVocabulary updateVocabulary(
421                    long vocabularyId,
422                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
423                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
424                    java.lang.String settings,
425                    com.liferay.portal.service.ServiceContext serviceContext)
426                    throws com.liferay.portal.kernel.exception.PortalException,
427                            com.liferay.portal.kernel.exception.SystemException {
428                    return getService()
429                                       .updateVocabulary(vocabularyId, titleMap, descriptionMap,
430                            settings, serviceContext);
431            }
432    
433            public static com.liferay.portlet.asset.model.AssetVocabulary updateVocabulary(
434                    long vocabularyId, java.lang.String title,
435                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
436                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
437                    java.lang.String settings,
438                    com.liferay.portal.service.ServiceContext serviceContext)
439                    throws com.liferay.portal.kernel.exception.PortalException,
440                            com.liferay.portal.kernel.exception.SystemException {
441                    return getService()
442                                       .updateVocabulary(vocabularyId, title, titleMap,
443                            descriptionMap, settings, serviceContext);
444            }
445    
446            public static AssetVocabularyLocalService getService() {
447                    if (_service == null) {
448                            _service = (AssetVocabularyLocalService)PortalBeanLocatorUtil.locate(AssetVocabularyLocalService.class.getName());
449    
450                            ReferenceRegistry.registerReference(AssetVocabularyLocalServiceUtil.class,
451                                    "_service");
452                    }
453    
454                    return _service;
455            }
456    
457            /**
458             * @deprecated
459             */
460            public void setService(AssetVocabularyLocalService service) {
461            }
462    
463            private static AssetVocabularyLocalService _service;
464    }