001    /**
002     * Copyright (c) 2000-2011 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.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            /**
150            * Returns the asset entry with the primary key.
151            *
152            * @param entryId the primary key of the asset entry
153            * @return the asset entry
154            * @throws PortalException if a asset entry with the primary key could not be found
155            * @throws SystemException if a system exception occurred
156            */
157            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
158            public com.liferay.portlet.asset.model.AssetEntry getAssetEntry(
159                    long entryId)
160                    throws com.liferay.portal.kernel.exception.PortalException,
161                            com.liferay.portal.kernel.exception.SystemException;
162    
163            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
164            public com.liferay.portal.model.PersistedModel getPersistedModel(
165                    java.io.Serializable primaryKeyObj)
166                    throws com.liferay.portal.kernel.exception.PortalException,
167                            com.liferay.portal.kernel.exception.SystemException;
168    
169            /**
170            * Returns a range of all the asset entries.
171            *
172            * <p>
173            * 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.
174            * </p>
175            *
176            * @param start the lower bound of the range of asset entries
177            * @param end the upper bound of the range of asset entries (not inclusive)
178            * @return the range of asset entries
179            * @throws SystemException if a system exception occurred
180            */
181            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
182            public java.util.List<com.liferay.portlet.asset.model.AssetEntry> getAssetEntries(
183                    int start, int end)
184                    throws com.liferay.portal.kernel.exception.SystemException;
185    
186            /**
187            * Returns the number of asset entries.
188            *
189            * @return the number of asset entries
190            * @throws SystemException if a system exception occurred
191            */
192            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
193            public int getAssetEntriesCount()
194                    throws com.liferay.portal.kernel.exception.SystemException;
195    
196            /**
197            * Updates the asset entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
198            *
199            * @param assetEntry the asset entry
200            * @return the asset entry that was updated
201            * @throws SystemException if a system exception occurred
202            */
203            public com.liferay.portlet.asset.model.AssetEntry updateAssetEntry(
204                    com.liferay.portlet.asset.model.AssetEntry assetEntry)
205                    throws com.liferay.portal.kernel.exception.SystemException;
206    
207            /**
208            * Updates the asset entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
209            *
210            * @param assetEntry the asset entry
211            * @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.
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, boolean merge)
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 java.util.List<com.liferay.portlet.asset.model.AssetEntry> getAncestorEntries(
247                    long entryId)
248                    throws com.liferay.portal.kernel.exception.PortalException,
249                            com.liferay.portal.kernel.exception.SystemException;
250    
251            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
252            public java.util.List<com.liferay.portlet.asset.model.AssetEntry> getChildEntries(
253                    long entryId)
254                    throws com.liferay.portal.kernel.exception.PortalException,
255                            com.liferay.portal.kernel.exception.SystemException;
256    
257            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
258            public java.util.List<com.liferay.portlet.asset.model.AssetEntry> getCompanyEntries(
259                    long companyId, int start, int end)
260                    throws com.liferay.portal.kernel.exception.SystemException;
261    
262            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
263            public int getCompanyEntriesCount(long companyId)
264                    throws com.liferay.portal.kernel.exception.SystemException;
265    
266            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
267            public com.liferay.portlet.asset.model.AssetEntryDisplay[] getCompanyEntryDisplays(
268                    long companyId, int start, int end, java.lang.String languageId)
269                    throws 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> getEntries(
273                    com.liferay.portlet.asset.service.persistence.AssetEntryQuery entryQuery)
274                    throws com.liferay.portal.kernel.exception.SystemException;
275    
276            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
277            public int getEntriesCount(
278                    com.liferay.portlet.asset.service.persistence.AssetEntryQuery entryQuery)
279                    throws com.liferay.portal.kernel.exception.SystemException;
280    
281            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
282            public com.liferay.portlet.asset.model.AssetEntry getEntry(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 getEntry(long groupId,
288                    java.lang.String classUuid)
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 com.liferay.portlet.asset.model.AssetEntry getEntry(
294                    java.lang.String className, long classPK)
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException;
297    
298            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
299            public com.liferay.portlet.asset.model.AssetEntry getNextEntry(long entryId)
300                    throws com.liferay.portal.kernel.exception.PortalException,
301                            com.liferay.portal.kernel.exception.SystemException;
302    
303            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
304            public com.liferay.portlet.asset.model.AssetEntry getParentEntry(
305                    long entryId)
306                    throws com.liferay.portal.kernel.exception.PortalException,
307                            com.liferay.portal.kernel.exception.SystemException;
308    
309            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
310            public com.liferay.portlet.asset.model.AssetEntry getPreviousEntry(
311                    long entryId)
312                    throws com.liferay.portal.kernel.exception.PortalException,
313                            com.liferay.portal.kernel.exception.SystemException;
314    
315            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
316            public java.util.List<com.liferay.portlet.asset.model.AssetEntry> getTopViewedEntries(
317                    java.lang.String className, boolean asc, int start, int end)
318                    throws com.liferay.portal.kernel.exception.SystemException;
319    
320            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
321            public java.util.List<com.liferay.portlet.asset.model.AssetEntry> getTopViewedEntries(
322                    java.lang.String[] className, boolean asc, int start, int end)
323                    throws com.liferay.portal.kernel.exception.SystemException;
324    
325            public void incrementViewCounter(long userId, java.lang.String className,
326                    long classPK)
327                    throws com.liferay.portal.kernel.exception.PortalException,
328                            com.liferay.portal.kernel.exception.SystemException;
329    
330            public void incrementViewCounter(long userId, java.lang.String className,
331                    long classPK, int increment)
332                    throws com.liferay.portal.kernel.exception.PortalException,
333                            com.liferay.portal.kernel.exception.SystemException;
334    
335            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
336            public com.liferay.portal.kernel.search.Hits search(long companyId,
337                    long[] groupIds, java.lang.String className, java.lang.String keywords,
338                    int start, int end)
339                    throws com.liferay.portal.kernel.exception.SystemException;
340    
341            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
342            public com.liferay.portal.kernel.search.Hits search(long companyId,
343                    long[] groupIds, long userId, java.lang.String className,
344                    java.lang.String keywords, int start, int end)
345                    throws com.liferay.portal.kernel.exception.SystemException;
346    
347            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
348            public com.liferay.portal.kernel.search.Hits search(long companyId,
349                    long[] groupIds, long userId, java.lang.String className,
350                    java.lang.String userName, java.lang.String title,
351                    java.lang.String description, java.lang.String assetCategoryIds,
352                    java.lang.String assetTagNames, boolean andSearch, int start, int end)
353                    throws com.liferay.portal.kernel.exception.SystemException;
354    
355            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
356            public com.liferay.portlet.asset.model.AssetEntryDisplay[] searchEntryDisplays(
357                    long companyId, long[] groupIds, java.lang.String className,
358                    java.lang.String keywords, java.lang.String languageId, int start,
359                    int end) throws com.liferay.portal.kernel.exception.SystemException;
360    
361            /**
362            * @deprecated {@link #searchEntryDisplays(long, long[], String, String,
363            String)}
364            */
365            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
366            public com.liferay.portlet.asset.model.AssetEntryDisplay[] searchEntryDisplays(
367                    long companyId, java.lang.String portletId, java.lang.String keywords,
368                    java.lang.String languageId, int start, int end)
369                    throws com.liferay.portal.kernel.exception.SystemException;
370    
371            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
372            public int searchEntryDisplaysCount(long companyId, long[] groupIds,
373                    java.lang.String className, java.lang.String keywords,
374                    java.lang.String languageId)
375                    throws com.liferay.portal.kernel.exception.SystemException;
376    
377            /**
378            * @deprecated {@link #searchEntryDisplaysCount(long, long[], String,
379            String, String)}
380            */
381            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
382            public int searchEntryDisplaysCount(long companyId,
383                    java.lang.String portletId, java.lang.String keywords,
384                    java.lang.String languageId)
385                    throws com.liferay.portal.kernel.exception.SystemException;
386    
387            public com.liferay.portlet.asset.model.AssetEntry updateEntry(long userId,
388                    long groupId, java.lang.String className, long classPK,
389                    long[] categoryIds, java.lang.String[] tagNames)
390                    throws com.liferay.portal.kernel.exception.PortalException,
391                            com.liferay.portal.kernel.exception.SystemException;
392    
393            public com.liferay.portlet.asset.model.AssetEntry updateEntry(long userId,
394                    long groupId, java.lang.String className, long classPK,
395                    java.lang.String classUuid, long[] categoryIds,
396                    java.lang.String[] tagNames, boolean visible, java.util.Date startDate,
397                    java.util.Date endDate, java.util.Date publishDate,
398                    java.util.Date expirationDate, java.lang.String mimeType,
399                    java.lang.String title, java.lang.String description,
400                    java.lang.String summary, java.lang.String url, int height, int width,
401                    java.lang.Integer priority, boolean sync)
402                    throws com.liferay.portal.kernel.exception.PortalException,
403                            com.liferay.portal.kernel.exception.SystemException;
404    
405            public com.liferay.portlet.asset.model.AssetEntry updateVisible(
406                    java.lang.String className, long classPK, boolean visible)
407                    throws com.liferay.portal.kernel.exception.PortalException,
408                            com.liferay.portal.kernel.exception.SystemException;
409    
410            public void validate(long groupId, java.lang.String className,
411                    long[] categoryIds, java.lang.String[] tagNames)
412                    throws com.liferay.portal.kernel.exception.PortalException,
413                            com.liferay.portal.kernel.exception.SystemException;
414    }