001    /**
002     * Copyright (c) 2000-2011 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.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            /**
162            * Returns the asset vocabulary with the primary key.
163            *
164            * @param vocabularyId the primary key of the asset vocabulary
165            * @return the asset vocabulary
166            * @throws PortalException if a asset vocabulary with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            public static com.liferay.portlet.asset.model.AssetVocabulary getAssetVocabulary(
170                    long vocabularyId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService().getAssetVocabulary(vocabularyId);
174            }
175    
176            public static com.liferay.portal.model.PersistedModel getPersistedModel(
177                    java.io.Serializable primaryKeyObj)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException {
180                    return getService().getPersistedModel(primaryKeyObj);
181            }
182    
183            /**
184            * Returns the asset vocabulary with the UUID in the group.
185            *
186            * @param uuid the UUID of asset vocabulary
187            * @param groupId the group id of the asset vocabulary
188            * @return the asset vocabulary
189            * @throws PortalException if a asset vocabulary with the UUID in the group could not be found
190            * @throws SystemException if a system exception occurred
191            */
192            public static com.liferay.portlet.asset.model.AssetVocabulary getAssetVocabularyByUuidAndGroupId(
193                    java.lang.String uuid, long groupId)
194                    throws com.liferay.portal.kernel.exception.PortalException,
195                            com.liferay.portal.kernel.exception.SystemException {
196                    return getService().getAssetVocabularyByUuidAndGroupId(uuid, groupId);
197            }
198    
199            /**
200            * Returns a range of all the asset vocabularies.
201            *
202            * <p>
203            * 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.
204            * </p>
205            *
206            * @param start the lower bound of the range of asset vocabularies
207            * @param end the upper bound of the range of asset vocabularies (not inclusive)
208            * @return the range of asset vocabularies
209            * @throws SystemException if a system exception occurred
210            */
211            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getAssetVocabularies(
212                    int start, int end)
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getAssetVocabularies(start, end);
215            }
216    
217            /**
218            * Returns the number of asset vocabularies.
219            *
220            * @return the number of asset vocabularies
221            * @throws SystemException if a system exception occurred
222            */
223            public static int getAssetVocabulariesCount()
224                    throws com.liferay.portal.kernel.exception.SystemException {
225                    return getService().getAssetVocabulariesCount();
226            }
227    
228            /**
229            * Updates the asset vocabulary in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
230            *
231            * @param assetVocabulary the asset vocabulary
232            * @return the asset vocabulary that was updated
233            * @throws SystemException if a system exception occurred
234            */
235            public static com.liferay.portlet.asset.model.AssetVocabulary updateAssetVocabulary(
236                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary)
237                    throws com.liferay.portal.kernel.exception.SystemException {
238                    return getService().updateAssetVocabulary(assetVocabulary);
239            }
240    
241            /**
242            * Updates the asset vocabulary in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
243            *
244            * @param assetVocabulary the asset vocabulary
245            * @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.
246            * @return the asset vocabulary that was updated
247            * @throws SystemException if a system exception occurred
248            */
249            public static com.liferay.portlet.asset.model.AssetVocabulary updateAssetVocabulary(
250                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary,
251                    boolean merge)
252                    throws com.liferay.portal.kernel.exception.SystemException {
253                    return getService().updateAssetVocabulary(assetVocabulary, merge);
254            }
255    
256            /**
257            * Returns the Spring bean ID for this bean.
258            *
259            * @return the Spring bean ID for this bean
260            */
261            public static java.lang.String getBeanIdentifier() {
262                    return getService().getBeanIdentifier();
263            }
264    
265            /**
266            * Sets the Spring bean ID for this bean.
267            *
268            * @param beanIdentifier the Spring bean ID for this bean
269            */
270            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
271                    getService().setBeanIdentifier(beanIdentifier);
272            }
273    
274            /**
275            * @deprecated
276            */
277            public static com.liferay.portlet.asset.model.AssetVocabulary addVocabulary(
278                    long userId,
279                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
280                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
281                    java.lang.String settings,
282                    com.liferay.portal.service.ServiceContext serviceContext)
283                    throws com.liferay.portal.kernel.exception.PortalException,
284                            com.liferay.portal.kernel.exception.SystemException {
285                    return getService()
286                                       .addVocabulary(userId, titleMap, descriptionMap, settings,
287                            serviceContext);
288            }
289    
290            public static com.liferay.portlet.asset.model.AssetVocabulary addVocabulary(
291                    long userId, java.lang.String title,
292                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
293                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
294                    java.lang.String settings,
295                    com.liferay.portal.service.ServiceContext serviceContext)
296                    throws com.liferay.portal.kernel.exception.PortalException,
297                            com.liferay.portal.kernel.exception.SystemException {
298                    return getService()
299                                       .addVocabulary(userId, title, titleMap, descriptionMap,
300                            settings, serviceContext);
301            }
302    
303            public static void addVocabularyResources(
304                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary,
305                    boolean addCommunityPermissions, boolean addGuestPermissions)
306                    throws com.liferay.portal.kernel.exception.PortalException,
307                            com.liferay.portal.kernel.exception.SystemException {
308                    getService()
309                            .addVocabularyResources(vocabulary, addCommunityPermissions,
310                            addGuestPermissions);
311            }
312    
313            public static void addVocabularyResources(
314                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary,
315                    java.lang.String[] communityPermissions,
316                    java.lang.String[] guestPermissions)
317                    throws com.liferay.portal.kernel.exception.PortalException,
318                            com.liferay.portal.kernel.exception.SystemException {
319                    getService()
320                            .addVocabularyResources(vocabulary, communityPermissions,
321                            guestPermissions);
322            }
323    
324            public static void deleteVocabulary(
325                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary)
326                    throws com.liferay.portal.kernel.exception.PortalException,
327                            com.liferay.portal.kernel.exception.SystemException {
328                    getService().deleteVocabulary(vocabulary);
329            }
330    
331            public static void deleteVocabulary(long vocabularyId)
332                    throws com.liferay.portal.kernel.exception.PortalException,
333                            com.liferay.portal.kernel.exception.SystemException {
334                    getService().deleteVocabulary(vocabularyId);
335            }
336    
337            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getCompanyVocabularies(
338                    long companyId)
339                    throws com.liferay.portal.kernel.exception.SystemException {
340                    return getService().getCompanyVocabularies(companyId);
341            }
342    
343            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupsVocabularies(
344                    long[] groupIds)
345                    throws com.liferay.portal.kernel.exception.PortalException,
346                            com.liferay.portal.kernel.exception.SystemException {
347                    return getService().getGroupsVocabularies(groupIds);
348            }
349    
350            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
351                    long groupId)
352                    throws com.liferay.portal.kernel.exception.PortalException,
353                            com.liferay.portal.kernel.exception.SystemException {
354                    return getService().getGroupVocabularies(groupId);
355            }
356    
357            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
358                    long groupId, boolean createDefaultVocabulary)
359                    throws com.liferay.portal.kernel.exception.PortalException,
360                            com.liferay.portal.kernel.exception.SystemException {
361                    return getService()
362                                       .getGroupVocabularies(groupId, createDefaultVocabulary);
363            }
364    
365            public static com.liferay.portlet.asset.model.AssetVocabulary getGroupVocabulary(
366                    long groupId, java.lang.String name)
367                    throws com.liferay.portal.kernel.exception.PortalException,
368                            com.liferay.portal.kernel.exception.SystemException {
369                    return getService().getGroupVocabulary(groupId, name);
370            }
371    
372            public static com.liferay.portlet.asset.model.AssetVocabulary getVocabulary(
373                    long vocabularyId)
374                    throws com.liferay.portal.kernel.exception.PortalException,
375                            com.liferay.portal.kernel.exception.SystemException {
376                    return getService().getVocabulary(vocabularyId);
377            }
378    
379            /**
380            * @deprecated
381            */
382            public static com.liferay.portlet.asset.model.AssetVocabulary updateVocabulary(
383                    long vocabularyId,
384                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
385                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
386                    java.lang.String settings,
387                    com.liferay.portal.service.ServiceContext serviceContext)
388                    throws com.liferay.portal.kernel.exception.PortalException,
389                            com.liferay.portal.kernel.exception.SystemException {
390                    return getService()
391                                       .updateVocabulary(vocabularyId, titleMap, descriptionMap,
392                            settings, serviceContext);
393            }
394    
395            public static com.liferay.portlet.asset.model.AssetVocabulary updateVocabulary(
396                    long vocabularyId, java.lang.String title,
397                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
398                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
399                    java.lang.String settings,
400                    com.liferay.portal.service.ServiceContext serviceContext)
401                    throws com.liferay.portal.kernel.exception.PortalException,
402                            com.liferay.portal.kernel.exception.SystemException {
403                    return getService()
404                                       .updateVocabulary(vocabularyId, title, titleMap,
405                            descriptionMap, settings, serviceContext);
406            }
407    
408            public static AssetVocabularyLocalService getService() {
409                    if (_service == null) {
410                            _service = (AssetVocabularyLocalService)PortalBeanLocatorUtil.locate(AssetVocabularyLocalService.class.getName());
411    
412                            ReferenceRegistry.registerReference(AssetVocabularyLocalServiceUtil.class,
413                                    "_service");
414                            MethodCache.remove(AssetVocabularyLocalService.class);
415                    }
416    
417                    return _service;
418            }
419    
420            public void setService(AssetVocabularyLocalService service) {
421                    MethodCache.remove(AssetVocabularyLocalService.class);
422    
423                    _service = service;
424    
425                    ReferenceRegistry.registerReference(AssetVocabularyLocalServiceUtil.class,
426                            "_service");
427                    MethodCache.remove(AssetVocabularyLocalService.class);
428            }
429    
430            private static AssetVocabularyLocalService _service;
431    }