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.PersistedModelLocalService;
023    
024    /**
025     * The interface for the asset entry local service.
026     *
027     * <p>
028     * 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.
029     * </p>
030     *
031     * @author Brian Wing Shun Chan
032     * @see AssetEntryLocalServiceUtil
033     * @see com.liferay.portlet.asset.service.base.AssetEntryLocalServiceBaseImpl
034     * @see com.liferay.portlet.asset.service.impl.AssetEntryLocalServiceImpl
035     * @generated
036     */
037    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
038            PortalException.class, SystemException.class})
039    public interface AssetEntryLocalService extends PersistedModelLocalService {
040            /*
041             * NOTE FOR DEVELOPERS:
042             *
043             * 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.
044             */
045    
046            /**
047            * Adds the asset entry to the database. Also notifies the appropriate model listeners.
048            *
049            * @param assetEntry the asset entry
050            * @return the asset entry that was added
051            * @throws SystemException if a system exception occurred
052            */
053            public com.liferay.portlet.asset.model.AssetEntry addAssetEntry(
054                    com.liferay.portlet.asset.model.AssetEntry assetEntry)
055                    throws com.liferay.portal.kernel.exception.SystemException;
056    
057            /**
058            * Creates a new asset entry with the primary key. Does not add the asset entry to the database.
059            *
060            * @param entryId the primary key for the new asset entry
061            * @return the new asset entry
062            */
063            public com.liferay.portlet.asset.model.AssetEntry createAssetEntry(
064                    long entryId);
065    
066            /**
067            * Deletes the asset entry with the primary key from the database. Also notifies the appropriate model listeners.
068            *
069            * @param entryId the primary key of the asset entry
070            * @throws PortalException if a asset entry with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public void deleteAssetEntry(long entryId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException;
076    
077            /**
078            * Deletes the asset entry from the database. Also notifies the appropriate model listeners.
079            *
080            * @param assetEntry the asset entry
081            * @throws SystemException if a system exception occurred
082            */
083            public void deleteAssetEntry(
084                    com.liferay.portlet.asset.model.AssetEntry assetEntry)
085                    throws com.liferay.portal.kernel.exception.SystemException;
086    
087            /**
088            * Performs a dynamic query on the database and returns the matching rows.
089            *
090            * @param dynamicQuery the dynamic query
091            * @return the matching rows
092            * @throws SystemException if a system exception occurred
093            */
094            @SuppressWarnings("rawtypes")
095            public java.util.List dynamicQuery(
096                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
097                    throws com.liferay.portal.kernel.exception.SystemException;
098    
099            /**
100            * Performs a dynamic query on the database and returns a range of the matching rows.
101            *
102            * <p>
103            * 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.
104            * </p>
105            *
106            * @param dynamicQuery the dynamic query
107            * @param start the lower bound of the range of model instances
108            * @param end the upper bound of the range of model instances (not inclusive)
109            * @return the range of matching rows
110            * @throws SystemException if a system exception occurred
111            */
112            @SuppressWarnings("rawtypes")
113            public java.util.List dynamicQuery(
114                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
115                    int end) throws com.liferay.portal.kernel.exception.SystemException;
116    
117            /**
118            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
119            *
120            * <p>
121            * 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.
122            * </p>
123            *
124            * @param dynamicQuery the dynamic query
125            * @param start the lower bound of the range of model instances
126            * @param end the upper bound of the range of model instances (not inclusive)
127            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
128            * @return the ordered range of matching rows
129            * @throws SystemException if a system exception occurred
130            */
131            @SuppressWarnings("rawtypes")
132            public java.util.List dynamicQuery(
133                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
134                    int end,
135                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
136                    throws com.liferay.portal.kernel.exception.SystemException;
137    
138            /**
139            * Returns the number of rows that match the dynamic query.
140            *
141            * @param dynamicQuery the dynamic query
142            * @return the number of rows that match the dynamic query
143            * @throws SystemException if a system exception occurred
144            */
145            public long dynamicQueryCount(
146                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
147                    throws com.liferay.portal.kernel.exception.SystemException;
148    
149            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
150            public com.liferay.portlet.asset.model.AssetEntry fetchAssetEntry(
151                    long entryId)
152                    throws com.liferay.portal.kernel.exception.SystemException;
153    
154            /**
155            * Returns the asset entry with the primary key.
156            *
157            * @param entryId the primary key of the asset entry
158            * @return the asset entry
159            * @throws PortalException if a asset entry with the primary key could not be found
160            * @throws SystemException if a system exception occurred
161            */
162            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
163            public com.liferay.portlet.asset.model.AssetEntry getAssetEntry(
164                    long entryId)
165                    throws com.liferay.portal.kernel.exception.PortalException,
166                            com.liferay.portal.kernel.exception.SystemException;
167    
168            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
169            public com.liferay.portal.model.PersistedModel getPersistedModel(
170                    java.io.Serializable primaryKeyObj)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException;
173    
174            /**
175            * Returns a range of all the asset entries.
176            *
177            * <p>
178            * 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.
179            * </p>
180            *
181            * @param start the lower bound of the range of asset entries
182            * @param end the upper bound of the range of asset entries (not inclusive)
183            * @return the range of asset entries
184            * @throws SystemException if a system exception occurred
185            */
186            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
187            public java.util.List<com.liferay.portlet.asset.model.AssetEntry> getAssetEntries(
188                    int start, int end)
189                    throws com.liferay.portal.kernel.exception.SystemException;
190    
191            /**
192            * Returns the number of asset entries.
193            *
194            * @return the number of asset entries
195            * @throws SystemException if a system exception occurred
196            */
197            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
198            public int getAssetEntriesCount()
199                    throws com.liferay.portal.kernel.exception.SystemException;
200    
201            /**
202            * Updates the asset entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
203            *
204            * @param assetEntry the asset entry
205            * @return the asset entry that was updated
206            * @throws SystemException if a system exception occurred
207            */
208            public com.liferay.portlet.asset.model.AssetEntry updateAssetEntry(
209                    com.liferay.portlet.asset.model.AssetEntry assetEntry)
210                    throws com.liferay.portal.kernel.exception.SystemException;
211    
212            /**
213            * Updates the asset entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
214            *
215            * @param assetEntry the asset entry
216            * @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.
217            * @return the asset entry that was updated
218            * @throws SystemException if a system exception occurred
219            */
220            public com.liferay.portlet.asset.model.AssetEntry updateAssetEntry(
221                    com.liferay.portlet.asset.model.AssetEntry assetEntry, boolean merge)
222                    throws com.liferay.portal.kernel.exception.SystemException;
223    
224            /**
225            * Returns the Spring bean ID for this bean.
226            *
227            * @return the Spring bean ID for this bean
228            */
229            public java.lang.String getBeanIdentifier();
230    
231            /**
232            * Sets the Spring bean ID for this bean.
233            *
234            * @param beanIdentifier the Spring bean ID for this bean
235            */
236            public void setBeanIdentifier(java.lang.String beanIdentifier);
237    
238            public void deleteEntry(com.liferay.portlet.asset.model.AssetEntry entry)
239                    throws com.liferay.portal.kernel.exception.PortalException,
240                            com.liferay.portal.kernel.exception.SystemException;
241    
242            public void deleteEntry(long entryId)
243                    throws com.liferay.portal.kernel.exception.PortalException,
244                            com.liferay.portal.kernel.exception.SystemException;
245    
246            public void deleteEntry(java.lang.String className, long classPK)
247                    throws com.liferay.portal.kernel.exception.PortalException,
248                            com.liferay.portal.kernel.exception.SystemException;
249    
250            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
251            public com.liferay.portlet.asset.model.AssetEntry fetchEntry(long entryId)
252                    throws com.liferay.portal.kernel.exception.SystemException;
253    
254            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
255            public com.liferay.portlet.asset.model.AssetEntry fetchEntry(
256                    java.lang.String className, long classPK)
257                    throws com.liferay.portal.kernel.exception.SystemException;
258    
259            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
260            public java.util.List<com.liferay.portlet.asset.model.AssetEntry> getAncestorEntries(
261                    long entryId)
262                    throws com.liferay.portal.kernel.exception.PortalException,
263                            com.liferay.portal.kernel.exception.SystemException;
264    
265            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
266            public java.util.List<com.liferay.portlet.asset.model.AssetEntry> getChildEntries(
267                    long entryId)
268                    throws com.liferay.portal.kernel.exception.PortalException,
269                            com.liferay.portal.kernel.exception.SystemException;
270    
271            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
272            public java.util.List<com.liferay.portlet.asset.model.AssetEntry> getCompanyEntries(
273                    long companyId, int start, int end)
274                    throws com.liferay.portal.kernel.exception.SystemException;
275    
276            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
277            public int getCompanyEntriesCount(long companyId)
278                    throws com.liferay.portal.kernel.exception.SystemException;
279    
280            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
281            public com.liferay.portlet.asset.model.AssetEntryDisplay[] getCompanyEntryDisplays(
282                    long companyId, int start, int end, java.lang.String languageId)
283                    throws com.liferay.portal.kernel.exception.SystemException;
284    
285            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
286            public java.util.List<com.liferay.portlet.asset.model.AssetEntry> getEntries(
287                    com.liferay.portlet.asset.service.persistence.AssetEntryQuery entryQuery)
288                    throws com.liferay.portal.kernel.exception.SystemException;
289    
290            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
291            public int getEntriesCount(
292                    com.liferay.portlet.asset.service.persistence.AssetEntryQuery entryQuery)
293                    throws com.liferay.portal.kernel.exception.SystemException;
294    
295            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
296            public com.liferay.portlet.asset.model.AssetEntry getEntry(long entryId)
297                    throws com.liferay.portal.kernel.exception.PortalException,
298                            com.liferay.portal.kernel.exception.SystemException;
299    
300            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
301            public com.liferay.portlet.asset.model.AssetEntry getEntry(long groupId,
302                    java.lang.String classUuid)
303                    throws com.liferay.portal.kernel.exception.PortalException,
304                            com.liferay.portal.kernel.exception.SystemException;
305    
306            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
307            public com.liferay.portlet.asset.model.AssetEntry getEntry(
308                    java.lang.String className, long classPK)
309                    throws com.liferay.portal.kernel.exception.PortalException,
310                            com.liferay.portal.kernel.exception.SystemException;
311    
312            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
313            public com.liferay.portlet.asset.model.AssetEntry getNextEntry(long entryId)
314                    throws com.liferay.portal.kernel.exception.PortalException,
315                            com.liferay.portal.kernel.exception.SystemException;
316    
317            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
318            public com.liferay.portlet.asset.model.AssetEntry getParentEntry(
319                    long entryId)
320                    throws com.liferay.portal.kernel.exception.PortalException,
321                            com.liferay.portal.kernel.exception.SystemException;
322    
323            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
324            public com.liferay.portlet.asset.model.AssetEntry getPreviousEntry(
325                    long entryId)
326                    throws com.liferay.portal.kernel.exception.PortalException,
327                            com.liferay.portal.kernel.exception.SystemException;
328    
329            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
330            public java.util.List<com.liferay.portlet.asset.model.AssetEntry> getTopViewedEntries(
331                    java.lang.String className, boolean asc, int start, int end)
332                    throws com.liferay.portal.kernel.exception.SystemException;
333    
334            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
335            public java.util.List<com.liferay.portlet.asset.model.AssetEntry> getTopViewedEntries(
336                    java.lang.String[] className, boolean asc, int start, int end)
337                    throws com.liferay.portal.kernel.exception.SystemException;
338    
339            public com.liferay.portlet.asset.model.AssetEntry incrementViewCounter(
340                    long userId, java.lang.String className, long classPK, int increment)
341                    throws com.liferay.portal.kernel.exception.SystemException;
342    
343            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
344            public void reindex(
345                    java.util.List<com.liferay.portlet.asset.model.AssetEntry> entries)
346                    throws com.liferay.portal.kernel.exception.PortalException;
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 start, int end)
352                    throws com.liferay.portal.kernel.exception.SystemException;
353    
354            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
355            public com.liferay.portal.kernel.search.Hits search(long companyId,
356                    long[] groupIds, long userId, java.lang.String className,
357                    java.lang.String userName, java.lang.String title,
358                    java.lang.String description, java.lang.String assetCategoryIds,
359                    java.lang.String assetTagNames, boolean andSearch, int start, int end)
360                    throws com.liferay.portal.kernel.exception.SystemException;
361    
362            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
363            public com.liferay.portal.kernel.search.Hits search(long companyId,
364                    long[] groupIds, java.lang.String className, java.lang.String keywords,
365                    int start, int end)
366                    throws com.liferay.portal.kernel.exception.SystemException;
367    
368            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
369            public com.liferay.portlet.asset.model.AssetEntryDisplay[] searchEntryDisplays(
370                    long companyId, long[] groupIds, java.lang.String className,
371                    java.lang.String keywords, java.lang.String languageId, int start,
372                    int end) throws com.liferay.portal.kernel.exception.SystemException;
373    
374            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
375            public int searchEntryDisplaysCount(long companyId, long[] groupIds,
376                    java.lang.String className, java.lang.String keywords,
377                    java.lang.String languageId)
378                    throws com.liferay.portal.kernel.exception.SystemException;
379    
380            public com.liferay.portlet.asset.model.AssetEntry updateEntry(long userId,
381                    long groupId, java.lang.String className, long classPK,
382                    long[] categoryIds, java.lang.String[] tagNames)
383                    throws com.liferay.portal.kernel.exception.PortalException,
384                            com.liferay.portal.kernel.exception.SystemException;
385    
386            public com.liferay.portlet.asset.model.AssetEntry updateEntry(long userId,
387                    long groupId, java.lang.String className, long classPK,
388                    java.lang.String classUuid, long classTypeId, long[] categoryIds,
389                    java.lang.String[] tagNames, boolean visible, java.util.Date startDate,
390                    java.util.Date endDate, java.util.Date publishDate,
391                    java.util.Date expirationDate, java.lang.String mimeType,
392                    java.lang.String title, java.lang.String description,
393                    java.lang.String summary, java.lang.String url,
394                    java.lang.String layoutUuid, int height, int width,
395                    java.lang.Integer priority, boolean sync)
396                    throws com.liferay.portal.kernel.exception.PortalException,
397                            com.liferay.portal.kernel.exception.SystemException;
398    
399            public com.liferay.portlet.asset.model.AssetEntry updateVisible(
400                    java.lang.String className, long classPK, boolean visible)
401                    throws com.liferay.portal.kernel.exception.PortalException,
402                            com.liferay.portal.kernel.exception.SystemException;
403    
404            public void validate(long groupId, java.lang.String className,
405                    long[] categoryIds, java.lang.String[] tagNames)
406                    throws com.liferay.portal.kernel.exception.PortalException,
407                            com.liferay.portal.kernel.exception.SystemException;
408    }