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.exception.PortalException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.kernel.transaction.Isolation;
020    import com.liferay.portal.kernel.transaction.Propagation;
021    import com.liferay.portal.kernel.transaction.Transactional;
022    import com.liferay.portal.service.BaseLocalService;
023    import com.liferay.portal.service.PersistedModelLocalService;
024    
025    /**
026     * The interface for the asset entry local service.
027     *
028     * <p>
029     * 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.
030     * </p>
031     *
032     * @author Brian Wing Shun Chan
033     * @see AssetEntryLocalServiceUtil
034     * @see com.liferay.portlet.asset.service.base.AssetEntryLocalServiceBaseImpl
035     * @see com.liferay.portlet.asset.service.impl.AssetEntryLocalServiceImpl
036     * @generated
037     */
038    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
039            PortalException.class, SystemException.class})
040    public interface AssetEntryLocalService extends BaseLocalService,
041            PersistedModelLocalService {
042            /*
043             * NOTE FOR DEVELOPERS:
044             *
045             * Never modify or reference this interface directly. Always use {@link AssetEntryLocalServiceUtil} to access the asset entry local service. Add custom service methods to {@link com.liferay.portlet.asset.service.impl.AssetEntryLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
046             */
047    
048            /**
049            * Adds the asset entry to the database. Also notifies the appropriate model listeners.
050            *
051            * @param assetEntry the asset entry
052            * @return the asset entry that was added
053            * @throws SystemException if a system exception occurred
054            */
055            public com.liferay.portlet.asset.model.AssetEntry addAssetEntry(
056                    com.liferay.portlet.asset.model.AssetEntry assetEntry)
057                    throws com.liferay.portal.kernel.exception.SystemException;
058    
059            /**
060            * Creates a new asset entry with the primary key. Does not add the asset entry to the database.
061            *
062            * @param entryId the primary key for the new asset entry
063            * @return the new asset entry
064            */
065            public com.liferay.portlet.asset.model.AssetEntry createAssetEntry(
066                    long entryId);
067    
068            /**
069            * Deletes the asset entry with the primary key from the database. Also notifies the appropriate model listeners.
070            *
071            * @param entryId the primary key of the asset entry
072            * @return the asset entry that was removed
073            * @throws PortalException if a asset entry with the primary key could not be found
074            * @throws SystemException if a system exception occurred
075            */
076            public com.liferay.portlet.asset.model.AssetEntry deleteAssetEntry(
077                    long entryId)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException;
080    
081            /**
082            * Deletes the asset entry from the database. Also notifies the appropriate model listeners.
083            *
084            * @param assetEntry the asset entry
085            * @return the asset entry that was removed
086            * @throws SystemException if a system exception occurred
087            */
088            public com.liferay.portlet.asset.model.AssetEntry deleteAssetEntry(
089                    com.liferay.portlet.asset.model.AssetEntry assetEntry)
090                    throws com.liferay.portal.kernel.exception.SystemException;
091    
092            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
093    
094            /**
095            * Performs a dynamic query on the database and returns the matching rows.
096            *
097            * @param dynamicQuery the dynamic query
098            * @return the matching rows
099            * @throws SystemException if a system exception occurred
100            */
101            @SuppressWarnings("rawtypes")
102            public java.util.List dynamicQuery(
103                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
104                    throws com.liferay.portal.kernel.exception.SystemException;
105    
106            /**
107            * Performs a dynamic query on the database and returns a range of the matching rows.
108            *
109            * <p>
110            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.asset.model.impl.AssetEntryModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
111            * </p>
112            *
113            * @param dynamicQuery the dynamic query
114            * @param start the lower bound of the range of model instances
115            * @param end the upper bound of the range of model instances (not inclusive)
116            * @return the range of matching rows
117            * @throws SystemException if a system exception occurred
118            */
119            @SuppressWarnings("rawtypes")
120            public java.util.List dynamicQuery(
121                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
122                    int end) throws com.liferay.portal.kernel.exception.SystemException;
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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.asset.model.impl.AssetEntryModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
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 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    
145            /**
146            * Returns the number of rows that match the dynamic query.
147            *
148            * @param dynamicQuery the dynamic query
149            * @return the number of rows that match the dynamic query
150            * @throws SystemException if a system exception occurred
151            */
152            public long dynamicQueryCount(
153                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
154                    throws com.liferay.portal.kernel.exception.SystemException;
155    
156            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
157            public com.liferay.portlet.asset.model.AssetEntry fetchAssetEntry(
158                    long entryId)
159                    throws com.liferay.portal.kernel.exception.SystemException;
160    
161            /**
162            * Returns the asset entry with the primary key.
163            *
164            * @param entryId the primary key of the asset entry
165            * @return the asset entry
166            * @throws PortalException if a asset entry with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170            public com.liferay.portlet.asset.model.AssetEntry getAssetEntry(
171                    long entryId)
172                    throws com.liferay.portal.kernel.exception.PortalException,
173                            com.liferay.portal.kernel.exception.SystemException;
174    
175            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
176            public 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    
181            /**
182            * Returns a range of all the asset entries.
183            *
184            * <p>
185            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.asset.model.impl.AssetEntryModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
186            * </p>
187            *
188            * @param start the lower bound of the range of asset entries
189            * @param end the upper bound of the range of asset entries (not inclusive)
190            * @return the range of asset entries
191            * @throws SystemException if a system exception occurred
192            */
193            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
194            public java.util.List<com.liferay.portlet.asset.model.AssetEntry> getAssetEntries(
195                    int start, int end)
196                    throws com.liferay.portal.kernel.exception.SystemException;
197    
198            /**
199            * Returns the number of asset entries.
200            *
201            * @return the number of asset entries
202            * @throws SystemException if a system exception occurred
203            */
204            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
205            public int getAssetEntriesCount()
206                    throws com.liferay.portal.kernel.exception.SystemException;
207    
208            /**
209            * Updates the asset entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
210            *
211            * @param assetEntry the asset entry
212            * @return the asset entry that was updated
213            * @throws SystemException if a system exception occurred
214            */
215            public com.liferay.portlet.asset.model.AssetEntry updateAssetEntry(
216                    com.liferay.portlet.asset.model.AssetEntry assetEntry)
217                    throws com.liferay.portal.kernel.exception.SystemException;
218    
219            /**
220            * Returns the Spring bean ID for this bean.
221            *
222            * @return the Spring bean ID for this bean
223            */
224            public java.lang.String getBeanIdentifier();
225    
226            /**
227            * Sets the Spring bean ID for this bean.
228            *
229            * @param beanIdentifier the Spring bean ID for this bean
230            */
231            public void setBeanIdentifier(java.lang.String beanIdentifier);
232    
233            public void deleteEntry(com.liferay.portlet.asset.model.AssetEntry entry)
234                    throws com.liferay.portal.kernel.exception.PortalException,
235                            com.liferay.portal.kernel.exception.SystemException;
236    
237            public void deleteEntry(long entryId)
238                    throws com.liferay.portal.kernel.exception.PortalException,
239                            com.liferay.portal.kernel.exception.SystemException;
240    
241            public void deleteEntry(java.lang.String className, long classPK)
242                    throws com.liferay.portal.kernel.exception.PortalException,
243                            com.liferay.portal.kernel.exception.SystemException;
244    
245            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
246            public com.liferay.portlet.asset.model.AssetEntry fetchEntry(long entryId)
247                    throws com.liferay.portal.kernel.exception.SystemException;
248    
249            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
250            public com.liferay.portlet.asset.model.AssetEntry fetchEntry(
251                    java.lang.String className, long classPK)
252                    throws com.liferay.portal.kernel.exception.SystemException;
253    
254            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
255            public java.util.List<com.liferay.portlet.asset.model.AssetEntry> getAncestorEntries(
256                    long entryId)
257                    throws com.liferay.portal.kernel.exception.PortalException,
258                            com.liferay.portal.kernel.exception.SystemException;
259    
260            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
261            public java.util.List<com.liferay.portlet.asset.model.AssetEntry> getChildEntries(
262                    long entryId)
263                    throws com.liferay.portal.kernel.exception.PortalException,
264                            com.liferay.portal.kernel.exception.SystemException;
265    
266            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
267            public java.util.List<com.liferay.portlet.asset.model.AssetEntry> getCompanyEntries(
268                    long companyId, int start, int end)
269                    throws com.liferay.portal.kernel.exception.SystemException;
270    
271            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
272            public int getCompanyEntriesCount(long companyId)
273                    throws com.liferay.portal.kernel.exception.SystemException;
274    
275            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
276            public java.util.List<com.liferay.portlet.asset.model.AssetEntry> getEntries(
277                    com.liferay.portlet.asset.service.persistence.AssetEntryQuery entryQuery)
278                    throws com.liferay.portal.kernel.exception.SystemException;
279    
280            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
281            public int getEntriesCount(
282                    com.liferay.portlet.asset.service.persistence.AssetEntryQuery entryQuery)
283                    throws com.liferay.portal.kernel.exception.SystemException;
284    
285            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
286            public com.liferay.portlet.asset.model.AssetEntry getEntry(long entryId)
287                    throws com.liferay.portal.kernel.exception.PortalException,
288                            com.liferay.portal.kernel.exception.SystemException;
289    
290            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
291            public com.liferay.portlet.asset.model.AssetEntry getEntry(long groupId,
292                    java.lang.String classUuid)
293                    throws com.liferay.portal.kernel.exception.PortalException,
294                            com.liferay.portal.kernel.exception.SystemException;
295    
296            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
297            public com.liferay.portlet.asset.model.AssetEntry getEntry(
298                    java.lang.String className, long classPK)
299                    throws com.liferay.portal.kernel.exception.PortalException,
300                            com.liferay.portal.kernel.exception.SystemException;
301    
302            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
303            public com.liferay.portlet.asset.model.AssetEntry getNextEntry(long entryId)
304                    throws com.liferay.portal.kernel.exception.PortalException,
305                            com.liferay.portal.kernel.exception.SystemException;
306    
307            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
308            public com.liferay.portlet.asset.model.AssetEntry getParentEntry(
309                    long entryId)
310                    throws com.liferay.portal.kernel.exception.PortalException,
311                            com.liferay.portal.kernel.exception.SystemException;
312    
313            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
314            public com.liferay.portlet.asset.model.AssetEntry getPreviousEntry(
315                    long entryId)
316                    throws com.liferay.portal.kernel.exception.PortalException,
317                            com.liferay.portal.kernel.exception.SystemException;
318    
319            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
320            public java.util.List<com.liferay.portlet.asset.model.AssetEntry> getTopViewedEntries(
321                    java.lang.String className, boolean asc, int start, int end)
322                    throws com.liferay.portal.kernel.exception.SystemException;
323    
324            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
325            public java.util.List<com.liferay.portlet.asset.model.AssetEntry> getTopViewedEntries(
326                    java.lang.String[] className, boolean asc, int start, int end)
327                    throws com.liferay.portal.kernel.exception.SystemException;
328    
329            public com.liferay.portlet.asset.model.AssetEntry incrementViewCounter(
330                    long userId, java.lang.String className, long classPK, int increment)
331                    throws com.liferay.portal.kernel.exception.SystemException;
332    
333            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
334            public void reindex(
335                    java.util.List<com.liferay.portlet.asset.model.AssetEntry> entries)
336                    throws com.liferay.portal.kernel.exception.PortalException;
337    
338            /**
339            * @deprecated {@link #search(long, long[], long, String, String, int, int,
340            int)}
341            */
342            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
343            public com.liferay.portal.kernel.search.Hits search(long companyId,
344                    long[] groupIds, long userId, java.lang.String className,
345                    java.lang.String keywords, int start, int end)
346                    throws com.liferay.portal.kernel.exception.SystemException;
347    
348            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
349            public com.liferay.portal.kernel.search.Hits search(long companyId,
350                    long[] groupIds, long userId, java.lang.String className,
351                    java.lang.String keywords, int status, int start, int end)
352                    throws com.liferay.portal.kernel.exception.SystemException;
353    
354            /**
355            * @deprecated {@link #search(long, long[], long, String, String, String,
356            String, String, String, int, boolean, int, int)}
357            */
358            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
359            public com.liferay.portal.kernel.search.Hits search(long companyId,
360                    long[] groupIds, long userId, java.lang.String className,
361                    java.lang.String userName, java.lang.String title,
362                    java.lang.String description, java.lang.String assetCategoryIds,
363                    java.lang.String assetTagNames, boolean andSearch, int start, int end)
364                    throws com.liferay.portal.kernel.exception.SystemException;
365    
366            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
367            public com.liferay.portal.kernel.search.Hits search(long companyId,
368                    long[] groupIds, long userId, java.lang.String className,
369                    java.lang.String userName, java.lang.String title,
370                    java.lang.String description, java.lang.String assetCategoryIds,
371                    java.lang.String assetTagNames, int status, boolean andSearch,
372                    int start, int end)
373                    throws com.liferay.portal.kernel.exception.SystemException;
374    
375            /**
376            * @deprecated {@link #search(long, long[], long, String, String, int, int,
377            int)}
378            */
379            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
380            public com.liferay.portal.kernel.search.Hits search(long companyId,
381                    long[] groupIds, java.lang.String className, java.lang.String keywords,
382                    int start, int end)
383                    throws com.liferay.portal.kernel.exception.SystemException;
384    
385            public com.liferay.portlet.asset.model.AssetEntry updateEntry(long userId,
386                    long groupId, java.util.Date createDate, java.util.Date modifiedDate,
387                    java.lang.String className, long classPK, java.lang.String classUuid,
388                    long classTypeId, long[] categoryIds, java.lang.String[] tagNames,
389                    boolean visible, java.util.Date startDate, java.util.Date endDate,
390                    java.util.Date expirationDate, java.lang.String mimeType,
391                    java.lang.String title, java.lang.String description,
392                    java.lang.String summary, java.lang.String url,
393                    java.lang.String layoutUuid, int height, int width,
394                    java.lang.Integer priority, boolean sync)
395                    throws com.liferay.portal.kernel.exception.PortalException,
396                            com.liferay.portal.kernel.exception.SystemException;
397    
398            public com.liferay.portlet.asset.model.AssetEntry updateEntry(long userId,
399                    long groupId, java.lang.String className, long classPK,
400                    long[] categoryIds, java.lang.String[] tagNames)
401                    throws com.liferay.portal.kernel.exception.PortalException,
402                            com.liferay.portal.kernel.exception.SystemException;
403    
404            /**
405            * @deprecated {@link #updateEntry(long, long, String, long, String, long,
406            long[], String[], boolean, Date, Date, Date, String, String,
407            String, String, String, String, int, int, Integer, boolean)}
408            */
409            public com.liferay.portlet.asset.model.AssetEntry updateEntry(long userId,
410                    long groupId, java.lang.String className, long classPK,
411                    java.lang.String classUuid, long classTypeId, long[] categoryIds,
412                    java.lang.String[] tagNames, boolean visible, java.util.Date startDate,
413                    java.util.Date endDate, java.util.Date publishDate,
414                    java.util.Date expirationDate, java.lang.String mimeType,
415                    java.lang.String title, java.lang.String description,
416                    java.lang.String summary, java.lang.String url,
417                    java.lang.String layoutUuid, int height, int width,
418                    java.lang.Integer priority, boolean sync)
419                    throws com.liferay.portal.kernel.exception.PortalException,
420                            com.liferay.portal.kernel.exception.SystemException;
421    
422            /**
423            * @deprecated {@link #updateEntry(long, long, Date, Date, String, long,
424            String, long, long[], String[], boolean, Date, Date, Date,
425            String, String, String, String, String, String, int, int,
426            Integer, boolean)}
427            */
428            public com.liferay.portlet.asset.model.AssetEntry updateEntry(long userId,
429                    long groupId, java.lang.String className, long classPK,
430                    java.lang.String classUuid, long classTypeId, long[] categoryIds,
431                    java.lang.String[] tagNames, boolean visible, java.util.Date startDate,
432                    java.util.Date endDate, java.util.Date expirationDate,
433                    java.lang.String mimeType, java.lang.String title,
434                    java.lang.String description, java.lang.String summary,
435                    java.lang.String url, java.lang.String layoutUuid, int height,
436                    int width, java.lang.Integer priority, boolean sync)
437                    throws com.liferay.portal.kernel.exception.PortalException,
438                            com.liferay.portal.kernel.exception.SystemException;
439    
440            public com.liferay.portlet.asset.model.AssetEntry updateEntry(
441                    java.lang.String className, long classPK, java.util.Date publishDate,
442                    boolean visible)
443                    throws com.liferay.portal.kernel.exception.PortalException,
444                            com.liferay.portal.kernel.exception.SystemException;
445    
446            public com.liferay.portlet.asset.model.AssetEntry updateEntry(
447                    java.lang.String className, long classPK, java.util.Date publishDate,
448                    java.util.Date expirationDate, boolean visible)
449                    throws com.liferay.portal.kernel.exception.PortalException,
450                            com.liferay.portal.kernel.exception.SystemException;
451    
452            public com.liferay.portlet.asset.model.AssetEntry updateVisible(
453                    java.lang.String className, long classPK, boolean visible)
454                    throws com.liferay.portal.kernel.exception.PortalException,
455                            com.liferay.portal.kernel.exception.SystemException;
456    
457            public void validate(long groupId, java.lang.String className,
458                    long[] categoryIds, java.lang.String[] tagNames)
459                    throws com.liferay.portal.kernel.exception.PortalException,
460                            com.liferay.portal.kernel.exception.SystemException;
461    }