001    /**
002     * Copyright (c) 2000-2011 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.MethodCache;
019    import com.liferay.portal.kernel.util.ReferenceRegistry;
020    
021    /**
022     * The utility for the asset tag local service. This utility wraps {@link com.liferay.portlet.asset.service.impl.AssetTagLocalServiceImpl} 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 AssetTagLocalService
030     * @see com.liferay.portlet.asset.service.base.AssetTagLocalServiceBaseImpl
031     * @see com.liferay.portlet.asset.service.impl.AssetTagLocalServiceImpl
032     * @generated
033     */
034    public class AssetTagLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.asset.service.impl.AssetTagLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the asset tag to the database. Also notifies the appropriate model listeners.
043            *
044            * @param assetTag the asset tag
045            * @return the asset tag that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.asset.model.AssetTag addAssetTag(
049                    com.liferay.portlet.asset.model.AssetTag assetTag)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addAssetTag(assetTag);
052            }
053    
054            /**
055            * Creates a new asset tag with the primary key. Does not add the asset tag to the database.
056            *
057            * @param tagId the primary key for the new asset tag
058            * @return the new asset tag
059            */
060            public static com.liferay.portlet.asset.model.AssetTag createAssetTag(
061                    long tagId) {
062                    return getService().createAssetTag(tagId);
063            }
064    
065            /**
066            * Deletes the asset tag with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param tagId the primary key of the asset tag
069            * @throws PortalException if a asset tag with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteAssetTag(long tagId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteAssetTag(tagId);
076            }
077    
078            /**
079            * Deletes the asset tag from the database. Also notifies the appropriate model listeners.
080            *
081            * @param assetTag the asset tag
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteAssetTag(
085                    com.liferay.portlet.asset.model.AssetTag assetTag)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteAssetTag(assetTag);
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 tag with the primary key.
163            *
164            * @param tagId the primary key of the asset tag
165            * @return the asset tag
166            * @throws PortalException if a asset tag 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.AssetTag getAssetTag(
170                    long tagId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService().getAssetTag(tagId);
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 a range of all the asset tags.
185            *
186            * <p>
187            * 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.
188            * </p>
189            *
190            * @param start the lower bound of the range of asset tags
191            * @param end the upper bound of the range of asset tags (not inclusive)
192            * @return the range of asset tags
193            * @throws SystemException if a system exception occurred
194            */
195            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getAssetTags(
196                    int start, int end)
197                    throws com.liferay.portal.kernel.exception.SystemException {
198                    return getService().getAssetTags(start, end);
199            }
200    
201            /**
202            * Returns the number of asset tags.
203            *
204            * @return the number of asset tags
205            * @throws SystemException if a system exception occurred
206            */
207            public static int getAssetTagsCount()
208                    throws com.liferay.portal.kernel.exception.SystemException {
209                    return getService().getAssetTagsCount();
210            }
211    
212            /**
213            * Updates the asset tag in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
214            *
215            * @param assetTag the asset tag
216            * @return the asset tag that was updated
217            * @throws SystemException if a system exception occurred
218            */
219            public static com.liferay.portlet.asset.model.AssetTag updateAssetTag(
220                    com.liferay.portlet.asset.model.AssetTag assetTag)
221                    throws com.liferay.portal.kernel.exception.SystemException {
222                    return getService().updateAssetTag(assetTag);
223            }
224    
225            /**
226            * Updates the asset tag in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
227            *
228            * @param assetTag the asset tag
229            * @param merge whether to merge the asset tag 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.
230            * @return the asset tag that was updated
231            * @throws SystemException if a system exception occurred
232            */
233            public static com.liferay.portlet.asset.model.AssetTag updateAssetTag(
234                    com.liferay.portlet.asset.model.AssetTag assetTag, boolean merge)
235                    throws com.liferay.portal.kernel.exception.SystemException {
236                    return getService().updateAssetTag(assetTag, merge);
237            }
238    
239            /**
240            * Returns the Spring bean ID for this bean.
241            *
242            * @return the Spring bean ID for this bean
243            */
244            public static java.lang.String getBeanIdentifier() {
245                    return getService().getBeanIdentifier();
246            }
247    
248            /**
249            * Sets the Spring bean ID for this bean.
250            *
251            * @param beanIdentifier the Spring bean ID for this bean
252            */
253            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
254                    getService().setBeanIdentifier(beanIdentifier);
255            }
256    
257            public static com.liferay.portlet.asset.model.AssetTag addTag(long userId,
258                    java.lang.String name, java.lang.String[] tagProperties,
259                    com.liferay.portal.service.ServiceContext serviceContext)
260                    throws com.liferay.portal.kernel.exception.PortalException,
261                            com.liferay.portal.kernel.exception.SystemException {
262                    return getService().addTag(userId, name, tagProperties, serviceContext);
263            }
264    
265            public static void addTagResources(
266                    com.liferay.portlet.asset.model.AssetTag tag,
267                    boolean addGroupPermissions, boolean addGuestPermissions)
268                    throws com.liferay.portal.kernel.exception.PortalException,
269                            com.liferay.portal.kernel.exception.SystemException {
270                    getService()
271                            .addTagResources(tag, addGroupPermissions, addGuestPermissions);
272            }
273    
274            public static void addTagResources(
275                    com.liferay.portlet.asset.model.AssetTag tag,
276                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException {
279                    getService().addTagResources(tag, groupPermissions, guestPermissions);
280            }
281    
282            public static void checkTags(long userId, long groupId,
283                    java.lang.String[] names)
284                    throws com.liferay.portal.kernel.exception.PortalException,
285                            com.liferay.portal.kernel.exception.SystemException {
286                    getService().checkTags(userId, groupId, names);
287            }
288    
289            public static com.liferay.portlet.asset.model.AssetTag decrementAssetCount(
290                    long tagId, long classNameId)
291                    throws com.liferay.portal.kernel.exception.PortalException,
292                            com.liferay.portal.kernel.exception.SystemException {
293                    return getService().decrementAssetCount(tagId, classNameId);
294            }
295    
296            public static void deleteTag(com.liferay.portlet.asset.model.AssetTag tag)
297                    throws com.liferay.portal.kernel.exception.PortalException,
298                            com.liferay.portal.kernel.exception.SystemException {
299                    getService().deleteTag(tag);
300            }
301    
302            public static void deleteTag(long tagId)
303                    throws com.liferay.portal.kernel.exception.PortalException,
304                            com.liferay.portal.kernel.exception.SystemException {
305                    getService().deleteTag(tagId);
306            }
307    
308            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getEntryTags(
309                    long entryId)
310                    throws com.liferay.portal.kernel.exception.SystemException {
311                    return getService().getEntryTags(entryId);
312            }
313    
314            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getGroupsTags(
315                    long[] groupIds)
316                    throws com.liferay.portal.kernel.exception.SystemException {
317                    return getService().getGroupsTags(groupIds);
318            }
319    
320            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getGroupTags(
321                    long groupId)
322                    throws com.liferay.portal.kernel.exception.SystemException {
323                    return getService().getGroupTags(groupId);
324            }
325    
326            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getGroupTags(
327                    long groupId, int start, int end)
328                    throws com.liferay.portal.kernel.exception.SystemException {
329                    return getService().getGroupTags(groupId, start, end);
330            }
331    
332            public static int getGroupTagsCount(long groupId)
333                    throws com.liferay.portal.kernel.exception.SystemException {
334                    return getService().getGroupTagsCount(groupId);
335            }
336    
337            public static com.liferay.portlet.asset.model.AssetTag getTag(long tagId)
338                    throws com.liferay.portal.kernel.exception.PortalException,
339                            com.liferay.portal.kernel.exception.SystemException {
340                    return getService().getTag(tagId);
341            }
342    
343            public static com.liferay.portlet.asset.model.AssetTag getTag(
344                    long groupId, java.lang.String name)
345                    throws com.liferay.portal.kernel.exception.PortalException,
346                            com.liferay.portal.kernel.exception.SystemException {
347                    return getService().getTag(groupId, name);
348            }
349    
350            public static long[] getTagIds(long groupId, java.lang.String[] names)
351                    throws com.liferay.portal.kernel.exception.PortalException,
352                            com.liferay.portal.kernel.exception.SystemException {
353                    return getService().getTagIds(groupId, names);
354            }
355    
356            public static long[] getTagIds(long[] groupIds, java.lang.String[] names)
357                    throws com.liferay.portal.kernel.exception.PortalException,
358                            com.liferay.portal.kernel.exception.SystemException {
359                    return getService().getTagIds(groupIds, names);
360            }
361    
362            public static java.lang.String[] getTagNames()
363                    throws com.liferay.portal.kernel.exception.SystemException {
364                    return getService().getTagNames();
365            }
366    
367            public static java.lang.String[] getTagNames(long classNameId, long classPK)
368                    throws com.liferay.portal.kernel.exception.SystemException {
369                    return getService().getTagNames(classNameId, classPK);
370            }
371    
372            public static java.lang.String[] getTagNames(java.lang.String className,
373                    long classPK)
374                    throws com.liferay.portal.kernel.exception.SystemException {
375                    return getService().getTagNames(className, classPK);
376            }
377    
378            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getTags()
379                    throws com.liferay.portal.kernel.exception.SystemException {
380                    return getService().getTags();
381            }
382    
383            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getTags(
384                    long classNameId, long classPK)
385                    throws com.liferay.portal.kernel.exception.SystemException {
386                    return getService().getTags(classNameId, classPK);
387            }
388    
389            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getTags(
390                    long groupId, long classNameId, java.lang.String name)
391                    throws com.liferay.portal.kernel.exception.SystemException {
392                    return getService().getTags(groupId, classNameId, name);
393            }
394    
395            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getTags(
396                    long groupId, long classNameId, java.lang.String name, int start,
397                    int end) throws com.liferay.portal.kernel.exception.SystemException {
398                    return getService().getTags(groupId, classNameId, name, start, end);
399            }
400    
401            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getTags(
402                    java.lang.String className, long classPK)
403                    throws com.liferay.portal.kernel.exception.SystemException {
404                    return getService().getTags(className, classPK);
405            }
406    
407            public static int getTagsSize(long groupId, long classNameId,
408                    java.lang.String name)
409                    throws com.liferay.portal.kernel.exception.SystemException {
410                    return getService().getTagsSize(groupId, classNameId, name);
411            }
412    
413            public static boolean hasTag(long groupId, java.lang.String name)
414                    throws com.liferay.portal.kernel.exception.PortalException,
415                            com.liferay.portal.kernel.exception.SystemException {
416                    return getService().hasTag(groupId, name);
417            }
418    
419            public static com.liferay.portlet.asset.model.AssetTag incrementAssetCount(
420                    long tagId, long classNameId)
421                    throws com.liferay.portal.kernel.exception.PortalException,
422                            com.liferay.portal.kernel.exception.SystemException {
423                    return getService().incrementAssetCount(tagId, classNameId);
424            }
425    
426            public static void mergeTags(long fromTagId, long toTagId,
427                    boolean overrideProperties)
428                    throws com.liferay.portal.kernel.exception.PortalException,
429                            com.liferay.portal.kernel.exception.SystemException {
430                    getService().mergeTags(fromTagId, toTagId, overrideProperties);
431            }
432    
433            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> search(
434                    long groupId, java.lang.String name, java.lang.String[] tagProperties,
435                    int start, int end)
436                    throws com.liferay.portal.kernel.exception.SystemException {
437                    return getService().search(groupId, name, tagProperties, start, end);
438            }
439    
440            public static com.liferay.portlet.asset.model.AssetTag updateTag(
441                    long userId, long tagId, java.lang.String name,
442                    java.lang.String[] tagProperties,
443                    com.liferay.portal.service.ServiceContext serviceContext)
444                    throws com.liferay.portal.kernel.exception.PortalException,
445                            com.liferay.portal.kernel.exception.SystemException {
446                    return getService()
447                                       .updateTag(userId, tagId, name, tagProperties, serviceContext);
448            }
449    
450            public static AssetTagLocalService getService() {
451                    if (_service == null) {
452                            _service = (AssetTagLocalService)PortalBeanLocatorUtil.locate(AssetTagLocalService.class.getName());
453    
454                            ReferenceRegistry.registerReference(AssetTagLocalServiceUtil.class,
455                                    "_service");
456                            MethodCache.remove(AssetTagLocalService.class);
457                    }
458    
459                    return _service;
460            }
461    
462            public void setService(AssetTagLocalService service) {
463                    MethodCache.remove(AssetTagLocalService.class);
464    
465                    _service = service;
466    
467                    ReferenceRegistry.registerReference(AssetTagLocalServiceUtil.class,
468                            "_service");
469                    MethodCache.remove(AssetTagLocalService.class);
470            }
471    
472            private static AssetTagLocalService _service;
473    }