001    /**
002     * Copyright (c) 2000-2010 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    
019    /**
020     * 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.
021     *
022     * <p>
023     * 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.
024     * </p>
025     *
026     * <p>
027     * 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.
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see AssetVocabularyLocalService
032     * @see com.liferay.portlet.asset.service.base.AssetVocabularyLocalServiceBaseImpl
033     * @see com.liferay.portlet.asset.service.impl.AssetVocabularyLocalServiceImpl
034     * @generated
035     */
036    public class AssetVocabularyLocalServiceUtil {
037            /**
038            * Adds the asset vocabulary to the database. Also notifies the appropriate model listeners.
039            *
040            * @param assetVocabulary the asset vocabulary to add
041            * @return the asset vocabulary that was added
042            * @throws SystemException if a system exception occurred
043            */
044            public static com.liferay.portlet.asset.model.AssetVocabulary addAssetVocabulary(
045                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary)
046                    throws com.liferay.portal.kernel.exception.SystemException {
047                    return getService().addAssetVocabulary(assetVocabulary);
048            }
049    
050            /**
051            * Creates a new asset vocabulary with the primary key. Does not add the asset vocabulary to the database.
052            *
053            * @param vocabularyId the primary key for the new asset vocabulary
054            * @return the new asset vocabulary
055            */
056            public static com.liferay.portlet.asset.model.AssetVocabulary createAssetVocabulary(
057                    long vocabularyId) {
058                    return getService().createAssetVocabulary(vocabularyId);
059            }
060    
061            /**
062            * Deletes the asset vocabulary with the primary key from the database. Also notifies the appropriate model listeners.
063            *
064            * @param vocabularyId the primary key of the asset vocabulary to delete
065            * @throws PortalException if a asset vocabulary with the primary key could not be found
066            * @throws SystemException if a system exception occurred
067            */
068            public static void deleteAssetVocabulary(long vocabularyId)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException {
071                    getService().deleteAssetVocabulary(vocabularyId);
072            }
073    
074            /**
075            * Deletes the asset vocabulary from the database. Also notifies the appropriate model listeners.
076            *
077            * @param assetVocabulary the asset vocabulary to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public static void deleteAssetVocabulary(
081                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary)
082                    throws com.liferay.portal.kernel.exception.SystemException {
083                    getService().deleteAssetVocabulary(assetVocabulary);
084            }
085    
086            /**
087            * Performs a dynamic query on the database and returns the matching rows.
088            *
089            * @param dynamicQuery the dynamic query to search with
090            * @return the matching rows
091            * @throws SystemException if a system exception occurred
092            */
093            @SuppressWarnings("rawtypes")
094            public static java.util.List dynamicQuery(
095                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
096                    throws com.liferay.portal.kernel.exception.SystemException {
097                    return getService().dynamicQuery(dynamicQuery);
098            }
099    
100            /**
101            * Performs a dynamic query on the database and returns a range of the matching rows.
102            *
103            * <p>
104            * 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.
105            * </p>
106            *
107            * @param dynamicQuery the dynamic query to search with
108            * @param start the lower bound of the range of model instances to return
109            * @param end the upper bound of the range of model instances to return (not inclusive)
110            * @return the range of matching rows
111            * @throws SystemException if a system exception occurred
112            */
113            @SuppressWarnings("rawtypes")
114            public static java.util.List dynamicQuery(
115                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
116                    int end) throws com.liferay.portal.kernel.exception.SystemException {
117                    return getService().dynamicQuery(dynamicQuery, start, end);
118            }
119    
120            /**
121            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
122            *
123            * <p>
124            * 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.
125            * </p>
126            *
127            * @param dynamicQuery the dynamic query to search with
128            * @param start the lower bound of the range of model instances to return
129            * @param end the upper bound of the range of model instances to return (not inclusive)
130            * @param orderByComparator the comparator to order the results by
131            * @return the ordered range of matching rows
132            * @throws SystemException if a system exception occurred
133            */
134            @SuppressWarnings("rawtypes")
135            public static java.util.List dynamicQuery(
136                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
137                    int end,
138                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
139                    throws com.liferay.portal.kernel.exception.SystemException {
140                    return getService()
141                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
142            }
143    
144            /**
145            * Counts the number of rows that match the dynamic query.
146            *
147            * @param dynamicQuery the dynamic query to search with
148            * @return the number of rows that match the dynamic query
149            * @throws SystemException if a system exception occurred
150            */
151            public static long dynamicQueryCount(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService().dynamicQueryCount(dynamicQuery);
155            }
156    
157            /**
158            * Gets the asset vocabulary with the primary key.
159            *
160            * @param vocabularyId the primary key of the asset vocabulary to get
161            * @return the asset vocabulary
162            * @throws PortalException if a asset vocabulary with the primary key could not be found
163            * @throws SystemException if a system exception occurred
164            */
165            public static com.liferay.portlet.asset.model.AssetVocabulary getAssetVocabulary(
166                    long vocabularyId)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException {
169                    return getService().getAssetVocabulary(vocabularyId);
170            }
171    
172            /**
173            * Gets the asset vocabulary with the UUID and group id.
174            *
175            * @param uuid the UUID of asset vocabulary to get
176            * @param groupId the group id of the asset vocabulary to get
177            * @return the asset vocabulary
178            * @throws PortalException if a asset vocabulary with the UUID and group id could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            public static com.liferay.portlet.asset.model.AssetVocabulary getAssetVocabularyByUuidAndGroupId(
182                    java.lang.String uuid, long groupId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getAssetVocabularyByUuidAndGroupId(uuid, groupId);
186            }
187    
188            /**
189            * Gets a range of all the asset vocabularies.
190            *
191            * <p>
192            * 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.
193            * </p>
194            *
195            * @param start the lower bound of the range of asset vocabularies to return
196            * @param end the upper bound of the range of asset vocabularies to return (not inclusive)
197            * @return the range of asset vocabularies
198            * @throws SystemException if a system exception occurred
199            */
200            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getAssetVocabularies(
201                    int start, int end)
202                    throws com.liferay.portal.kernel.exception.SystemException {
203                    return getService().getAssetVocabularies(start, end);
204            }
205    
206            /**
207            * Gets the number of asset vocabularies.
208            *
209            * @return the number of asset vocabularies
210            * @throws SystemException if a system exception occurred
211            */
212            public static int getAssetVocabulariesCount()
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getAssetVocabulariesCount();
215            }
216    
217            /**
218            * Updates the asset vocabulary in the database. Also notifies the appropriate model listeners.
219            *
220            * @param assetVocabulary the asset vocabulary to update
221            * @return the asset vocabulary that was updated
222            * @throws SystemException if a system exception occurred
223            */
224            public static com.liferay.portlet.asset.model.AssetVocabulary updateAssetVocabulary(
225                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary)
226                    throws com.liferay.portal.kernel.exception.SystemException {
227                    return getService().updateAssetVocabulary(assetVocabulary);
228            }
229    
230            /**
231            * Updates the asset vocabulary in the database. Also notifies the appropriate model listeners.
232            *
233            * @param assetVocabulary the asset vocabulary to update
234            * @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.
235            * @return the asset vocabulary that was updated
236            * @throws SystemException if a system exception occurred
237            */
238            public static com.liferay.portlet.asset.model.AssetVocabulary updateAssetVocabulary(
239                    com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary,
240                    boolean merge)
241                    throws com.liferay.portal.kernel.exception.SystemException {
242                    return getService().updateAssetVocabulary(assetVocabulary, merge);
243            }
244    
245            public static com.liferay.portlet.asset.model.AssetVocabulary addVocabulary(
246                    long userId,
247                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
248                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
249                    java.lang.String settings,
250                    com.liferay.portal.service.ServiceContext serviceContext)
251                    throws com.liferay.portal.kernel.exception.PortalException,
252                            com.liferay.portal.kernel.exception.SystemException {
253                    return getService()
254                                       .addVocabulary(userId, titleMap, descriptionMap, settings,
255                            serviceContext);
256            }
257    
258            public static void addVocabularyResources(
259                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary,
260                    boolean addCommunityPermissions, boolean addGuestPermissions)
261                    throws com.liferay.portal.kernel.exception.PortalException,
262                            com.liferay.portal.kernel.exception.SystemException {
263                    getService()
264                            .addVocabularyResources(vocabulary, addCommunityPermissions,
265                            addGuestPermissions);
266            }
267    
268            public static void addVocabularyResources(
269                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary,
270                    java.lang.String[] communityPermissions,
271                    java.lang.String[] guestPermissions)
272                    throws com.liferay.portal.kernel.exception.PortalException,
273                            com.liferay.portal.kernel.exception.SystemException {
274                    getService()
275                            .addVocabularyResources(vocabulary, communityPermissions,
276                            guestPermissions);
277            }
278    
279            public static void deleteVocabulary(
280                    com.liferay.portlet.asset.model.AssetVocabulary vocabulary)
281                    throws com.liferay.portal.kernel.exception.PortalException,
282                            com.liferay.portal.kernel.exception.SystemException {
283                    getService().deleteVocabulary(vocabulary);
284            }
285    
286            public static void deleteVocabulary(long vocabularyId)
287                    throws com.liferay.portal.kernel.exception.PortalException,
288                            com.liferay.portal.kernel.exception.SystemException {
289                    getService().deleteVocabulary(vocabularyId);
290            }
291    
292            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getCompanyVocabularies(
293                    long companyId)
294                    throws com.liferay.portal.kernel.exception.SystemException {
295                    return getService().getCompanyVocabularies(companyId);
296            }
297    
298            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupsVocabularies(
299                    long[] groupIds)
300                    throws com.liferay.portal.kernel.exception.PortalException,
301                            com.liferay.portal.kernel.exception.SystemException {
302                    return getService().getGroupsVocabularies(groupIds);
303            }
304    
305            public static java.util.List<com.liferay.portlet.asset.model.AssetVocabulary> getGroupVocabularies(
306                    long groupId)
307                    throws com.liferay.portal.kernel.exception.PortalException,
308                            com.liferay.portal.kernel.exception.SystemException {
309                    return getService().getGroupVocabularies(groupId);
310            }
311    
312            public static com.liferay.portlet.asset.model.AssetVocabulary getGroupVocabulary(
313                    long groupId, java.lang.String name)
314                    throws com.liferay.portal.kernel.exception.PortalException,
315                            com.liferay.portal.kernel.exception.SystemException {
316                    return getService().getGroupVocabulary(groupId, name);
317            }
318    
319            public static com.liferay.portlet.asset.model.AssetVocabulary getVocabulary(
320                    long vocabularyId)
321                    throws com.liferay.portal.kernel.exception.PortalException,
322                            com.liferay.portal.kernel.exception.SystemException {
323                    return getService().getVocabulary(vocabularyId);
324            }
325    
326            public static com.liferay.portlet.asset.model.AssetVocabulary updateVocabulary(
327                    long vocabularyId,
328                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
329                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
330                    java.lang.String settings,
331                    com.liferay.portal.service.ServiceContext serviceContext)
332                    throws com.liferay.portal.kernel.exception.PortalException,
333                            com.liferay.portal.kernel.exception.SystemException {
334                    return getService()
335                                       .updateVocabulary(vocabularyId, titleMap, descriptionMap,
336                            settings, serviceContext);
337            }
338    
339            public static AssetVocabularyLocalService getService() {
340                    if (_service == null) {
341                            _service = (AssetVocabularyLocalService)PortalBeanLocatorUtil.locate(AssetVocabularyLocalService.class.getName());
342                    }
343    
344                    return _service;
345            }
346    
347            public void setService(AssetVocabularyLocalService service) {
348                    _service = service;
349            }
350    
351            private static AssetVocabularyLocalService _service;
352    }