DEPRECATED
com.bea.p13n.content.Content
The public interface for a Document.
This is the base interface for Document objects.
Documents are a specialized type of Content which are generally controlled by a Document Management System (DMS). The Document interface contains explicit attributes common to most types of documents and DMS's. Additionally, the Document interface has a method to retrieve the raw bytes of the actualy document itself (e.g. the images data of a GIF, the text of an HTML document). Documents inherit the identifier and mimeType attribute from the Content interface. Also, all other implicit attributes (i.e. metadata) about the document will be available.
The reference implementation document management system included in the PersonalizationServer does not support creation or modification of Documents via the EJB interfaces. However, other implementations might.
Attribute: description
Attribute: size
Attribute: modifiedBy
Attribute: modifiedDate
Attribute: creationDate
Attribute: version
Attribute: author
Attribute: lockedBy
Attribute: comments
Attribute: name
When constructing queries for Documents, the above property/attribute names will compare against the explicit attributes on the Document interface. For example, to find document whose size is less than 1024 bytes, you could use a query string like "size < 1024".
Related Topics
DocumentManager
ExpressionHelper
com.bea.p13n.content.adapter.NodeDocument
com.bea.p13n.property.ConfigurableEntity
, com.bea.p13n.content.Content
, Serializable
Field Summary |
Fields from interface com.bea.p13n.property. |
|
Method Summary |
public |
|
public |
|
public byte[] |
|
public byte[] |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public long |
|
public long |
|
public void | |
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void | |
public void |
|
public void |
|
Methods from interface com.bea.p13n.property. |
|
Methods from interface com.bea.p13n.content. |
|
Method Detail |
publicGet the identifier of the invididual who created the document.String
getAuthor()
throwsRemoteException
RemoteException
publicGet any text comments about the document.String
getComments()
throwsRemoteException
RemoteException
public byte[] getContent()Return the bytes of the document's content.
throwsRemoteException
This currently doesn't support files larger than 2^31 bytes.
RemoteException
public byte[] getContentBlock(long start, long size)Get a block of the bytes of the document's content.
throwsRemoteException
This currently just calls getContent() and returns a subarray. However, this will support retrieving large files when large files are supported.
RemoteException
publicGet the time/date of when the document was created.Timestamp
getCreationDate()
throwsRemoteException
RemoteException
publicGet the text description of the document.String
getDescription()
throwsRemoteException
RemoteException
DEPRECATED No longer needed - use Document object instead.
publicGet all of Document's attributes.DocumentValue
getDocumentByValue()
throwsRemoteException
RemoteException
publicGet the identifier of the individual who has a lock on the document.String
getLockedBy()
throwsRemoteException
RemoteException
publicGet the identifier of the individual who last modified the document.String
getModifiedBy()
throwsRemoteException
RemoteException
publicGet time and date of when the document was last modified.Timestamp
getModifiedDate()
throwsRemoteException
RemoteException
publicGet the name of the document.String
getName()
throwsRemoteException
In general, this should correspond to the original filename of the document, but is not guarenteed to. Additionally, the document's mimeType is not guarenteed to correspond to any extension on the filename.
This value should be used when prompting a user to save the file.
RemoteException
public long getSize()Get the size of the document in bytes.
throwsRemoteException
For now, since the document content itself is represented a byte array, the size returned should not be larger than Integer.MAX_VALUE. However, in the future, larger documents will be supported.
RemoteException
public long getVersion()Get the version number of the document.
throwsRemoteException
RemoteException
public void setAuthor(Set the author of the document.String
author)
throwsRemoteException
RemoteException
public void setComments(Set the comments about the document.String
comments)
throwsRemoteException
RemoteException
public void setCreationDate(Set the time/date of when the document was created.Timestamp
creationDate)
throwsRemoteException
RemoteException
public void setDescription(Set the document description.String
description)
throwsRemoteException
RemoteException
DEPRECATED Not implemented.
public void setDocumentByValue(Set all of Document's attributes to the passed in value. Note: Primary key attributes are not set.DocumentValue
value)
throwsRemoteException
RemoteException
public void setLockedBy(Set the who has a lock on the document.String
lockedBy)
throwsRemoteException
RemoteException
public void setModifiedBy(Set the identifier of the individual who last modified the document.String
modifiedBy)
throwsRemoteException
RemoteException
public void setModifiedDate(Set the time/date of when the document was last modified.Timestamp
modifiedDate)
throwsRemoteException
RemoteException
public void setName(Set the name of the document.String
name)
throwsRemoteException
RemoteException
public void setSize(long size)Set the size of the document.
throwsRemoteException
RemoteException
public void setVersion(long version)Set the version number.
throwsRemoteException
RemoteException