com.beasys.commerce.axiom.document.spi
Interface DocumentMetadataDef

All Known Implementing Classes:

DefaultDocumentMetadata

public interface DocumentMetadataDef

The representation of a document's metadata.

Method Summary

java.lang.Object	getAttribute(java.lang.String attributeName) Return the value of the named attribute.
java.util.Collection	getAttributeNames() Return the list of all the attribute names in this metedata.
java.lang.String	getAuthor() Get the identifier of the user who created the document.
java.lang.String	getComments() Get any free form text comments about the document.
java.sql.Timestamp	getCreationDate() Get the date the document was created on.
java.lang.String	getDescription() Get a free form text description of the document.
java.lang.String	getID() Get the unique id of the document.
java.lang.String	getLastModifiedBy() Get the identifier of the user who last modified the document.
java.sql.Timestamp	getLastModifiedDate() Get the date the document was last modified on.
java.lang.String	getLockedBy() Get the identifier of the user who has the document locked (null if not locked).
java.lang.String	getMimeType() Get the mime type of the document, in "major/minor" MIME format (e.g.
java.lang.String	getName() Get the name of the document.
long	getSize() Get the size of the document in bytes.
int	getVersion() Get the version number of the document.

Method Detail

getAttribute

public java.lang.Object getAttribute(java.lang.String attributeName)
                              throws DocumentException

Return the value of the named attribute.

If the attribute is multi-valued, this can be a Collection. Otherwise, it will be a String, Number, Boolean, or Timestamp.

This only needs to return values for attributes that do not correspond to a get method on this interface.

Parameters:

attributeName - the name of the attribute.

Returns:

the value of the attribute (null if not set).

Throws:

DocumentException - thrown on an error.

getAttributeNames

public java.util.Collection getAttributeNames()
                                       throws DocumentException

Return the list of all the attribute names in this metedata.

This is not the list of all the possible values for this document (that comes from the DocumentSchemaDef).

Returns:

the list of String attribute names.

Throws:

DocumentException - thrown on an error.

getID

public java.lang.String getID()
                       throws DocumentException

Get the unique id of the document.

Throws:

DocumentException - thrown on an error.

getName

public java.lang.String getName()
                         throws DocumentException

Get the name of the document.

This will generally correspond to the original file name of the document.

Throws:

DocumentException - thrown on an error.

getVersion

public int getVersion()
               throws DocumentException

Get the version number of the document.

Throws:

DocumentException - thrown on an error.

getLockedBy

public java.lang.String getLockedBy()
                             throws DocumentException

Get the identifier of the user who has the document locked (null if not locked).

Throws:

DocumentException - thrown on an error.

getSize

public long getSize()
             throws DocumentException

Get the size of the document in bytes.

Throws:

DocumentException - thrown on an error.

getAuthor

public java.lang.String getAuthor()
                           throws DocumentException

Get the identifier of the user who created the document.

Throws:

DocumentException - thrown on an error.

getCreationDate

public java.sql.Timestamp getCreationDate()
                                   throws DocumentException

Get the date the document was created on.

Throws:

DocumentException - thrown on an error.

getLastModifiedBy

public java.lang.String getLastModifiedBy()
                                   throws DocumentException

Get the identifier of the user who last modified the document.

Throws:

DocumentException - thrown on an error.

getLastModifiedDate

public java.sql.Timestamp getLastModifiedDate()
                                       throws DocumentException

Get the date the document was last modified on.

Throws:

DocumentException - thrown on an error.

getDescription

public java.lang.String getDescription()
                                throws DocumentException

Get a free form text description of the document.

Throws:

DocumentException - thrown on an error.

getComments

public java.lang.String getComments()
                             throws DocumentException

Get any free form text comments about the document.

Throws:

DocumentException - thrown on an error.

getMimeType

public java.lang.String getMimeType()
                             throws DocumentException

Get the mime type of the document, in "major/minor" MIME format (e.g. "text/html", "application/x-banner-ad").

Throws:

DocumentException - thrown on an error.