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