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