public interface IPhotoGalleryAdapter extends IServiceAdapter
Implementations of this interface must ensure that the following properties can be retrieved from the IConfigManager implementation being used in the application's AdapterEnvironment:
Property: /config/soccom/adapter/impl/<name>/photoGallery
Value: A string that contains the fully qualified name of the class that implements the IPhotoGalleryAdapter interface.
Where: <name> is the short name used to identify this implementation.
Example: /config/soccom/adapter/impl/pluck/photoGallery = "com.ibm.commerce.soccom.pluck.PhotoGalleryAdapterImpl"
Modifier and Type | Field and Description |
---|---|
static java.lang.String | COPYRIGHT
Copy Right Statement
|
Modifier and Type | Method and Description |
---|---|
java.lang.String | createComment(java.lang.String galleryHandle, java.lang.String photoId, java.lang.String body)
Creates a comment for the photo identified by galleryHandle and photoId.
|
java.lang.String | createPhoto(java.lang.String galleryHandle, java.lang.String fileName, java.lang.String filePath, java.lang.String contentType, java.lang.String title, java.lang.String description, java.util.List<java.lang.String> tags)
Creates a photo that belongs to the photo gallery identified by galleryHandle.
|
java.lang.String | deletePhoto(java.lang.String galleryHandle, java.lang.String photoId)
Deletes the photo identified by galleryHandle and photoId.
|
java.util.Map<java.lang.String,java.lang.Object> | fetchComment(java.lang.String galleryHandle, java.lang.String photoId, java.lang.String commentId)
Retrieves the photo comment identified by galleryHandle, photoId, and commentId
|
java.util.Map<java.lang.String,java.lang.Object> | fetchGallery(java.lang.String galleryHandle, int pageSize, int onPage, java.util.List<java.util.Map<java.lang.String,java.lang.String>> sortOptions)
Retrieves the photo gallery identified by galleryHandle.
|
java.util.Map<java.lang.String,java.lang.Object> | fetchPhoto(java.lang.String galleryHandle, java.lang.String photoId)
Retrieves the photo identified by galleryHandle and photoId
|
java.util.Map<java.lang.String,java.lang.Object> | listComments(java.lang.String galleryHandle, java.lang.String photoId, int pageSize, int onPage)
Lists the photo comments identified by photoId.
|
void | recommendPhoto(java.lang.String galleryHandle, java.lang.String photoId)
Recommends the photo identified by galleryHandle and photoId.
|
void | reportInappropriatePhoto(java.lang.String galleryHandle, java.lang.String photoId, java.lang.String reason)
Flags the photo identified by galleryHandle and photoId as inappropriate.
|
java.util.Map<java.lang.String,java.lang.Object> | searchPhotosByUsername(java.lang.String username, int pageSize, int onPage, java.util.List<java.util.Map<java.lang.String,java.lang.String>> sortOptions)
Retrieves a collection of photos created by the user identified by username
|
static final java.lang.String COPYRIGHT
java.util.Map<java.lang.String,java.lang.Object> fetchGallery(java.lang.String galleryHandle, int pageSize, int onPage, java.util.List<java.util.Map<java.lang.String,java.lang.String>> sortOptions) throws AdapterException
java.lang.String createPhoto(java.lang.String galleryHandle, java.lang.String fileName, java.lang.String filePath, java.lang.String contentType, java.lang.String title, java.lang.String description, java.util.List<java.lang.String> tags) throws AdapterException
java.util.Map<java.lang.String,java.lang.Object> fetchPhoto(java.lang.String galleryHandle, java.lang.String photoId) throws AdapterException
java.util.Map<java.lang.String,java.lang.Object> searchPhotosByUsername(java.lang.String username, int pageSize, int onPage, java.util.List<java.util.Map<java.lang.String,java.lang.String>> sortOptions) throws AdapterException
java.lang.String deletePhoto(java.lang.String galleryHandle, java.lang.String photoId) throws AdapterException
java.lang.String createComment(java.lang.String galleryHandle, java.lang.String photoId, java.lang.String body) throws AdapterException
java.util.Map<java.lang.String,java.lang.Object> listComments(java.lang.String galleryHandle, java.lang.String photoId, int pageSize, int onPage) throws AdapterException
java.util.Map<java.lang.String,java.lang.Object> fetchComment(java.lang.String galleryHandle, java.lang.String photoId, java.lang.String commentId) throws AdapterException
void recommendPhoto(java.lang.String galleryHandle, java.lang.String photoId) throws AdapterException
void reportInappropriatePhoto(java.lang.String galleryHandle, java.lang.String photoId, java.lang.String reason) throws AdapterException