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.ReferenceRegistry;
019    
020    /**
021     * 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.
022     *
023     * <p>
024     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
025     * </p>
026     *
027     * @author Brian Wing Shun Chan
028     * @see AssetTagLocalService
029     * @see com.liferay.portlet.asset.service.base.AssetTagLocalServiceBaseImpl
030     * @see com.liferay.portlet.asset.service.impl.AssetTagLocalServiceImpl
031     * @generated
032     */
033    public class AssetTagLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * 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.
038             */
039    
040            /**
041            * Adds the asset tag to the database. Also notifies the appropriate model listeners.
042            *
043            * @param assetTag the asset tag
044            * @return the asset tag that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portlet.asset.model.AssetTag addAssetTag(
048                    com.liferay.portlet.asset.model.AssetTag assetTag)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addAssetTag(assetTag);
051            }
052    
053            /**
054            * Creates a new asset tag with the primary key. Does not add the asset tag to the database.
055            *
056            * @param tagId the primary key for the new asset tag
057            * @return the new asset tag
058            */
059            public static com.liferay.portlet.asset.model.AssetTag createAssetTag(
060                    long tagId) {
061                    return getService().createAssetTag(tagId);
062            }
063    
064            /**
065            * Deletes the asset tag with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param tagId the primary key of the asset tag
068            * @return the asset tag that was removed
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 com.liferay.portlet.asset.model.AssetTag deleteAssetTag(
073                    long tagId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteAssetTag(tagId);
077            }
078    
079            /**
080            * Deletes the asset tag from the database. Also notifies the appropriate model listeners.
081            *
082            * @param assetTag the asset tag
083            * @return the asset tag that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portlet.asset.model.AssetTag deleteAssetTag(
087                    com.liferay.portlet.asset.model.AssetTag assetTag)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deleteAssetTag(assetTag);
090            }
091    
092            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
093                    return getService().dynamicQuery();
094            }
095    
096            /**
097            * Performs a dynamic query on the database and returns the matching rows.
098            *
099            * @param dynamicQuery the dynamic query
100            * @return the matching rows
101            * @throws SystemException if a system exception occurred
102            */
103            @SuppressWarnings("rawtypes")
104            public static java.util.List dynamicQuery(
105                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
106                    throws com.liferay.portal.kernel.exception.SystemException {
107                    return getService().dynamicQuery(dynamicQuery);
108            }
109    
110            /**
111            * Performs a dynamic query on the database and returns a range of the matching rows.
112            *
113            * <p>
114            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
115            * </p>
116            *
117            * @param dynamicQuery the dynamic query
118            * @param start the lower bound of the range of model instances
119            * @param end the upper bound of the range of model instances (not inclusive)
120            * @return the range of matching rows
121            * @throws SystemException if a system exception occurred
122            */
123            @SuppressWarnings("rawtypes")
124            public static java.util.List dynamicQuery(
125                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
126                    int end) throws com.liferay.portal.kernel.exception.SystemException {
127                    return getService().dynamicQuery(dynamicQuery, start, end);
128            }
129    
130            /**
131            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
132            *
133            * <p>
134            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
135            * </p>
136            *
137            * @param dynamicQuery the dynamic query
138            * @param start the lower bound of the range of model instances
139            * @param end the upper bound of the range of model instances (not inclusive)
140            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
141            * @return the ordered range of matching rows
142            * @throws SystemException if a system exception occurred
143            */
144            @SuppressWarnings("rawtypes")
145            public static java.util.List dynamicQuery(
146                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
147                    int end,
148                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
149                    throws com.liferay.portal.kernel.exception.SystemException {
150                    return getService()
151                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
152            }
153    
154            /**
155            * Returns the number of rows that match the dynamic query.
156            *
157            * @param dynamicQuery the dynamic query
158            * @return the number of rows that match the dynamic query
159            * @throws SystemException if a system exception occurred
160            */
161            public static long dynamicQueryCount(
162                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().dynamicQueryCount(dynamicQuery);
165            }
166    
167            public static com.liferay.portlet.asset.model.AssetTag fetchAssetTag(
168                    long tagId) throws com.liferay.portal.kernel.exception.SystemException {
169                    return getService().fetchAssetTag(tagId);
170            }
171    
172            /**
173            * Returns the asset tag with the primary key.
174            *
175            * @param tagId the primary key of the asset tag
176            * @return the asset tag
177            * @throws PortalException if a asset tag with the primary key could not be found
178            * @throws SystemException if a system exception occurred
179            */
180            public static com.liferay.portlet.asset.model.AssetTag getAssetTag(
181                    long tagId)
182                    throws com.liferay.portal.kernel.exception.PortalException,
183                            com.liferay.portal.kernel.exception.SystemException {
184                    return getService().getAssetTag(tagId);
185            }
186    
187            public static com.liferay.portal.model.PersistedModel getPersistedModel(
188                    java.io.Serializable primaryKeyObj)
189                    throws com.liferay.portal.kernel.exception.PortalException,
190                            com.liferay.portal.kernel.exception.SystemException {
191                    return getService().getPersistedModel(primaryKeyObj);
192            }
193    
194            /**
195            * Returns a range of all the asset tags.
196            *
197            * <p>
198            * 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.
199            * </p>
200            *
201            * @param start the lower bound of the range of asset tags
202            * @param end the upper bound of the range of asset tags (not inclusive)
203            * @return the range of asset tags
204            * @throws SystemException if a system exception occurred
205            */
206            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getAssetTags(
207                    int start, int end)
208                    throws com.liferay.portal.kernel.exception.SystemException {
209                    return getService().getAssetTags(start, end);
210            }
211    
212            /**
213            * Returns the number of asset tags.
214            *
215            * @return the number of asset tags
216            * @throws SystemException if a system exception occurred
217            */
218            public static int getAssetTagsCount()
219                    throws com.liferay.portal.kernel.exception.SystemException {
220                    return getService().getAssetTagsCount();
221            }
222    
223            /**
224            * Updates the asset tag in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
225            *
226            * @param assetTag the asset tag
227            * @return the asset tag that was updated
228            * @throws SystemException if a system exception occurred
229            */
230            public static com.liferay.portlet.asset.model.AssetTag updateAssetTag(
231                    com.liferay.portlet.asset.model.AssetTag assetTag)
232                    throws com.liferay.portal.kernel.exception.SystemException {
233                    return getService().updateAssetTag(assetTag);
234            }
235    
236            /**
237            * Returns the Spring bean ID for this bean.
238            *
239            * @return the Spring bean ID for this bean
240            */
241            public static java.lang.String getBeanIdentifier() {
242                    return getService().getBeanIdentifier();
243            }
244    
245            /**
246            * Sets the Spring bean ID for this bean.
247            *
248            * @param beanIdentifier the Spring bean ID for this bean
249            */
250            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
251                    getService().setBeanIdentifier(beanIdentifier);
252            }
253    
254            public static com.liferay.portlet.asset.model.AssetTag addTag(long userId,
255                    java.lang.String name, java.lang.String[] tagProperties,
256                    com.liferay.portal.service.ServiceContext serviceContext)
257                    throws com.liferay.portal.kernel.exception.PortalException,
258                            com.liferay.portal.kernel.exception.SystemException {
259                    return getService().addTag(userId, name, tagProperties, serviceContext);
260            }
261    
262            public static void addTagResources(
263                    com.liferay.portlet.asset.model.AssetTag tag,
264                    boolean addGroupPermissions, boolean addGuestPermissions)
265                    throws com.liferay.portal.kernel.exception.PortalException,
266                            com.liferay.portal.kernel.exception.SystemException {
267                    getService()
268                            .addTagResources(tag, addGroupPermissions, addGuestPermissions);
269            }
270    
271            public static void addTagResources(
272                    com.liferay.portlet.asset.model.AssetTag tag,
273                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
274                    throws com.liferay.portal.kernel.exception.PortalException,
275                            com.liferay.portal.kernel.exception.SystemException {
276                    getService().addTagResources(tag, groupPermissions, guestPermissions);
277            }
278    
279            public static void checkTags(long userId, long groupId,
280                    java.lang.String[] names)
281                    throws com.liferay.portal.kernel.exception.PortalException,
282                            com.liferay.portal.kernel.exception.SystemException {
283                    getService().checkTags(userId, groupId, names);
284            }
285    
286            public static com.liferay.portlet.asset.model.AssetTag decrementAssetCount(
287                    long tagId, long classNameId)
288                    throws com.liferay.portal.kernel.exception.PortalException,
289                            com.liferay.portal.kernel.exception.SystemException {
290                    return getService().decrementAssetCount(tagId, classNameId);
291            }
292    
293            public static void deleteTag(com.liferay.portlet.asset.model.AssetTag tag)
294                    throws com.liferay.portal.kernel.exception.PortalException,
295                            com.liferay.portal.kernel.exception.SystemException {
296                    getService().deleteTag(tag);
297            }
298    
299            public static void deleteTag(long tagId)
300                    throws com.liferay.portal.kernel.exception.PortalException,
301                            com.liferay.portal.kernel.exception.SystemException {
302                    getService().deleteTag(tagId);
303            }
304    
305            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getEntryTags(
306                    long entryId)
307                    throws com.liferay.portal.kernel.exception.SystemException {
308                    return getService().getEntryTags(entryId);
309            }
310    
311            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getGroupsTags(
312                    long[] groupIds)
313                    throws com.liferay.portal.kernel.exception.SystemException {
314                    return getService().getGroupsTags(groupIds);
315            }
316    
317            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getGroupTags(
318                    long groupId)
319                    throws com.liferay.portal.kernel.exception.SystemException {
320                    return getService().getGroupTags(groupId);
321            }
322    
323            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getGroupTags(
324                    long groupId, int start, int end)
325                    throws com.liferay.portal.kernel.exception.SystemException {
326                    return getService().getGroupTags(groupId, start, end);
327            }
328    
329            public static int getGroupTagsCount(long groupId)
330                    throws com.liferay.portal.kernel.exception.SystemException {
331                    return getService().getGroupTagsCount(groupId);
332            }
333    
334            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getSocialActivityCounterOffsetTags(
335                    long groupId, java.lang.String socialActivityCounterName,
336                    int startOffset, int endOffset)
337                    throws com.liferay.portal.kernel.exception.SystemException {
338                    return getService()
339                                       .getSocialActivityCounterOffsetTags(groupId,
340                            socialActivityCounterName, startOffset, endOffset);
341            }
342    
343            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getSocialActivityCounterPeriodTags(
344                    long groupId, java.lang.String socialActivityCounterName,
345                    int startPeriod, int endPeriod)
346                    throws com.liferay.portal.kernel.exception.SystemException {
347                    return getService()
348                                       .getSocialActivityCounterPeriodTags(groupId,
349                            socialActivityCounterName, startPeriod, endPeriod);
350            }
351    
352            public static com.liferay.portlet.asset.model.AssetTag getTag(long tagId)
353                    throws com.liferay.portal.kernel.exception.PortalException,
354                            com.liferay.portal.kernel.exception.SystemException {
355                    return getService().getTag(tagId);
356            }
357    
358            public static com.liferay.portlet.asset.model.AssetTag getTag(
359                    long groupId, java.lang.String name)
360                    throws com.liferay.portal.kernel.exception.PortalException,
361                            com.liferay.portal.kernel.exception.SystemException {
362                    return getService().getTag(groupId, name);
363            }
364    
365            public static long[] getTagIds(long groupId, java.lang.String[] names)
366                    throws com.liferay.portal.kernel.exception.PortalException,
367                            com.liferay.portal.kernel.exception.SystemException {
368                    return getService().getTagIds(groupId, names);
369            }
370    
371            public static long[] getTagIds(long[] groupIds, java.lang.String name)
372                    throws com.liferay.portal.kernel.exception.PortalException,
373                            com.liferay.portal.kernel.exception.SystemException {
374                    return getService().getTagIds(groupIds, name);
375            }
376    
377            public static long[] getTagIds(long[] groupIds, java.lang.String[] names)
378                    throws com.liferay.portal.kernel.exception.PortalException,
379                            com.liferay.portal.kernel.exception.SystemException {
380                    return getService().getTagIds(groupIds, names);
381            }
382    
383            public static java.lang.String[] getTagNames()
384                    throws com.liferay.portal.kernel.exception.SystemException {
385                    return getService().getTagNames();
386            }
387    
388            public static java.lang.String[] getTagNames(long classNameId, long classPK)
389                    throws com.liferay.portal.kernel.exception.SystemException {
390                    return getService().getTagNames(classNameId, classPK);
391            }
392    
393            public static java.lang.String[] getTagNames(java.lang.String className,
394                    long classPK)
395                    throws com.liferay.portal.kernel.exception.SystemException {
396                    return getService().getTagNames(className, classPK);
397            }
398    
399            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getTags()
400                    throws com.liferay.portal.kernel.exception.SystemException {
401                    return getService().getTags();
402            }
403    
404            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getTags(
405                    long classNameId, long classPK)
406                    throws com.liferay.portal.kernel.exception.SystemException {
407                    return getService().getTags(classNameId, classPK);
408            }
409    
410            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getTags(
411                    long groupId, long classNameId, java.lang.String name)
412                    throws com.liferay.portal.kernel.exception.SystemException {
413                    return getService().getTags(groupId, classNameId, name);
414            }
415    
416            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getTags(
417                    long groupId, long classNameId, java.lang.String name, int start,
418                    int end) throws com.liferay.portal.kernel.exception.SystemException {
419                    return getService().getTags(groupId, classNameId, name, start, end);
420            }
421    
422            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getTags(
423                    java.lang.String className, long classPK)
424                    throws com.liferay.portal.kernel.exception.SystemException {
425                    return getService().getTags(className, classPK);
426            }
427    
428            public static int getTagsSize(long groupId, long classNameId,
429                    java.lang.String name)
430                    throws com.liferay.portal.kernel.exception.SystemException {
431                    return getService().getTagsSize(groupId, classNameId, name);
432            }
433    
434            public static boolean hasTag(long groupId, java.lang.String name)
435                    throws com.liferay.portal.kernel.exception.PortalException,
436                            com.liferay.portal.kernel.exception.SystemException {
437                    return getService().hasTag(groupId, name);
438            }
439    
440            public static com.liferay.portlet.asset.model.AssetTag incrementAssetCount(
441                    long tagId, long classNameId)
442                    throws com.liferay.portal.kernel.exception.PortalException,
443                            com.liferay.portal.kernel.exception.SystemException {
444                    return getService().incrementAssetCount(tagId, classNameId);
445            }
446    
447            public static void mergeTags(long fromTagId, long toTagId,
448                    boolean overrideProperties)
449                    throws com.liferay.portal.kernel.exception.PortalException,
450                            com.liferay.portal.kernel.exception.SystemException {
451                    getService().mergeTags(fromTagId, toTagId, overrideProperties);
452            }
453    
454            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> search(
455                    long groupId, java.lang.String name, java.lang.String[] tagProperties,
456                    int start, int end)
457                    throws com.liferay.portal.kernel.exception.SystemException {
458                    return getService().search(groupId, name, tagProperties, start, end);
459            }
460    
461            public static com.liferay.portlet.asset.model.AssetTag updateTag(
462                    long userId, long tagId, java.lang.String name,
463                    java.lang.String[] tagProperties,
464                    com.liferay.portal.service.ServiceContext serviceContext)
465                    throws com.liferay.portal.kernel.exception.PortalException,
466                            com.liferay.portal.kernel.exception.SystemException {
467                    return getService()
468                                       .updateTag(userId, tagId, name, tagProperties, serviceContext);
469            }
470    
471            public static AssetTagLocalService getService() {
472                    if (_service == null) {
473                            _service = (AssetTagLocalService)PortalBeanLocatorUtil.locate(AssetTagLocalService.class.getName());
474    
475                            ReferenceRegistry.registerReference(AssetTagLocalServiceUtil.class,
476                                    "_service");
477                    }
478    
479                    return _service;
480            }
481    
482            /**
483             * @deprecated
484             */
485            public void setService(AssetTagLocalService service) {
486            }
487    
488            private static AssetTagLocalService _service;
489    }