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