001    /**
002     * Copyright (c) 2000-2011 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.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 addCommunityPermissions, boolean addGuestPermissions)
268                    throws com.liferay.portal.kernel.exception.PortalException,
269                            com.liferay.portal.kernel.exception.SystemException {
270                    getService()
271                            .addTagResources(tag, addCommunityPermissions, addGuestPermissions);
272            }
273    
274            public static void addTagResources(
275                    com.liferay.portlet.asset.model.AssetTag tag,
276                    java.lang.String[] communityPermissions,
277                    java.lang.String[] guestPermissions)
278                    throws com.liferay.portal.kernel.exception.PortalException,
279                            com.liferay.portal.kernel.exception.SystemException {
280                    getService().addTagResources(tag, communityPermissions, guestPermissions);
281            }
282    
283            public static void checkTags(long userId, long groupId,
284                    java.lang.String[] names)
285                    throws com.liferay.portal.kernel.exception.PortalException,
286                            com.liferay.portal.kernel.exception.SystemException {
287                    getService().checkTags(userId, groupId, names);
288            }
289    
290            public static com.liferay.portlet.asset.model.AssetTag decrementAssetCount(
291                    long tagId, long classNameId)
292                    throws com.liferay.portal.kernel.exception.PortalException,
293                            com.liferay.portal.kernel.exception.SystemException {
294                    return getService().decrementAssetCount(tagId, classNameId);
295            }
296    
297            public static void deleteTag(com.liferay.portlet.asset.model.AssetTag tag)
298                    throws com.liferay.portal.kernel.exception.PortalException,
299                            com.liferay.portal.kernel.exception.SystemException {
300                    getService().deleteTag(tag);
301            }
302    
303            public static void deleteTag(long tagId)
304                    throws com.liferay.portal.kernel.exception.PortalException,
305                            com.liferay.portal.kernel.exception.SystemException {
306                    getService().deleteTag(tagId);
307            }
308    
309            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getEntryTags(
310                    long entryId)
311                    throws com.liferay.portal.kernel.exception.SystemException {
312                    return getService().getEntryTags(entryId);
313            }
314    
315            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getGroupsTags(
316                    long[] groupIds)
317                    throws com.liferay.portal.kernel.exception.SystemException {
318                    return getService().getGroupsTags(groupIds);
319            }
320    
321            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getGroupTags(
322                    long groupId)
323                    throws com.liferay.portal.kernel.exception.SystemException {
324                    return getService().getGroupTags(groupId);
325            }
326    
327            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getGroupTags(
328                    long groupId, int start, int end)
329                    throws com.liferay.portal.kernel.exception.SystemException {
330                    return getService().getGroupTags(groupId, start, end);
331            }
332    
333            public static int getGroupTagsCount(long groupId)
334                    throws com.liferay.portal.kernel.exception.SystemException {
335                    return getService().getGroupTagsCount(groupId);
336            }
337    
338            public static com.liferay.portlet.asset.model.AssetTag getTag(long tagId)
339                    throws com.liferay.portal.kernel.exception.PortalException,
340                            com.liferay.portal.kernel.exception.SystemException {
341                    return getService().getTag(tagId);
342            }
343    
344            public static com.liferay.portlet.asset.model.AssetTag getTag(
345                    long groupId, java.lang.String name)
346                    throws com.liferay.portal.kernel.exception.PortalException,
347                            com.liferay.portal.kernel.exception.SystemException {
348                    return getService().getTag(groupId, name);
349            }
350    
351            public static long[] getTagIds(long groupId, java.lang.String[] names)
352                    throws com.liferay.portal.kernel.exception.PortalException,
353                            com.liferay.portal.kernel.exception.SystemException {
354                    return getService().getTagIds(groupId, names);
355            }
356    
357            public static long[] getTagIds(long[] groupIds, java.lang.String[] names)
358                    throws com.liferay.portal.kernel.exception.PortalException,
359                            com.liferay.portal.kernel.exception.SystemException {
360                    return getService().getTagIds(groupIds, names);
361            }
362    
363            public static java.lang.String[] getTagNames()
364                    throws com.liferay.portal.kernel.exception.SystemException {
365                    return getService().getTagNames();
366            }
367    
368            public static java.lang.String[] getTagNames(long classNameId, long classPK)
369                    throws com.liferay.portal.kernel.exception.SystemException {
370                    return getService().getTagNames(classNameId, classPK);
371            }
372    
373            public static java.lang.String[] getTagNames(java.lang.String className,
374                    long classPK)
375                    throws com.liferay.portal.kernel.exception.SystemException {
376                    return getService().getTagNames(className, classPK);
377            }
378    
379            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getTags()
380                    throws com.liferay.portal.kernel.exception.SystemException {
381                    return getService().getTags();
382            }
383    
384            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getTags(
385                    long classNameId, long classPK)
386                    throws com.liferay.portal.kernel.exception.SystemException {
387                    return getService().getTags(classNameId, classPK);
388            }
389    
390            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getTags(
391                    long groupId, long classNameId, java.lang.String name)
392                    throws com.liferay.portal.kernel.exception.SystemException {
393                    return getService().getTags(groupId, classNameId, name);
394            }
395    
396            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getTags(
397                    long groupId, long classNameId, java.lang.String name, int start,
398                    int end) throws com.liferay.portal.kernel.exception.SystemException {
399                    return getService().getTags(groupId, classNameId, name, start, end);
400            }
401    
402            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> getTags(
403                    java.lang.String className, long classPK)
404                    throws com.liferay.portal.kernel.exception.SystemException {
405                    return getService().getTags(className, classPK);
406            }
407    
408            public static int getTagsSize(long groupId, long classNameId,
409                    java.lang.String name)
410                    throws com.liferay.portal.kernel.exception.SystemException {
411                    return getService().getTagsSize(groupId, classNameId, name);
412            }
413    
414            public static boolean hasTag(long groupId, java.lang.String name)
415                    throws com.liferay.portal.kernel.exception.PortalException,
416                            com.liferay.portal.kernel.exception.SystemException {
417                    return getService().hasTag(groupId, name);
418            }
419    
420            public static com.liferay.portlet.asset.model.AssetTag incrementAssetCount(
421                    long tagId, long classNameId)
422                    throws com.liferay.portal.kernel.exception.PortalException,
423                            com.liferay.portal.kernel.exception.SystemException {
424                    return getService().incrementAssetCount(tagId, classNameId);
425            }
426    
427            /**
428            * @deprecated {@link #mergeTags(long, long, boolean)}
429            */
430            public static void mergeTags(long fromTagId, long toTagId)
431                    throws com.liferay.portal.kernel.exception.PortalException,
432                            com.liferay.portal.kernel.exception.SystemException {
433                    getService().mergeTags(fromTagId, toTagId);
434            }
435    
436            public static void mergeTags(long fromTagId, long toTagId,
437                    boolean overrideProperties)
438                    throws com.liferay.portal.kernel.exception.PortalException,
439                            com.liferay.portal.kernel.exception.SystemException {
440                    getService().mergeTags(fromTagId, toTagId, overrideProperties);
441            }
442    
443            public static java.util.List<com.liferay.portlet.asset.model.AssetTag> search(
444                    long groupId, java.lang.String name, java.lang.String[] tagProperties,
445                    int start, int end)
446                    throws com.liferay.portal.kernel.exception.SystemException {
447                    return getService().search(groupId, name, tagProperties, start, end);
448            }
449    
450            public static com.liferay.portlet.asset.model.AssetTag updateTag(
451                    long userId, long tagId, java.lang.String name,
452                    java.lang.String[] tagProperties,
453                    com.liferay.portal.service.ServiceContext serviceContext)
454                    throws com.liferay.portal.kernel.exception.PortalException,
455                            com.liferay.portal.kernel.exception.SystemException {
456                    return getService()
457                                       .updateTag(userId, tagId, name, tagProperties, serviceContext);
458            }
459    
460            public static AssetTagLocalService getService() {
461                    if (_service == null) {
462                            _service = (AssetTagLocalService)PortalBeanLocatorUtil.locate(AssetTagLocalService.class.getName());
463    
464                            ReferenceRegistry.registerReference(AssetTagLocalServiceUtil.class,
465                                    "_service");
466                            MethodCache.remove(AssetTagLocalService.class);
467                    }
468    
469                    return _service;
470            }
471    
472            public void setService(AssetTagLocalService service) {
473                    MethodCache.remove(AssetTagLocalService.class);
474    
475                    _service = service;
476    
477                    ReferenceRegistry.registerReference(AssetTagLocalServiceUtil.class,
478                            "_service");
479                    MethodCache.remove(AssetTagLocalService.class);
480            }
481    
482            private static AssetTagLocalService _service;
483    }