|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RenditionCapability
Interface representing capability of storing renditions. Renditions are different versions of an resource. Examples are thumbnails or smaller versions of the image for mobile devices. The image rendition is part of the encapsulating resource (has the same UUID), but can be addressed by a unique URL.
Method Summary | |
---|---|
Rendition |
createRendition(java.lang.String renditionName,
java.lang.String resourceName,
byte[] resourceBytes)
Create a new rendition and add it to this Resource. |
Rendition |
createRendition(java.lang.String renditionName,
java.lang.String resourceName,
java.io.File resourceFile)
Create a new rendition and add it to this Resource. |
Rendition |
getRendition(java.lang.String renditionName)
Get rendition with the given name. |
java.util.List<Rendition> |
getRenditions()
Get a list of all renditions defined for this resource. |
void |
removeRendition(java.lang.String renditionName)
Remove renditions with the given resource name. |
Method Detail |
---|
java.util.List<Rendition> getRenditions()
Rendition createRendition(java.lang.String renditionName, java.lang.String resourceName, byte[] resourceBytes) throws com.ibm.workplace.wcm.api.exceptions.OperationFailedException, java.lang.IllegalArgumentException
renditionName
- the new rendition name, must not be null
.resourceName
- the new rendition resource name, must not be null
.resourceBytes
- the content of the resource file as a byte array, , must not be null
.
com.ibm.workplace.wcm.api.exceptions.OperationFailedException
- if the resource file could not be set
java.lang.IllegalArgumentException
- If a rendition with the given Resource Name
already exists, or the name is null
.Rendition createRendition(java.lang.String renditionName, java.lang.String resourceName, java.io.File resourceFile) throws com.ibm.workplace.wcm.api.exceptions.OperationFailedException, java.lang.IllegalArgumentException
renditionName
- the new rendition name, must not be null
.resourceName
- the new rendition resource name, must not be null
.resourceFile
- the contents of the resource as a file on the file system, must not be null
.
com.ibm.workplace.wcm.api.exceptions.OperationFailedException
- if the resource file could not be set
java.lang.IllegalArgumentException
- If a rendition with the given Resource Name
already exists, or the name is null
.Rendition getRendition(java.lang.String renditionName) throws java.lang.IllegalArgumentException
renditionName
- the name of the rendition, must not be null
.
null
if a rendition with the given name was not found.
java.lang.IllegalArgumentException
- If the name is null
.void removeRendition(java.lang.String renditionName) throws java.lang.IllegalArgumentException
renditionName
- name of the rendition to be removed.
java.lang.IllegalArgumentException
- If rendition with the given Resource name does
not exist
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |