001    /**
002     * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
014    
015    package com.liferay.portlet.asset.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    import com.liferay.portal.kernel.util.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            * Updates the asset tag in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
238            *
239            * @param assetTag the asset tag
240            * @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.
241            * @return the asset tag that was updated
242            * @throws SystemException if a system exception occurred
243            */
244            public static com.liferay.portlet.asset.model.AssetTag updateAssetTag(
245                    com.liferay.portlet.asset.model.AssetTag assetTag, boolean merge)
246                    throws com.liferay.portal.kernel.exception.SystemException {
247                    return getService().updateAssetTag(assetTag, merge);
248            }
249    
250            /**
251            * Returns the Spring bean ID for this bean.
252            *
253            * @return the Spring bean ID for this bean
254            */
255            public static java.lang.String getBeanIdentifier() {
256                    return getService().getBeanIdentifier();
257            }
258    
259            /**
260            * Sets the Spring bean ID for this bean.
261            *
262            * @param beanIdentifier the Spring bean ID for this bean
263            */
264            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
265                    getService().setBeanIdentifier(beanIdentifier);
266            }
267    
268            public static com.liferay.portlet.asset.model.AssetTag addTag(long userId,
269                    java.lang.String name, java.lang.String[] tagProperties,
270                    com.liferay.portal.service.ServiceContext serviceContext)
271                    throws com.liferay.portal.kernel.exception.PortalException,
272                            com.liferay.portal.kernel.exception.SystemException {
273                    return getService().addTag(userId, name, tagProperties, serviceContext);
274            }
275    
276            public static void addTagResources(
277                    com.liferay.portlet.asset.model.AssetTag tag,
278                    boolean addGroupPermissions, boolean addGuestPermissions)
279                    throws com.liferay.portal.kernel.exception.PortalException,
280                            com.liferay.portal.kernel.exception.SystemException {
281                    getService()
282                            .addTagResources(tag, addGroupPermissions, addGuestPermissions);
283            }
284    
285            public static void addTagResources(
286                    com.liferay.portlet.asset.model.AssetTag tag,
287                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
288                    throws com.liferay.portal.kernel.exception.PortalException,
289                            com.liferay.portal.kernel.exception.SystemException {
290                    getService().addTagResources(tag, groupPermissions, guestPermissions);
291            }
292    
293            public static void checkTags(long userId, long groupId,
294                    java.lang.String[] names)
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException {
297                    getService().checkTags(userId, groupId, names);
298            }
299    
300            public static com.liferay.portlet.asset.model.AssetTag decrementAssetCount(
301                    long tagId, long classNameId)
302                    throws com.liferay.portal.kernel.exception.PortalException,
303                            com.liferay.portal.kernel.exception.SystemException {
304                    return getService().decrementAssetCount(tagId, classNameId);
305            }
306    
307            public static void deleteTag(com.liferay.portlet.asset.model.AssetTag tag)
308                    throws com.liferay.portal.kernel.exception.PortalException,
309                            com.liferay.portal.kernel.exception.SystemException {
310                    getService().deleteTag(tag);
311            }
312    
313            public static void deleteTag(long tagId)
314                    throws com.liferay.portal.kernel.exception.PortalException,
315                            com.liferay.portal.kernel.exception.SystemException {
316                    getService().deleteTag(tagId);
317            }
318    
319            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getEntryTags(
320                    long entryId)
321                    throws com.liferay.portal.kernel.exception.SystemException {
322                    return getService().getEntryTags(entryId);
323            }
324    
325            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getGroupsTags(
326                    long[] groupIds)
327                    throws com.liferay.portal.kernel.exception.SystemException {
328                    return getService().getGroupsTags(groupIds);
329            }
330    
331            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getGroupTags(
332                    long groupId)
333                    throws com.liferay.portal.kernel.exception.SystemException {
334                    return getService().getGroupTags(groupId);
335            }
336    
337            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getGroupTags(
338                    long groupId, int start, int end)
339                    throws com.liferay.portal.kernel.exception.SystemException {
340                    return getService().getGroupTags(groupId, start, end);
341            }
342    
343            public static int getGroupTagsCount(long groupId)
344                    throws com.liferay.portal.kernel.exception.SystemException {
345                    return getService().getGroupTagsCount(groupId);
346            }
347    
348            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getSocialActivityCounterOffsetTags(
349                    long groupId, java.lang.String socialActivityCounterName,
350                    int startOffset, int endOffset)
351                    throws com.liferay.portal.kernel.exception.SystemException {
352                    return getService()
353                                       .getSocialActivityCounterOffsetTags(groupId,
354                            socialActivityCounterName, startOffset, endOffset);
355            }
356    
357            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getSocialActivityCounterPeriodTags(
358                    long groupId, java.lang.String socialActivityCounterName,
359                    int startPeriod, int endPeriod)
360                    throws com.liferay.portal.kernel.exception.SystemException {
361                    return getService()
362                                       .getSocialActivityCounterPeriodTags(groupId,
363                            socialActivityCounterName, startPeriod, endPeriod);
364            }
365    
366            public static com.liferay.portlet.asset.model.AssetTag getTag(long tagId)
367                    throws com.liferay.portal.kernel.exception.PortalException,
368                            com.liferay.portal.kernel.exception.SystemException {
369                    return getService().getTag(tagId);
370            }
371    
372            public static com.liferay.portlet.asset.model.AssetTag getTag(
373                    long groupId, java.lang.String name)
374                    throws com.liferay.portal.kernel.exception.PortalException,
375                            com.liferay.portal.kernel.exception.SystemException {
376                    return getService().getTag(groupId, name);
377            }
378    
379            public static long[] getTagIds(long groupId, java.lang.String[] names)
380                    throws com.liferay.portal.kernel.exception.PortalException,
381                            com.liferay.portal.kernel.exception.SystemException {
382                    return getService().getTagIds(groupId, names);
383            }
384    
385            public static long[] getTagIds(long[] groupIds, java.lang.String name)
386                    throws com.liferay.portal.kernel.exception.PortalException,
387                            com.liferay.portal.kernel.exception.SystemException {
388                    return getService().getTagIds(groupIds, name);
389            }
390    
391            public static long[] getTagIds(long[] groupIds, java.lang.String[] names)
392                    throws com.liferay.portal.kernel.exception.PortalException,
393                            com.liferay.portal.kernel.exception.SystemException {
394                    return getService().getTagIds(groupIds, names);
395            }
396    
397            public static java.lang.String[] getTagNames()
398                    throws com.liferay.portal.kernel.exception.SystemException {
399                    return getService().getTagNames();
400            }
401    
402            public static java.lang.String[] getTagNames(long classNameId, long classPK)
403                    throws com.liferay.portal.kernel.exception.SystemException {
404                    return getService().getTagNames(classNameId, classPK);
405            }
406    
407            public static java.lang.String[] getTagNames(java.lang.String className,
408                    long classPK)
409                    throws com.liferay.portal.kernel.exception.SystemException {
410                    return getService().getTagNames(className, classPK);
411            }
412    
413            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getTags()
414                    throws com.liferay.portal.kernel.exception.SystemException {
415                    return getService().getTags();
416            }
417    
418            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getTags(
419                    long classNameId, long classPK)
420                    throws com.liferay.portal.kernel.exception.SystemException {
421                    return getService().getTags(classNameId, classPK);
422            }
423    
424            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getTags(
425                    long groupId, long classNameId, java.lang.String name)
426                    throws com.liferay.portal.kernel.exception.SystemException {
427                    return getService().getTags(groupId, classNameId, name);
428            }
429    
430            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getTags(
431                    long groupId, long classNameId, java.lang.String name, int start,
432                    int end) throws com.liferay.portal.kernel.exception.SystemException {
433                    return getService().getTags(groupId, classNameId, name, start, end);
434            }
435    
436            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getTags(
437                    java.lang.String className, long classPK)
438                    throws com.liferay.portal.kernel.exception.SystemException {
439                    return getService().getTags(className, classPK);
440            }
441    
442            public static int getTagsSize(long groupId, long classNameId,
443                    java.lang.String name)
444                    throws com.liferay.portal.kernel.exception.SystemException {
445                    return getService().getTagsSize(groupId, classNameId, name);
446            }
447    
448            public static boolean hasTag(long groupId, java.lang.String name)
449                    throws com.liferay.portal.kernel.exception.PortalException,
450                            com.liferay.portal.kernel.exception.SystemException {
451                    return getService().hasTag(groupId, name);
452            }
453    
454            public static com.liferay.portlet.asset.model.AssetTag incrementAssetCount(
455                    long tagId, long classNameId)
456                    throws com.liferay.portal.kernel.exception.PortalException,
457                            com.liferay.portal.kernel.exception.SystemException {
458                    return getService().incrementAssetCount(tagId, classNameId);
459            }
460    
461            public static void mergeTags(long fromTagId, long toTagId,
462                    boolean overrideProperties)
463                    throws com.liferay.portal.kernel.exception.PortalException,
464                            com.liferay.portal.kernel.exception.SystemException {
465                    getService().mergeTags(fromTagId, toTagId, overrideProperties);
466            }
467    
468            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> search(
469                    long groupId, java.lang.String name, java.lang.String[] tagProperties,
470                    int start, int end)
471                    throws com.liferay.portal.kernel.exception.SystemException {
472                    return getService().search(groupId, name, tagProperties, start, end);
473            }
474    
475            public static com.liferay.portlet.asset.model.AssetTag updateTag(
476                    long userId, long tagId, java.lang.String name,
477                    java.lang.String[] tagProperties,
478                    com.liferay.portal.service.ServiceContext serviceContext)
479                    throws com.liferay.portal.kernel.exception.PortalException,
480                            com.liferay.portal.kernel.exception.SystemException {
481                    return getService()
482                                       .updateTag(userId, tagId, name, tagProperties, serviceContext);
483            }
484    
485            public static AssetTagLocalService getService() {
486                    if (_service == null) {
487                            _service = (AssetTagLocalService)PortalBeanLocatorUtil.locate(AssetTagLocalService.class.getName());
488    
489                            ReferenceRegistry.registerReference(AssetTagLocalServiceUtil.class,
490                                    "_service");
491                    }
492    
493                    return _service;
494            }
495    
496            /**
497             * @deprecated
498             */
499            public void setService(AssetTagLocalService service) {
500            }
501    
502            private static AssetTagLocalService _service;
503    }