001 /** 002 * Copyright (c) 2000-2010 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.portal.service; 016 017 import com.liferay.portal.kernel.annotation.Isolation; 018 import com.liferay.portal.kernel.annotation.Propagation; 019 import com.liferay.portal.kernel.annotation.Transactional; 020 import com.liferay.portal.kernel.exception.PortalException; 021 import com.liferay.portal.kernel.exception.SystemException; 022 023 /** 024 * The interface for the image local service. 025 * 026 * <p> 027 * 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. 028 * </p> 029 * 030 * <p> 031 * 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. 032 * </p> 033 * 034 * @author Brian Wing Shun Chan 035 * @see ImageLocalServiceUtil 036 * @see com.liferay.portal.service.base.ImageLocalServiceBaseImpl 037 * @see com.liferay.portal.service.impl.ImageLocalServiceImpl 038 * @generated 039 */ 040 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 041 PortalException.class, SystemException.class}) 042 public interface ImageLocalService { 043 /** 044 * Adds the image to the database. Also notifies the appropriate model listeners. 045 * 046 * @param image the image to add 047 * @return the image that was added 048 * @throws SystemException if a system exception occurred 049 */ 050 public com.liferay.portal.model.Image addImage( 051 com.liferay.portal.model.Image image) 052 throws com.liferay.portal.kernel.exception.SystemException; 053 054 /** 055 * Creates a new image with the primary key. Does not add the image to the database. 056 * 057 * @param imageId the primary key for the new image 058 * @return the new image 059 */ 060 public com.liferay.portal.model.Image createImage(long imageId); 061 062 /** 063 * Deletes the image with the primary key from the database. Also notifies the appropriate model listeners. 064 * 065 * @param imageId the primary key of the image to delete 066 * @throws PortalException if a image with the primary key could not be found 067 * @throws SystemException if a system exception occurred 068 */ 069 public void deleteImage(long imageId) 070 throws com.liferay.portal.kernel.exception.PortalException, 071 com.liferay.portal.kernel.exception.SystemException; 072 073 /** 074 * Deletes the image from the database. Also notifies the appropriate model listeners. 075 * 076 * @param image the image to delete 077 * @throws SystemException if a system exception occurred 078 */ 079 public void deleteImage(com.liferay.portal.model.Image image) 080 throws com.liferay.portal.kernel.exception.SystemException; 081 082 /** 083 * Performs a dynamic query on the database and returns the matching rows. 084 * 085 * @param dynamicQuery the dynamic query to search with 086 * @return the matching rows 087 * @throws SystemException if a system exception occurred 088 */ 089 @SuppressWarnings("rawtypes") 090 public java.util.List dynamicQuery( 091 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 092 throws com.liferay.portal.kernel.exception.SystemException; 093 094 /** 095 * Performs a dynamic query on the database and returns a range of the matching rows. 096 * 097 * <p> 098 * 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. 099 * </p> 100 * 101 * @param dynamicQuery the dynamic query to search with 102 * @param start the lower bound of the range of model instances to return 103 * @param end the upper bound of the range of model instances to return (not inclusive) 104 * @return the range of matching rows 105 * @throws SystemException if a system exception occurred 106 */ 107 @SuppressWarnings("rawtypes") 108 public java.util.List dynamicQuery( 109 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 110 int end) throws com.liferay.portal.kernel.exception.SystemException; 111 112 /** 113 * Performs a dynamic query on the database and returns an ordered 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. 117 * </p> 118 * 119 * @param dynamicQuery the dynamic query to search with 120 * @param start the lower bound of the range of model instances to return 121 * @param end the upper bound of the range of model instances to return (not inclusive) 122 * @param orderByComparator the comparator to order the results by 123 * @return the ordered range of matching rows 124 * @throws SystemException if a system exception occurred 125 */ 126 @SuppressWarnings("rawtypes") 127 public java.util.List dynamicQuery( 128 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 129 int end, 130 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 131 throws com.liferay.portal.kernel.exception.SystemException; 132 133 /** 134 * Counts the number of rows that match the dynamic query. 135 * 136 * @param dynamicQuery the dynamic query to search with 137 * @return the number of rows that match the dynamic query 138 * @throws SystemException if a system exception occurred 139 */ 140 public long dynamicQueryCount( 141 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 142 throws com.liferay.portal.kernel.exception.SystemException; 143 144 /** 145 * Gets the image with the primary key. 146 * 147 * @param imageId the primary key of the image to get 148 * @return the image 149 * @throws PortalException if a image with the primary key could not be found 150 * @throws SystemException if a system exception occurred 151 */ 152 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 153 public com.liferay.portal.model.Image getImage(long imageId) 154 throws com.liferay.portal.kernel.exception.PortalException, 155 com.liferay.portal.kernel.exception.SystemException; 156 157 /** 158 * Gets a range of all the images. 159 * 160 * <p> 161 * 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. 162 * </p> 163 * 164 * @param start the lower bound of the range of images to return 165 * @param end the upper bound of the range of images to return (not inclusive) 166 * @return the range of images 167 * @throws SystemException if a system exception occurred 168 */ 169 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 170 public java.util.List<com.liferay.portal.model.Image> getImages(int start, 171 int end) throws com.liferay.portal.kernel.exception.SystemException; 172 173 /** 174 * Gets the number of images. 175 * 176 * @return the number of images 177 * @throws SystemException if a system exception occurred 178 */ 179 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 180 public int getImagesCount() 181 throws com.liferay.portal.kernel.exception.SystemException; 182 183 /** 184 * Updates the image in the database. Also notifies the appropriate model listeners. 185 * 186 * @param image the image to update 187 * @return the image that was updated 188 * @throws SystemException if a system exception occurred 189 */ 190 public com.liferay.portal.model.Image updateImage( 191 com.liferay.portal.model.Image image) 192 throws com.liferay.portal.kernel.exception.SystemException; 193 194 /** 195 * Updates the image in the database. Also notifies the appropriate model listeners. 196 * 197 * @param image the image to update 198 * @param merge whether to merge the image 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. 199 * @return the image that was updated 200 * @throws SystemException if a system exception occurred 201 */ 202 public com.liferay.portal.model.Image updateImage( 203 com.liferay.portal.model.Image image, boolean merge) 204 throws com.liferay.portal.kernel.exception.SystemException; 205 206 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 207 public com.liferay.portal.model.Image getCompanyLogo(long imageId); 208 209 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 210 public com.liferay.portal.model.Image getDefaultCompanyLogo(); 211 212 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 213 public com.liferay.portal.model.Image getDefaultOrganizationLogo(); 214 215 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 216 public com.liferay.portal.model.Image getDefaultSpacer(); 217 218 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 219 public com.liferay.portal.model.Image getDefaultUserFemalePortrait(); 220 221 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 222 public com.liferay.portal.model.Image getDefaultUserMalePortrait(); 223 224 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 225 public com.liferay.portal.model.Image getImage(byte[] bytes) 226 throws com.liferay.portal.kernel.exception.PortalException, 227 com.liferay.portal.kernel.exception.SystemException; 228 229 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 230 public com.liferay.portal.model.Image getImage(java.io.File file) 231 throws com.liferay.portal.kernel.exception.PortalException, 232 com.liferay.portal.kernel.exception.SystemException; 233 234 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 235 public com.liferay.portal.model.Image getImage(java.io.InputStream is) 236 throws com.liferay.portal.kernel.exception.PortalException, 237 com.liferay.portal.kernel.exception.SystemException; 238 239 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 240 public com.liferay.portal.model.Image getImageOrDefault(long imageId); 241 242 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 243 public java.util.List<com.liferay.portal.model.Image> getImages() 244 throws com.liferay.portal.kernel.exception.SystemException; 245 246 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 247 public java.util.List<com.liferay.portal.model.Image> getImagesBySize( 248 int size) throws com.liferay.portal.kernel.exception.SystemException; 249 250 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 251 public boolean isNullOrDefaultSpacer(byte[] bytes); 252 253 public com.liferay.portal.model.Image updateImage(long imageId, byte[] bytes) 254 throws com.liferay.portal.kernel.exception.PortalException, 255 com.liferay.portal.kernel.exception.SystemException; 256 257 public com.liferay.portal.model.Image updateImage(long imageId, 258 java.io.File file) 259 throws com.liferay.portal.kernel.exception.PortalException, 260 com.liferay.portal.kernel.exception.SystemException; 261 262 public com.liferay.portal.model.Image updateImage(long imageId, 263 java.io.InputStream is) 264 throws com.liferay.portal.kernel.exception.PortalException, 265 com.liferay.portal.kernel.exception.SystemException; 266 267 public com.liferay.portal.model.Image updateImage(long imageId, 268 byte[] bytes, java.lang.String type, int height, int width, int size) 269 throws com.liferay.portal.kernel.exception.PortalException, 270 com.liferay.portal.kernel.exception.SystemException; 271 }