001    /**
002     * Copyright (c) 2000-2013 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.bean.PortalBeanLocatorUtil;
020    import com.liferay.portal.kernel.util.ReferenceRegistry;
021    
022    /**
023     * Provides the local service utility for Image. This utility wraps
024     * {@link com.liferay.portal.service.impl.ImageLocalServiceImpl} and is the
025     * primary access point for service operations in application layer code running
026     * on the local server. Methods of this service will not have security checks
027     * based on the propagated JAAS credentials because this service can only be
028     * accessed from within the same VM.
029     *
030     * @author Brian Wing Shun Chan
031     * @see ImageLocalService
032     * @see com.liferay.portal.service.base.ImageLocalServiceBaseImpl
033     * @see com.liferay.portal.service.impl.ImageLocalServiceImpl
034     * @generated
035     */
036    @ProviderType
037    public class ImageLocalServiceUtil {
038            /*
039             * NOTE FOR DEVELOPERS:
040             *
041             * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.ImageLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
042             */
043    
044            /**
045            * Adds the image to the database. Also notifies the appropriate model listeners.
046            *
047            * @param image the image
048            * @return the image that was added
049            * @throws SystemException if a system exception occurred
050            */
051            public static com.liferay.portal.model.Image addImage(
052                    com.liferay.portal.model.Image image)
053                    throws com.liferay.portal.kernel.exception.SystemException {
054                    return getService().addImage(image);
055            }
056    
057            /**
058            * Creates a new image with the primary key. Does not add the image to the database.
059            *
060            * @param imageId the primary key for the new image
061            * @return the new image
062            */
063            public static com.liferay.portal.model.Image createImage(long imageId) {
064                    return getService().createImage(imageId);
065            }
066    
067            /**
068            * Deletes the image with the primary key from the database. Also notifies the appropriate model listeners.
069            *
070            * @param imageId the primary key of the image
071            * @return the image that was removed
072            * @throws PortalException if a image with the primary key could not be found
073            * @throws SystemException if a system exception occurred
074            */
075            public static com.liferay.portal.model.Image deleteImage(long imageId)
076                    throws com.liferay.portal.kernel.exception.PortalException,
077                            com.liferay.portal.kernel.exception.SystemException {
078                    return getService().deleteImage(imageId);
079            }
080    
081            /**
082            * Deletes the image from the database. Also notifies the appropriate model listeners.
083            *
084            * @param image the image
085            * @return the image that was removed
086            * @throws SystemException if a system exception occurred
087            */
088            public static com.liferay.portal.model.Image deleteImage(
089                    com.liferay.portal.model.Image image)
090                    throws com.liferay.portal.kernel.exception.SystemException {
091                    return getService().deleteImage(image);
092            }
093    
094            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
095                    return getService().dynamicQuery();
096            }
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            * @throws SystemException if a system exception occurred
104            */
105            @SuppressWarnings("rawtypes")
106            public static java.util.List dynamicQuery(
107                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
108                    throws com.liferay.portal.kernel.exception.SystemException {
109                    return getService().dynamicQuery(dynamicQuery);
110            }
111    
112            /**
113            * Performs a dynamic query on the database and returns a range of the matching rows.
114            *
115            * <p>
116            * 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.
117            * </p>
118            *
119            * @param dynamicQuery the dynamic query
120            * @param start the lower bound of the range of model instances
121            * @param end the upper bound of the range of model instances (not inclusive)
122            * @return the range of matching rows
123            * @throws SystemException if a system exception occurred
124            */
125            @SuppressWarnings("rawtypes")
126            public static java.util.List dynamicQuery(
127                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
128                    int end) throws com.liferay.portal.kernel.exception.SystemException {
129                    return getService().dynamicQuery(dynamicQuery, start, end);
130            }
131    
132            /**
133            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
134            *
135            * <p>
136            * 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.
137            * </p>
138            *
139            * @param dynamicQuery the dynamic query
140            * @param start the lower bound of the range of model instances
141            * @param end the upper bound of the range of model instances (not inclusive)
142            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
143            * @return the ordered range of matching rows
144            * @throws SystemException if a system exception occurred
145            */
146            @SuppressWarnings("rawtypes")
147            public static java.util.List dynamicQuery(
148                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
149                    int end,
150                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
151                    throws com.liferay.portal.kernel.exception.SystemException {
152                    return getService()
153                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
154            }
155    
156            /**
157            * Returns the number of rows that match the dynamic query.
158            *
159            * @param dynamicQuery the dynamic query
160            * @return the number of rows that match the dynamic query
161            * @throws SystemException if a system exception occurred
162            */
163            public static long dynamicQueryCount(
164                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
165                    throws com.liferay.portal.kernel.exception.SystemException {
166                    return getService().dynamicQueryCount(dynamicQuery);
167            }
168    
169            /**
170            * Returns the number of rows that match the dynamic query.
171            *
172            * @param dynamicQuery the dynamic query
173            * @param projection the projection to apply to the query
174            * @return the number of rows that match the dynamic query
175            * @throws SystemException if a system exception occurred
176            */
177            public static long dynamicQueryCount(
178                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
179                    com.liferay.portal.kernel.dao.orm.Projection projection)
180                    throws com.liferay.portal.kernel.exception.SystemException {
181                    return getService().dynamicQueryCount(dynamicQuery, projection);
182            }
183    
184            public static com.liferay.portal.model.Image fetchImage(long imageId)
185                    throws com.liferay.portal.kernel.exception.SystemException {
186                    return getService().fetchImage(imageId);
187            }
188    
189            /**
190            * Returns the image with the primary key.
191            *
192            * @param imageId the primary key of the image
193            * @return the image
194            * @throws PortalException if a image with the primary key could not be found
195            * @throws SystemException if a system exception occurred
196            */
197            public static com.liferay.portal.model.Image getImage(long imageId)
198                    throws com.liferay.portal.kernel.exception.PortalException,
199                            com.liferay.portal.kernel.exception.SystemException {
200                    return getService().getImage(imageId);
201            }
202    
203            public static com.liferay.portal.model.PersistedModel getPersistedModel(
204                    java.io.Serializable primaryKeyObj)
205                    throws com.liferay.portal.kernel.exception.PortalException,
206                            com.liferay.portal.kernel.exception.SystemException {
207                    return getService().getPersistedModel(primaryKeyObj);
208            }
209    
210            /**
211            * Returns a range of all the images.
212            *
213            * <p>
214            * 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.
215            * </p>
216            *
217            * @param start the lower bound of the range of images
218            * @param end the upper bound of the range of images (not inclusive)
219            * @return the range of images
220            * @throws SystemException if a system exception occurred
221            */
222            public static java.util.List<com.liferay.portal.model.Image> getImages(
223                    int start, int end)
224                    throws com.liferay.portal.kernel.exception.SystemException {
225                    return getService().getImages(start, end);
226            }
227    
228            /**
229            * Returns the number of images.
230            *
231            * @return the number of images
232            * @throws SystemException if a system exception occurred
233            */
234            public static int getImagesCount()
235                    throws com.liferay.portal.kernel.exception.SystemException {
236                    return getService().getImagesCount();
237            }
238    
239            /**
240            * Updates the image in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
241            *
242            * @param image the image
243            * @return the image that was updated
244            * @throws SystemException if a system exception occurred
245            */
246            public static com.liferay.portal.model.Image updateImage(
247                    com.liferay.portal.model.Image image)
248                    throws com.liferay.portal.kernel.exception.SystemException {
249                    return getService().updateImage(image);
250            }
251    
252            /**
253            * Returns the Spring bean ID for this bean.
254            *
255            * @return the Spring bean ID for this bean
256            */
257            public static java.lang.String getBeanIdentifier() {
258                    return getService().getBeanIdentifier();
259            }
260    
261            /**
262            * Sets the Spring bean ID for this bean.
263            *
264            * @param beanIdentifier the Spring bean ID for this bean
265            */
266            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
267                    getService().setBeanIdentifier(beanIdentifier);
268            }
269    
270            public static com.liferay.portal.model.Image getCompanyLogo(long imageId) {
271                    return getService().getCompanyLogo(imageId);
272            }
273    
274            public static com.liferay.portal.model.Image getImageOrDefault(long imageId) {
275                    return getService().getImageOrDefault(imageId);
276            }
277    
278            public static java.util.List<com.liferay.portal.model.Image> getImages()
279                    throws com.liferay.portal.kernel.exception.SystemException {
280                    return getService().getImages();
281            }
282    
283            public static java.util.List<com.liferay.portal.model.Image> getImagesBySize(
284                    int size) throws com.liferay.portal.kernel.exception.SystemException {
285                    return getService().getImagesBySize(size);
286            }
287    
288            public static com.liferay.portal.model.Image updateImage(long imageId,
289                    byte[] bytes)
290                    throws com.liferay.portal.kernel.exception.PortalException,
291                            com.liferay.portal.kernel.exception.SystemException {
292                    return getService().updateImage(imageId, bytes);
293            }
294    
295            public static com.liferay.portal.model.Image updateImage(long imageId,
296                    byte[] bytes, java.lang.String type, int height, int width, int size)
297                    throws com.liferay.portal.kernel.exception.PortalException,
298                            com.liferay.portal.kernel.exception.SystemException {
299                    return getService()
300                                       .updateImage(imageId, bytes, type, height, width, size);
301            }
302    
303            public static com.liferay.portal.model.Image updateImage(long imageId,
304                    java.io.File file)
305                    throws com.liferay.portal.kernel.exception.PortalException,
306                            com.liferay.portal.kernel.exception.SystemException {
307                    return getService().updateImage(imageId, file);
308            }
309    
310            public static com.liferay.portal.model.Image updateImage(long imageId,
311                    java.io.InputStream is)
312                    throws com.liferay.portal.kernel.exception.PortalException,
313                            com.liferay.portal.kernel.exception.SystemException {
314                    return getService().updateImage(imageId, is);
315            }
316    
317            public static com.liferay.portal.model.Image updateImage(long imageId,
318                    java.io.InputStream is, boolean cleanUpStream)
319                    throws com.liferay.portal.kernel.exception.PortalException,
320                            com.liferay.portal.kernel.exception.SystemException {
321                    return getService().updateImage(imageId, is, cleanUpStream);
322            }
323    
324            public static ImageLocalService getService() {
325                    if (_service == null) {
326                            _service = (ImageLocalService)PortalBeanLocatorUtil.locate(ImageLocalService.class.getName());
327    
328                            ReferenceRegistry.registerReference(ImageLocalServiceUtil.class,
329                                    "_service");
330                    }
331    
332                    return _service;
333            }
334    
335            /**
336             * @deprecated As of 6.2.0
337             */
338            public void setService(ImageLocalService service) {
339            }
340    
341            private static ImageLocalService _service;
342    }