Nuxeo ECM Projects 5.4.3-SNAPSHOT

org.nuxeo.ecm.core.api.blobholder
Interface BlobHolder

All Known Subinterfaces:
CachableBlobHolder
All Known Implementing Classes:
AbstractBlobHolder, DocumentBlobHolder, DocumentStringBlobHolder, PictureBlobHolder, PictureBookBlobHolder, SimpleBlobHolder, SimpleBlobHolderWithProperties, SimpleCachableBlobHolder, ZipCachableBlobHolder

public interface BlobHolder

Interface for an object that holds a Blob.


Method Summary
 Blob getBlob()
          Returns the Blob held inside the object.
 List<Blob> getBlobs()
          Returns a list of blobs, if holder implementation supports multiple blobs.
 String getFilePath()
          Returns a filesystem-like path to represent the held blob.
 String getHash()
          Returns a hash for the held blob.
 Calendar getModificationDate()
          Returns the held blob modification date.
 Map<String,Serializable> getProperties()
          Returns all properties as a Map.
 Serializable getProperty(String name)
          Returns a named property.
 void setBlob(Blob blob)
          Sets a blob in the object.
 

Method Detail

getBlob

Blob getBlob()
             throws ClientException
Returns the Blob held inside the object.

Throws:
ClientException

setBlob

void setBlob(Blob blob)
             throws ClientException
Sets a blob in the object.

The underlying document must be saved by the caller.

Throws:
ClientException

getFilePath

String getFilePath()
                   throws ClientException
Returns a filesystem-like path to represent the held blob.

Throws:
ClientException

getModificationDate

Calendar getModificationDate()
                             throws ClientException
Returns the held blob modification date.

Throws:
ClientException

getHash

String getHash()
               throws ClientException
Returns a hash for the held blob.

Throws:
ClientException

getBlobs

List<Blob> getBlobs()
                    throws ClientException
Returns a list of blobs, if holder implementation supports multiple blobs.

Throws:
ClientException

getProperty

Serializable getProperty(String name)
                         throws ClientException
Returns a named property.

Throws:
ClientException

getProperties

Map<String,Serializable> getProperties()
Returns all properties as a Map.


Nuxeo ECM Projects 5.4.3-SNAPSHOT

Copyright © 2011 Nuxeo SAS. All Rights Reserved.