001    /**
002     * Copyright (c) 2000-2012 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            public static com.liferay.portlet.asset.model.AssetTag fetchAssetTag(
162                    long tagId) throws com.liferay.portal.kernel.exception.SystemException {
163                    return getService().fetchAssetTag(tagId);
164            }
165    
166            /**
167            * Returns the asset tag with the primary key.
168            *
169            * @param tagId the primary key of the asset tag
170            * @return the asset tag
171            * @throws PortalException if a asset tag with the primary key could not be found
172            * @throws SystemException if a system exception occurred
173            */
174            public static com.liferay.portlet.asset.model.AssetTag getAssetTag(
175                    long tagId)
176                    throws com.liferay.portal.kernel.exception.PortalException,
177                            com.liferay.portal.kernel.exception.SystemException {
178                    return getService().getAssetTag(tagId);
179            }
180    
181            public static com.liferay.portal.model.PersistedModel getPersistedModel(
182                    java.io.Serializable primaryKeyObj)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getPersistedModel(primaryKeyObj);
186            }
187    
188            /**
189            * Returns a range of all the asset tags.
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 tags
196            * @param end the upper bound of the range of asset tags (not inclusive)
197            * @return the range of asset tags
198            * @throws SystemException if a system exception occurred
199            */
200            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getAssetTags(
201                    int start, int end)
202                    throws com.liferay.portal.kernel.exception.SystemException {
203                    return getService().getAssetTags(start, end);
204            }
205    
206            /**
207            * Returns the number of asset tags.
208            *
209            * @return the number of asset tags
210            * @throws SystemException if a system exception occurred
211            */
212            public static int getAssetTagsCount()
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getAssetTagsCount();
215            }
216    
217            /**
218            * Updates the asset tag in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
219            *
220            * @param assetTag the asset tag
221            * @return the asset tag that was updated
222            * @throws SystemException if a system exception occurred
223            */
224            public static com.liferay.portlet.asset.model.AssetTag updateAssetTag(
225                    com.liferay.portlet.asset.model.AssetTag assetTag)
226                    throws com.liferay.portal.kernel.exception.SystemException {
227                    return getService().updateAssetTag(assetTag);
228            }
229    
230            /**
231            * Updates the asset tag in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
232            *
233            * @param assetTag the asset tag
234            * @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.
235            * @return the asset tag that was updated
236            * @throws SystemException if a system exception occurred
237            */
238            public static com.liferay.portlet.asset.model.AssetTag updateAssetTag(
239                    com.liferay.portlet.asset.model.AssetTag assetTag, boolean merge)
240                    throws com.liferay.portal.kernel.exception.SystemException {
241                    return getService().updateAssetTag(assetTag, merge);
242            }
243    
244            /**
245            * Returns the Spring bean ID for this bean.
246            *
247            * @return the Spring bean ID for this bean
248            */
249            public static java.lang.String getBeanIdentifier() {
250                    return getService().getBeanIdentifier();
251            }
252    
253            /**
254            * Sets the Spring bean ID for this bean.
255            *
256            * @param beanIdentifier the Spring bean ID for this bean
257            */
258            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
259                    getService().setBeanIdentifier(beanIdentifier);
260            }
261    
262            public static com.liferay.portlet.asset.model.AssetTag addTag(long userId,
263                    java.lang.String name, java.lang.String[] tagProperties,
264                    com.liferay.portal.service.ServiceContext serviceContext)
265                    throws com.liferay.portal.kernel.exception.PortalException,
266                            com.liferay.portal.kernel.exception.SystemException {
267                    return getService().addTag(userId, name, tagProperties, serviceContext);
268            }
269    
270            public static void addTagResources(
271                    com.liferay.portlet.asset.model.AssetTag tag,
272                    boolean addGroupPermissions, boolean addGuestPermissions)
273                    throws com.liferay.portal.kernel.exception.PortalException,
274                            com.liferay.portal.kernel.exception.SystemException {
275                    getService()
276                            .addTagResources(tag, addGroupPermissions, addGuestPermissions);
277            }
278    
279            public static void addTagResources(
280                    com.liferay.portlet.asset.model.AssetTag tag,
281                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
282                    throws com.liferay.portal.kernel.exception.PortalException,
283                            com.liferay.portal.kernel.exception.SystemException {
284                    getService().addTagResources(tag, groupPermissions, guestPermissions);
285            }
286    
287            public static void checkTags(long userId, long groupId,
288                    java.lang.String[] names)
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException {
291                    getService().checkTags(userId, groupId, names);
292            }
293    
294            public static com.liferay.portlet.asset.model.AssetTag decrementAssetCount(
295                    long tagId, long classNameId)
296                    throws com.liferay.portal.kernel.exception.PortalException,
297                            com.liferay.portal.kernel.exception.SystemException {
298                    return getService().decrementAssetCount(tagId, classNameId);
299            }
300    
301            public static void deleteTag(com.liferay.portlet.asset.model.AssetTag tag)
302                    throws com.liferay.portal.kernel.exception.PortalException,
303                            com.liferay.portal.kernel.exception.SystemException {
304                    getService().deleteTag(tag);
305            }
306    
307            public static void deleteTag(long tagId)
308                    throws com.liferay.portal.kernel.exception.PortalException,
309                            com.liferay.portal.kernel.exception.SystemException {
310                    getService().deleteTag(tagId);
311            }
312    
313            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getEntryTags(
314                    long entryId)
315                    throws com.liferay.portal.kernel.exception.SystemException {
316                    return getService().getEntryTags(entryId);
317            }
318    
319            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getGroupsTags(
320                    long[] groupIds)
321                    throws com.liferay.portal.kernel.exception.SystemException {
322                    return getService().getGroupsTags(groupIds);
323            }
324    
325            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getGroupTags(
326                    long groupId)
327                    throws com.liferay.portal.kernel.exception.SystemException {
328                    return getService().getGroupTags(groupId);
329            }
330    
331            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getGroupTags(
332                    long groupId, int start, int end)
333                    throws com.liferay.portal.kernel.exception.SystemException {
334                    return getService().getGroupTags(groupId, start, end);
335            }
336    
337            public static int getGroupTagsCount(long groupId)
338                    throws com.liferay.portal.kernel.exception.SystemException {
339                    return getService().getGroupTagsCount(groupId);
340            }
341    
342            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getSocialActivityCounterOffsetTags(
343                    long groupId, java.lang.String socialActivityCounterName,
344                    int startOffset, int endOffset)
345                    throws com.liferay.portal.kernel.exception.SystemException {
346                    return getService()
347                                       .getSocialActivityCounterOffsetTags(groupId,
348                            socialActivityCounterName, startOffset, endOffset);
349            }
350    
351            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getSocialActivityCounterPeriodTags(
352                    long groupId, java.lang.String socialActivityCounterName,
353                    int startPeriod, int endPeriod)
354                    throws com.liferay.portal.kernel.exception.SystemException {
355                    return getService()
356                                       .getSocialActivityCounterPeriodTags(groupId,
357                            socialActivityCounterName, startPeriod, endPeriod);
358            }
359    
360            public static com.liferay.portlet.asset.model.AssetTag getTag(long tagId)
361                    throws com.liferay.portal.kernel.exception.PortalException,
362                            com.liferay.portal.kernel.exception.SystemException {
363                    return getService().getTag(tagId);
364            }
365    
366            public static com.liferay.portlet.asset.model.AssetTag getTag(
367                    long groupId, java.lang.String name)
368                    throws com.liferay.portal.kernel.exception.PortalException,
369                            com.liferay.portal.kernel.exception.SystemException {
370                    return getService().getTag(groupId, name);
371            }
372    
373            public static long[] getTagIds(long groupId, java.lang.String[] names)
374                    throws com.liferay.portal.kernel.exception.PortalException,
375                            com.liferay.portal.kernel.exception.SystemException {
376                    return getService().getTagIds(groupId, names);
377            }
378    
379            public static long[] getTagIds(long[] groupIds, java.lang.String[] names)
380                    throws com.liferay.portal.kernel.exception.PortalException,
381                            com.liferay.portal.kernel.exception.SystemException {
382                    return getService().getTagIds(groupIds, names);
383            }
384    
385            public static java.lang.String[] getTagNames()
386                    throws com.liferay.portal.kernel.exception.SystemException {
387                    return getService().getTagNames();
388            }
389    
390            public static java.lang.String[] getTagNames(long classNameId, long classPK)
391                    throws com.liferay.portal.kernel.exception.SystemException {
392                    return getService().getTagNames(classNameId, classPK);
393            }
394    
395            public static java.lang.String[] getTagNames(java.lang.String className,
396                    long classPK)
397                    throws com.liferay.portal.kernel.exception.SystemException {
398                    return getService().getTagNames(className, classPK);
399            }
400    
401            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getTags()
402                    throws com.liferay.portal.kernel.exception.SystemException {
403                    return getService().getTags();
404            }
405    
406            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getTags(
407                    long classNameId, long classPK)
408                    throws com.liferay.portal.kernel.exception.SystemException {
409                    return getService().getTags(classNameId, classPK);
410            }
411    
412            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getTags(
413                    long groupId, long classNameId, java.lang.String name)
414                    throws com.liferay.portal.kernel.exception.SystemException {
415                    return getService().getTags(groupId, classNameId, name);
416            }
417    
418            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getTags(
419                    long groupId, long classNameId, java.lang.String name, int start,
420                    int end) throws com.liferay.portal.kernel.exception.SystemException {
421                    return getService().getTags(groupId, classNameId, name, start, end);
422            }
423    
424            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getTags(
425                    java.lang.String className, long classPK)
426                    throws com.liferay.portal.kernel.exception.SystemException {
427                    return getService().getTags(className, classPK);
428            }
429    
430            public static int getTagsSize(long groupId, long classNameId,
431                    java.lang.String name)
432                    throws com.liferay.portal.kernel.exception.SystemException {
433                    return getService().getTagsSize(groupId, classNameId, name);
434            }
435    
436            public static boolean hasTag(long groupId, java.lang.String name)
437                    throws com.liferay.portal.kernel.exception.PortalException,
438                            com.liferay.portal.kernel.exception.SystemException {
439                    return getService().hasTag(groupId, name);
440            }
441    
442            public static com.liferay.portlet.asset.model.AssetTag incrementAssetCount(
443                    long tagId, long classNameId)
444                    throws com.liferay.portal.kernel.exception.PortalException,
445                            com.liferay.portal.kernel.exception.SystemException {
446                    return getService().incrementAssetCount(tagId, classNameId);
447            }
448    
449            public static void mergeTags(long fromTagId, long toTagId,
450                    boolean overrideProperties)
451                    throws com.liferay.portal.kernel.exception.PortalException,
452                            com.liferay.portal.kernel.exception.SystemException {
453                    getService().mergeTags(fromTagId, toTagId, overrideProperties);
454            }
455    
456            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> search(
457                    long groupId, java.lang.String name, java.lang.String[] tagProperties,
458                    int start, int end)
459                    throws com.liferay.portal.kernel.exception.SystemException {
460                    return getService().search(groupId, name, tagProperties, start, end);
461            }
462    
463            public static com.liferay.portlet.asset.model.AssetTag updateTag(
464                    long userId, long tagId, java.lang.String name,
465                    java.lang.String[] tagProperties,
466                    com.liferay.portal.service.ServiceContext serviceContext)
467                    throws com.liferay.portal.kernel.exception.PortalException,
468                            com.liferay.portal.kernel.exception.SystemException {
469                    return getService()
470                                       .updateTag(userId, tagId, name, tagProperties, serviceContext);
471            }
472    
473            public static AssetTagLocalService getService() {
474                    if (_service == null) {
475                            _service = (AssetTagLocalService)PortalBeanLocatorUtil.locate(AssetTagLocalService.class.getName());
476    
477                            ReferenceRegistry.registerReference(AssetTagLocalServiceUtil.class,
478                                    "_service");
479                            MethodCache.remove(AssetTagLocalService.class);
480                    }
481    
482                    return _service;
483            }
484    
485            public void setService(AssetTagLocalService service) {
486                    MethodCache.remove(AssetTagLocalService.class);
487    
488                    _service = service;
489    
490                    ReferenceRegistry.registerReference(AssetTagLocalServiceUtil.class,
491                            "_service");
492                    MethodCache.remove(AssetTagLocalService.class);
493            }
494    
495            private static AssetTagLocalService _service;
496    }