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