001    /**
002     * Copyright (c) 2000-present 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.portal.service;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.exception.PortalException;
020    import com.liferay.portal.kernel.exception.SystemException;
021    import com.liferay.portal.kernel.search.IndexableType;
022    import com.liferay.portal.kernel.transaction.Isolation;
023    import com.liferay.portal.kernel.transaction.Propagation;
024    import com.liferay.portal.kernel.transaction.Transactional;
025    
026    /**
027     * Provides the local service interface for Image. Methods of this
028     * service will not have security checks based on the propagated JAAS
029     * credentials because this service can only be accessed from within the same
030     * VM.
031     *
032     * @author Brian Wing Shun Chan
033     * @see ImageLocalServiceUtil
034     * @see com.liferay.portal.service.base.ImageLocalServiceBaseImpl
035     * @see com.liferay.portal.service.impl.ImageLocalServiceImpl
036     * @generated
037     */
038    @ProviderType
039    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
040            PortalException.class, SystemException.class})
041    public interface ImageLocalService extends BaseLocalService,
042            PersistedModelLocalService {
043            /*
044             * NOTE FOR DEVELOPERS:
045             *
046             * Never modify or reference this interface directly. Always use {@link ImageLocalServiceUtil} to access the image local service. Add custom service methods to {@link com.liferay.portal.service.impl.ImageLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
047             */
048    
049            /**
050            * Adds the image to the database. Also notifies the appropriate model listeners.
051            *
052            * @param image the image
053            * @return the image that was added
054            */
055            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
056            public com.liferay.portal.model.Image addImage(
057                    com.liferay.portal.model.Image image);
058    
059            /**
060            * Creates a new image with the primary key. Does not add the image to the database.
061            *
062            * @param imageId the primary key for the new image
063            * @return the new image
064            */
065            public com.liferay.portal.model.Image createImage(long imageId);
066    
067            /**
068            * Deletes the image from the database. Also notifies the appropriate model listeners.
069            *
070            * @param image the image
071            * @return the image that was removed
072            */
073            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
074            public com.liferay.portal.model.Image deleteImage(
075                    com.liferay.portal.model.Image image);
076    
077            /**
078            * Deletes the image with the primary key from the database. Also notifies the appropriate model listeners.
079            *
080            * @param imageId the primary key of the image
081            * @return the image that was removed
082            * @throws PortalException if a image with the primary key could not be found
083            */
084            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
085            public com.liferay.portal.model.Image deleteImage(long imageId)
086                    throws PortalException;
087    
088            /**
089            * @throws PortalException
090            */
091            @Override
092            public com.liferay.portal.model.PersistedModel deletePersistedModel(
093                    com.liferay.portal.model.PersistedModel persistedModel)
094                    throws PortalException;
095    
096            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
097    
098            /**
099            * Performs a dynamic query on the database and returns the matching rows.
100            *
101            * @param dynamicQuery the dynamic query
102            * @return the matching rows
103            */
104            public <T> java.util.List<T> dynamicQuery(
105                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
106    
107            /**
108            * Performs a dynamic query on the database and returns a range of the matching rows.
109            *
110            * <p>
111            * 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.portal.model.impl.ImageModelImpl}. 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.
112            * </p>
113            *
114            * @param dynamicQuery the dynamic query
115            * @param start the lower bound of the range of model instances
116            * @param end the upper bound of the range of model instances (not inclusive)
117            * @return the range of matching rows
118            */
119            public <T> java.util.List<T> dynamicQuery(
120                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
121                    int end);
122    
123            /**
124            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
125            *
126            * <p>
127            * 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.portal.model.impl.ImageModelImpl}. 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.
128            * </p>
129            *
130            * @param dynamicQuery the dynamic query
131            * @param start the lower bound of the range of model instances
132            * @param end the upper bound of the range of model instances (not inclusive)
133            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
134            * @return the ordered range of matching rows
135            */
136            public <T> java.util.List<T> dynamicQuery(
137                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
138                    int end,
139                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
140    
141            /**
142            * Returns the number of rows matching the dynamic query.
143            *
144            * @param dynamicQuery the dynamic query
145            * @return the number of rows matching the dynamic query
146            */
147            public long dynamicQueryCount(
148                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
149    
150            /**
151            * Returns the number of rows matching the dynamic query.
152            *
153            * @param dynamicQuery the dynamic query
154            * @param projection the projection to apply to the query
155            * @return the number of rows matching the dynamic query
156            */
157            public long dynamicQueryCount(
158                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
159                    com.liferay.portal.kernel.dao.orm.Projection projection);
160    
161            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
162            public com.liferay.portal.model.Image fetchImage(long imageId);
163    
164            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
165            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
166    
167            /**
168            * Returns the Spring bean ID for this bean.
169            *
170            * @return the Spring bean ID for this bean
171            */
172            public java.lang.String getBeanIdentifier();
173    
174            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
175            public com.liferay.portal.model.Image getCompanyLogo(long imageId);
176    
177            /**
178            * Returns the image with the primary key.
179            *
180            * @param imageId the primary key of the image
181            * @return the image
182            * @throws PortalException if a image with the primary key could not be found
183            */
184            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
185            public com.liferay.portal.model.Image getImage(long imageId)
186                    throws PortalException;
187    
188            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
189            public com.liferay.portal.model.Image getImageOrDefault(long imageId);
190    
191            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
192            public java.util.List<com.liferay.portal.model.Image> getImages();
193    
194            /**
195            * Returns a range of all the images.
196            *
197            * <p>
198            * 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.portal.model.impl.ImageModelImpl}. 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.
199            * </p>
200            *
201            * @param start the lower bound of the range of images
202            * @param end the upper bound of the range of images (not inclusive)
203            * @return the range of images
204            */
205            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
206            public java.util.List<com.liferay.portal.model.Image> getImages(int start,
207                    int end);
208    
209            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
210            public java.util.List<com.liferay.portal.model.Image> getImagesBySize(
211                    int size);
212    
213            /**
214            * Returns the number of images.
215            *
216            * @return the number of images
217            */
218            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
219            public int getImagesCount();
220    
221            @Override
222            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
223            public com.liferay.portal.model.PersistedModel getPersistedModel(
224                    java.io.Serializable primaryKeyObj) throws PortalException;
225    
226            public com.liferay.portal.model.Image moveImage(long imageId, byte[] bytes)
227                    throws PortalException;
228    
229            /**
230            * Sets the Spring bean ID for this bean.
231            *
232            * @param beanIdentifier the Spring bean ID for this bean
233            */
234            public void setBeanIdentifier(java.lang.String beanIdentifier);
235    
236            /**
237            * Updates the image in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
238            *
239            * @param image the image
240            * @return the image that was updated
241            */
242            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
243            public com.liferay.portal.model.Image updateImage(
244                    com.liferay.portal.model.Image image);
245    
246            public com.liferay.portal.model.Image updateImage(long imageId, byte[] bytes)
247                    throws PortalException;
248    
249            public com.liferay.portal.model.Image updateImage(long imageId,
250                    byte[] bytes, java.lang.String type, int height, int width, int size)
251                    throws PortalException;
252    
253            public com.liferay.portal.model.Image updateImage(long imageId,
254                    java.io.File file) throws PortalException;
255    
256            public com.liferay.portal.model.Image updateImage(long imageId,
257                    java.io.InputStream is) throws PortalException;
258    
259            public com.liferay.portal.model.Image updateImage(long imageId,
260                    java.io.InputStream is, boolean cleanUpStream)
261                    throws PortalException;
262    }