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 entry local service. This utility wraps {@link com.liferay.portlet.asset.service.impl.AssetEntryLocalServiceImpl} 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 AssetEntryLocalService
030     * @see com.liferay.portlet.asset.service.base.AssetEntryLocalServiceBaseImpl
031     * @see com.liferay.portlet.asset.service.impl.AssetEntryLocalServiceImpl
032     * @generated
033     */
034    public class AssetEntryLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.asset.service.impl.AssetEntryLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the asset entry to the database. Also notifies the appropriate model listeners.
043            *
044            * @param assetEntry the asset entry
045            * @return the asset entry that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.asset.model.AssetEntry addAssetEntry(
049                    com.liferay.portlet.asset.model.AssetEntry assetEntry)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addAssetEntry(assetEntry);
052            }
053    
054            /**
055            * Creates a new asset entry with the primary key. Does not add the asset entry to the database.
056            *
057            * @param entryId the primary key for the new asset entry
058            * @return the new asset entry
059            */
060            public static com.liferay.portlet.asset.model.AssetEntry createAssetEntry(
061                    long entryId) {
062                    return getService().createAssetEntry(entryId);
063            }
064    
065            /**
066            * Deletes the asset entry with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param entryId the primary key of the asset entry
069            * @throws PortalException if a asset entry with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteAssetEntry(long entryId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteAssetEntry(entryId);
076            }
077    
078            /**
079            * Deletes the asset entry from the database. Also notifies the appropriate model listeners.
080            *
081            * @param assetEntry the asset entry
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteAssetEntry(
085                    com.liferay.portlet.asset.model.AssetEntry assetEntry)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteAssetEntry(assetEntry);
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.AssetEntry fetchAssetEntry(
162                    long entryId)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().fetchAssetEntry(entryId);
165            }
166    
167            /**
168            * Returns the asset entry with the primary key.
169            *
170            * @param entryId the primary key of the asset entry
171            * @return the asset entry
172            * @throws PortalException if a asset entry with the primary key could not be found
173            * @throws SystemException if a system exception occurred
174            */
175            public static com.liferay.portlet.asset.model.AssetEntry getAssetEntry(
176                    long entryId)
177                    throws com.liferay.portal.kernel.exception.PortalException,
178                            com.liferay.portal.kernel.exception.SystemException {
179                    return getService().getAssetEntry(entryId);
180            }
181    
182            public static com.liferay.portal.model.PersistedModel getPersistedModel(
183                    java.io.Serializable primaryKeyObj)
184                    throws com.liferay.portal.kernel.exception.PortalException,
185                            com.liferay.portal.kernel.exception.SystemException {
186                    return getService().getPersistedModel(primaryKeyObj);
187            }
188    
189            /**
190            * Returns a range of all the asset entries.
191            *
192            * <p>
193            * 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.
194            * </p>
195            *
196            * @param start the lower bound of the range of asset entries
197            * @param end the upper bound of the range of asset entries (not inclusive)
198            * @return the range of asset entries
199            * @throws SystemException if a system exception occurred
200            */
201            public static java.util.List<com.liferay.portlet.asset.model.AssetEntry> getAssetEntries(
202                    int start, int end)
203                    throws com.liferay.portal.kernel.exception.SystemException {
204                    return getService().getAssetEntries(start, end);
205            }
206    
207            /**
208            * Returns the number of asset entries.
209            *
210            * @return the number of asset entries
211            * @throws SystemException if a system exception occurred
212            */
213            public static int getAssetEntriesCount()
214                    throws com.liferay.portal.kernel.exception.SystemException {
215                    return getService().getAssetEntriesCount();
216            }
217    
218            /**
219            * Updates the asset entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
220            *
221            * @param assetEntry the asset entry
222            * @return the asset entry that was updated
223            * @throws SystemException if a system exception occurred
224            */
225            public static com.liferay.portlet.asset.model.AssetEntry updateAssetEntry(
226                    com.liferay.portlet.asset.model.AssetEntry assetEntry)
227                    throws com.liferay.portal.kernel.exception.SystemException {
228                    return getService().updateAssetEntry(assetEntry);
229            }
230    
231            /**
232            * Updates the asset entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
233            *
234            * @param assetEntry the asset entry
235            * @param merge whether to merge the asset entry 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.
236            * @return the asset entry that was updated
237            * @throws SystemException if a system exception occurred
238            */
239            public static com.liferay.portlet.asset.model.AssetEntry updateAssetEntry(
240                    com.liferay.portlet.asset.model.AssetEntry assetEntry, boolean merge)
241                    throws com.liferay.portal.kernel.exception.SystemException {
242                    return getService().updateAssetEntry(assetEntry, merge);
243            }
244    
245            /**
246            * Returns the Spring bean ID for this bean.
247            *
248            * @return the Spring bean ID for this bean
249            */
250            public static java.lang.String getBeanIdentifier() {
251                    return getService().getBeanIdentifier();
252            }
253    
254            /**
255            * Sets the Spring bean ID for this bean.
256            *
257            * @param beanIdentifier the Spring bean ID for this bean
258            */
259            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
260                    getService().setBeanIdentifier(beanIdentifier);
261            }
262    
263            public static void deleteEntry(
264                    com.liferay.portlet.asset.model.AssetEntry entry)
265                    throws com.liferay.portal.kernel.exception.PortalException,
266                            com.liferay.portal.kernel.exception.SystemException {
267                    getService().deleteEntry(entry);
268            }
269    
270            public static void deleteEntry(long entryId)
271                    throws com.liferay.portal.kernel.exception.PortalException,
272                            com.liferay.portal.kernel.exception.SystemException {
273                    getService().deleteEntry(entryId);
274            }
275    
276            public static void deleteEntry(java.lang.String className, long classPK)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException {
279                    getService().deleteEntry(className, classPK);
280            }
281    
282            public static com.liferay.portlet.asset.model.AssetEntry fetchEntry(
283                    long entryId)
284                    throws com.liferay.portal.kernel.exception.SystemException {
285                    return getService().fetchEntry(entryId);
286            }
287    
288            public static com.liferay.portlet.asset.model.AssetEntry fetchEntry(
289                    java.lang.String className, long classPK)
290                    throws com.liferay.portal.kernel.exception.SystemException {
291                    return getService().fetchEntry(className, classPK);
292            }
293    
294            public static java.util.List<com.liferay.portlet.asset.model.AssetEntry> getAncestorEntries(
295                    long entryId)
296                    throws com.liferay.portal.kernel.exception.PortalException,
297                            com.liferay.portal.kernel.exception.SystemException {
298                    return getService().getAncestorEntries(entryId);
299            }
300    
301            public static java.util.List<com.liferay.portlet.asset.model.AssetEntry> getChildEntries(
302                    long entryId)
303                    throws com.liferay.portal.kernel.exception.PortalException,
304                            com.liferay.portal.kernel.exception.SystemException {
305                    return getService().getChildEntries(entryId);
306            }
307    
308            public static java.util.List<com.liferay.portlet.asset.model.AssetEntry> getCompanyEntries(
309                    long companyId, int start, int end)
310                    throws com.liferay.portal.kernel.exception.SystemException {
311                    return getService().getCompanyEntries(companyId, start, end);
312            }
313    
314            public static int getCompanyEntriesCount(long companyId)
315                    throws com.liferay.portal.kernel.exception.SystemException {
316                    return getService().getCompanyEntriesCount(companyId);
317            }
318    
319            public static com.liferay.portlet.asset.model.AssetEntryDisplay[] getCompanyEntryDisplays(
320                    long companyId, int start, int end, java.lang.String languageId)
321                    throws com.liferay.portal.kernel.exception.SystemException {
322                    return getService()
323                                       .getCompanyEntryDisplays(companyId, start, end, languageId);
324            }
325    
326            public static java.util.List<com.liferay.portlet.asset.model.AssetEntry> getEntries(
327                    com.liferay.portlet.asset.service.persistence.AssetEntryQuery entryQuery)
328                    throws com.liferay.portal.kernel.exception.SystemException {
329                    return getService().getEntries(entryQuery);
330            }
331    
332            public static int getEntriesCount(
333                    com.liferay.portlet.asset.service.persistence.AssetEntryQuery entryQuery)
334                    throws com.liferay.portal.kernel.exception.SystemException {
335                    return getService().getEntriesCount(entryQuery);
336            }
337    
338            public static com.liferay.portlet.asset.model.AssetEntry getEntry(
339                    long entryId)
340                    throws com.liferay.portal.kernel.exception.PortalException,
341                            com.liferay.portal.kernel.exception.SystemException {
342                    return getService().getEntry(entryId);
343            }
344    
345            public static com.liferay.portlet.asset.model.AssetEntry getEntry(
346                    long groupId, java.lang.String classUuid)
347                    throws com.liferay.portal.kernel.exception.PortalException,
348                            com.liferay.portal.kernel.exception.SystemException {
349                    return getService().getEntry(groupId, classUuid);
350            }
351    
352            public static com.liferay.portlet.asset.model.AssetEntry getEntry(
353                    java.lang.String className, long classPK)
354                    throws com.liferay.portal.kernel.exception.PortalException,
355                            com.liferay.portal.kernel.exception.SystemException {
356                    return getService().getEntry(className, classPK);
357            }
358    
359            public static com.liferay.portlet.asset.model.AssetEntry getNextEntry(
360                    long entryId)
361                    throws com.liferay.portal.kernel.exception.PortalException,
362                            com.liferay.portal.kernel.exception.SystemException {
363                    return getService().getNextEntry(entryId);
364            }
365    
366            public static com.liferay.portlet.asset.model.AssetEntry getParentEntry(
367                    long entryId)
368                    throws com.liferay.portal.kernel.exception.PortalException,
369                            com.liferay.portal.kernel.exception.SystemException {
370                    return getService().getParentEntry(entryId);
371            }
372    
373            public static com.liferay.portlet.asset.model.AssetEntry getPreviousEntry(
374                    long entryId)
375                    throws com.liferay.portal.kernel.exception.PortalException,
376                            com.liferay.portal.kernel.exception.SystemException {
377                    return getService().getPreviousEntry(entryId);
378            }
379    
380            public static java.util.List<com.liferay.portlet.asset.model.AssetEntry> getTopViewedEntries(
381                    java.lang.String className, boolean asc, int start, int end)
382                    throws com.liferay.portal.kernel.exception.SystemException {
383                    return getService().getTopViewedEntries(className, asc, start, end);
384            }
385    
386            public static java.util.List<com.liferay.portlet.asset.model.AssetEntry> getTopViewedEntries(
387                    java.lang.String[] className, boolean asc, int start, int end)
388                    throws com.liferay.portal.kernel.exception.SystemException {
389                    return getService().getTopViewedEntries(className, asc, start, end);
390            }
391    
392            public static com.liferay.portlet.asset.model.AssetEntry incrementViewCounter(
393                    long userId, java.lang.String className, long classPK, int increment)
394                    throws com.liferay.portal.kernel.exception.SystemException {
395                    return getService()
396                                       .incrementViewCounter(userId, className, classPK, increment);
397            }
398    
399            public static void reindex(
400                    java.util.List<com.liferay.portlet.asset.model.AssetEntry> entries)
401                    throws com.liferay.portal.kernel.exception.PortalException {
402                    getService().reindex(entries);
403            }
404    
405            public static com.liferay.portal.kernel.search.Hits search(long companyId,
406                    long[] groupIds, long userId, java.lang.String className,
407                    java.lang.String keywords, int start, int end)
408                    throws com.liferay.portal.kernel.exception.SystemException {
409                    return getService()
410                                       .search(companyId, groupIds, userId, className, keywords,
411                            start, end);
412            }
413    
414            public static com.liferay.portal.kernel.search.Hits search(long companyId,
415                    long[] groupIds, long userId, java.lang.String className,
416                    java.lang.String userName, java.lang.String title,
417                    java.lang.String description, java.lang.String assetCategoryIds,
418                    java.lang.String assetTagNames, boolean andSearch, int start, int end)
419                    throws com.liferay.portal.kernel.exception.SystemException {
420                    return getService()
421                                       .search(companyId, groupIds, userId, className, userName,
422                            title, description, assetCategoryIds, assetTagNames, andSearch,
423                            start, end);
424            }
425    
426            public static com.liferay.portal.kernel.search.Hits search(long companyId,
427                    long[] groupIds, java.lang.String className, java.lang.String keywords,
428                    int start, int end)
429                    throws com.liferay.portal.kernel.exception.SystemException {
430                    return getService()
431                                       .search(companyId, groupIds, className, keywords, start, end);
432            }
433    
434            public static com.liferay.portlet.asset.model.AssetEntryDisplay[] searchEntryDisplays(
435                    long companyId, long[] groupIds, java.lang.String className,
436                    java.lang.String keywords, java.lang.String languageId, int start,
437                    int end) throws com.liferay.portal.kernel.exception.SystemException {
438                    return getService()
439                                       .searchEntryDisplays(companyId, groupIds, className,
440                            keywords, languageId, start, end);
441            }
442    
443            public static int searchEntryDisplaysCount(long companyId, long[] groupIds,
444                    java.lang.String className, java.lang.String keywords,
445                    java.lang.String languageId)
446                    throws com.liferay.portal.kernel.exception.SystemException {
447                    return getService()
448                                       .searchEntryDisplaysCount(companyId, groupIds, className,
449                            keywords, languageId);
450            }
451    
452            public static com.liferay.portlet.asset.model.AssetEntry updateEntry(
453                    long userId, long groupId, java.lang.String className, long classPK,
454                    long[] categoryIds, java.lang.String[] tagNames)
455                    throws com.liferay.portal.kernel.exception.PortalException,
456                            com.liferay.portal.kernel.exception.SystemException {
457                    return getService()
458                                       .updateEntry(userId, groupId, className, classPK,
459                            categoryIds, tagNames);
460            }
461    
462            public static com.liferay.portlet.asset.model.AssetEntry updateEntry(
463                    long userId, long groupId, java.lang.String className, long classPK,
464                    java.lang.String classUuid, long classTypeId, long[] categoryIds,
465                    java.lang.String[] tagNames, boolean visible, java.util.Date startDate,
466                    java.util.Date endDate, java.util.Date publishDate,
467                    java.util.Date expirationDate, java.lang.String mimeType,
468                    java.lang.String title, java.lang.String description,
469                    java.lang.String summary, java.lang.String url,
470                    java.lang.String layoutUuid, int height, int width,
471                    java.lang.Integer priority, boolean sync)
472                    throws com.liferay.portal.kernel.exception.PortalException,
473                            com.liferay.portal.kernel.exception.SystemException {
474                    return getService()
475                                       .updateEntry(userId, groupId, className, classPK, classUuid,
476                            classTypeId, categoryIds, tagNames, visible, startDate, endDate,
477                            publishDate, expirationDate, mimeType, title, description, summary,
478                            url, layoutUuid, height, width, priority, sync);
479            }
480    
481            public static com.liferay.portlet.asset.model.AssetEntry updateVisible(
482                    java.lang.String className, long classPK, boolean visible)
483                    throws com.liferay.portal.kernel.exception.PortalException,
484                            com.liferay.portal.kernel.exception.SystemException {
485                    return getService().updateVisible(className, classPK, visible);
486            }
487    
488            public static void validate(long groupId, java.lang.String className,
489                    long[] categoryIds, java.lang.String[] tagNames)
490                    throws com.liferay.portal.kernel.exception.PortalException,
491                            com.liferay.portal.kernel.exception.SystemException {
492                    getService().validate(groupId, className, categoryIds, tagNames);
493            }
494    
495            public static AssetEntryLocalService getService() {
496                    if (_service == null) {
497                            _service = (AssetEntryLocalService)PortalBeanLocatorUtil.locate(AssetEntryLocalService.class.getName());
498    
499                            ReferenceRegistry.registerReference(AssetEntryLocalServiceUtil.class,
500                                    "_service");
501                            MethodCache.remove(AssetEntryLocalService.class);
502                    }
503    
504                    return _service;
505            }
506    
507            public void setService(AssetEntryLocalService service) {
508                    MethodCache.remove(AssetEntryLocalService.class);
509    
510                    _service = service;
511    
512                    ReferenceRegistry.registerReference(AssetEntryLocalServiceUtil.class,
513                            "_service");
514                    MethodCache.remove(AssetEntryLocalService.class);
515            }
516    
517            private static AssetEntryLocalService _service;
518    }