ImageUploadable.java

package org.opentides.bean;

import java.util.List;

import org.opentides.service.BaseCrudService;
import org.opentides.web.controller.ImageController;
import org.opentides.web.json.Views;
import org.springframework.web.multipart.MultipartFile;

import com.fasterxml.jackson.annotation.JsonView;

/**
 * Interface for entities that can be uploaded with images. 
 * 
 * <p>The controller {@link ImageController}
 * can already be use to handle basic image processing like image upload and cropping. But note
 * that the Photoable entity needs to extend {@link BaseEntity} and create its own implementation
 * of {@link BaseCrudService} to be able to use it.</p>
 * 
 * @author AJ
 * @author gino
 */
public interface ImageUploadable {

	/**
	 * Get all {@link ImageInfo} objects attached to the entity
	 * 
	 * @return a list of ImageInfo objects
	 */
	@JsonView(Views.FormView.class)
	List<ImageInfo> getImages();

	/**
	 * Gets the primary photo. 
	 * You may want to consider using isPrimary field of ImageInfo.
	 * 
	 * @return
	 */
	@JsonView(Views.SearchView.class)
	ImageInfo getPrimaryImage();

	/**
	 * Required upon form submit, should be a transient variable.
	 * 
	 * @return
	 */
	MultipartFile getImage();

	/**
	 * Add {@link ImageInfo} object to the list of photos.
	 * 
	 * @param image
	 */
	void addImage(ImageInfo image);

}