DEPRECATED

# com.bea.p13n.content.document.spi
DocumentMetadataDef Interface

public interface DocumentMetadataDef

The representation of a document's metadata.

All Known Implementing Classes
  `com.bea.p13n.content.document.ref.DefaultDocumentMetadata`

## Method Summary

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

## Method Detail

### getAttribute(String) Method

    public Object getAttribute(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).

#### Exceptions

``DocumentException``
  thrown on an error.

### getAttributeNames() Method

    public 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.

#### Exceptions

``DocumentException``
  thrown on an error.

### getAuthor() Method

    public String getAuthor()
         throws DocumentException

Get the identifier of the user who created the document.

#### Exceptions

``DocumentException``
  thrown on an error.

### getComments() Method

    public String getComments()
         throws DocumentException

Get any free form text comments about the document.

#### Exceptions

``DocumentException``
  thrown on an error.

### getCreationDate() Method

    public Timestamp getCreationDate()
         throws DocumentException

Get the date the document was created on.

#### Exceptions

``DocumentException``
  thrown on an error.

### getDescription() Method

    public String getDescription()
         throws DocumentException

Get a free form text description of the document.

#### Exceptions

``DocumentException``
  thrown on an error.

### getID() Method

    public String getID()
         throws DocumentException

Get the unique id of the document.

#### Exceptions

``DocumentException``
  thrown on an error.

### getLastModifiedBy() Method

    public String getLastModifiedBy()
         throws DocumentException

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

#### Exceptions

``DocumentException``
  thrown on an error.

### getLastModifiedDate() Method

    public Timestamp getLastModifiedDate()
         throws DocumentException

Get the date the document was last modified on.

#### Exceptions

``DocumentException``
  thrown on an error.

### getLockedBy() Method

    public String getLockedBy()
         throws DocumentException

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

#### Exceptions

``DocumentException``
  thrown on an error.

### getMimeType() Method

    public String getMimeType()
         throws DocumentException

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

#### Exceptions

``DocumentException``
  thrown on an error.

### getName() Method

    public String getName()
         throws DocumentException

Get the name of the document.

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

#### Exceptions

``DocumentException``
  thrown on an error.

### getSize() Method

    public long getSize()
         throws DocumentException

Get the size of the document in bytes.

#### Exceptions

``DocumentException``
  thrown on an error.

### getVersion() Method

    public int getVersion()
         throws DocumentException

Get the version number of the document.

#### Exceptions

``DocumentException``
  thrown on an error.