|
BEA Systems, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The public interface for a Document.
This is the base interface for Document objects. In general, you should only typecast to this interface and not to the DocumentRemote EJB interface.
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). Document's 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.
Primary Key = com.beasys.commerce.axiom.document.DocumentPk
Attribute: description
size
modifiedBy
modifiedDate
creationDate
version
author
lockedBy
comments
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".
Search
,
DocumentPk
,
DocumentHome
,
DocumentImpl
,
DocumentValue
Fields inherited from interface com.beasys.commerce.foundation.ConfigurableEntity |
RESERVED_SCOPE_NAME |
Method Summary | |
java.lang.String |
getAuthor()
Get the identifier of the invididual who created the document. |
java.lang.String |
getComments()
Get any text comments about the document. |
byte[] |
getContent()
Return the bytes of the document's content. |
byte[] |
getContentBlock(long start,
long size)
Get a block of the bytes of the document's content. |
java.sql.Timestamp |
getCreationDate()
Get the time/date of when the document was created. |
java.lang.String |
getDescription()
Get the text description of the document. |
DocumentValue |
getDocumentByValue()
Get all of Document's attributes. |
java.lang.String |
getLockedBy()
Get the identifier of the individual who has a lock on the document. |
java.lang.String |
getModifiedBy()
Get the identifier of the individual who last modified the document. |
java.sql.Timestamp |
getModifiedDate()
Get time and date of when the document was last modified. |
java.lang.String |
getName()
Get the name of the document. |
long |
getSize()
Get the size of the document in bytes. |
long |
getVersion()
Get the version number of the document. |
void |
setAuthor(java.lang.String author)
Set the author of the document. |
void |
setComments(java.lang.String comments)
Set the comments about the document. |
void |
setCreationDate(java.sql.Timestamp creationDate)
Set the time/date of when the document was created. |
void |
setDescription(java.lang.String description)
Set the document description. |
void |
setDocumentByValue(DocumentValue value)
Set all of Document's attributes to the passed in value. |
void |
setLockedBy(java.lang.String lockedBy)
Set the who has a lock on the document. |
void |
setModifiedBy(java.lang.String modifiedBy)
Set the identifier of the individual who last modified the document. |
void |
setModifiedDate(java.sql.Timestamp modifiedDate)
Set the time/date of when the document was last modified. |
void |
setName(java.lang.String name)
Set the name of the document. |
void |
setSize(long size)
Set the size of the document. |
void |
setVersion(long version)
Set the version number. |
Methods inherited from interface com.beasys.commerce.axiom.content.Content |
getContentByValue,
getIdentifier,
getMimeType,
setContentByValue,
setMimeType |
Methods inherited from interface com.beasys.commerce.foundation.ConfigurableEntity |
addPropertyValue,
addPropertyValueMapped,
getPersistableHandle,
getProperty,
getProperty,
getPropertyAsString,
getPropertyAsString,
getPropertyDefault,
getPropertyNoDefault,
getSuccessor,
getUniqueId,
removeProperty,
removeProperty,
removePropertyValue,
removePropertyValueMapped,
removeSuccessor,
setProperty,
setProperty,
setSuccessor |
Methods inherited from interface com.beasys.commerce.foundation.BusinessPolicyManager |
addBusinessPolicy,
getBusinessPolicy,
removeBusinessPolicy |
Method Detail |
public DocumentValue getDocumentByValue() throws java.rmi.RemoteException
public void setDocumentByValue(DocumentValue value) throws java.rmi.RemoteException
DocumentValue
- the Document value objectpublic java.lang.String getDescription() throws java.rmi.RemoteException
public void setDescription(java.lang.String description) throws java.rmi.RemoteException
description
- description to be addedpublic long getSize() throws java.rmi.RemoteException
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.
public void setSize(long size) throws java.rmi.RemoteException
public java.lang.String getModifiedBy() throws java.rmi.RemoteException
public void setModifiedBy(java.lang.String modifiedBy) throws java.rmi.RemoteException
public java.sql.Timestamp getModifiedDate() throws java.rmi.RemoteException
public void setModifiedDate(java.sql.Timestamp modifiedDate) throws java.rmi.RemoteException
public java.sql.Timestamp getCreationDate() throws java.rmi.RemoteException
public void setCreationDate(java.sql.Timestamp creationDate) throws java.rmi.RemoteException
public long getVersion() throws java.rmi.RemoteException
public void setVersion(long version) throws java.rmi.RemoteException
public java.lang.String getAuthor() throws java.rmi.RemoteException
public void setAuthor(java.lang.String author) throws java.rmi.RemoteException
public java.lang.String getLockedBy() throws java.rmi.RemoteException
public void setLockedBy(java.lang.String lockedBy) throws java.rmi.RemoteException
public java.lang.String getComments() throws java.rmi.RemoteException
public void setComments(java.lang.String comments) throws java.rmi.RemoteException
public java.lang.String getName() throws java.rmi.RemoteException
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.
public void setName(java.lang.String name) throws java.rmi.RemoteException
public byte[] getContentBlock(long start, long size) throws java.rmi.RemoteException
This currently just calls getContent() and returns a subarray. However, this will support retrieving large files when large files are supported.
start
- the starting index in the byte array.size
- the number of bytes to retrieve.public byte[] getContent() throws java.rmi.RemoteException
This currently doesn't support files larger than 2^31 bytes.
|
BEA Systems, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |