|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.bea.document.internal.DocumentDefinition
This interface embodies all the metadata about a document type. It includes the document schema (structure and usage), and the format(s) (wire format).
Constructor Summary | |
DocumentDefinition()
Create a DocumentDefinition with no name, schema, or formats. |
|
DocumentDefinition(boolean isNull)
Create a DocumentDefinition with no name, schema, or formats, and with the given null indicator. |
Method Summary | |
IDocument |
createDefaultDocument()
Create a document which conforms to the schema for this document definition, and which contains any default data for elements or attributes in the schema. |
IDocument |
createDefaultDocument(DefaultDocumentOptions options)
Using the specified options, create a new IDocument object which conforms to the structure prescribed by this schema, and contains any default values which have been specified. |
boolean |
equals(Object obj)
Compares the current DocumentDefinition to another object. |
Timestamp |
getCreatedDate()
|
String |
getDescription()
Get the description for this object. |
SOMSchema |
getDocumentSchema()
Get the document schema for this document definition. |
String |
getDocumentSchemaName()
Get the name of the document schema for this document definition. |
Timestamp |
getModifiedDate()
|
String |
getName()
Get the name of this object. |
String |
getRootElementName()
Get the root element name for this document definition. |
boolean |
isNull()
Indicates whether this IDocumentDefinition represents a null (non-existent) document. |
void |
setCreatedDate(Timestamp createdDate)
|
void |
setDescription(String desc)
Set the description for this object. |
void |
setDocumentSchema(SOMSchema schema)
Set the document schema for this document definition. |
void |
setDocumentSchemaName(String schemaName)
Set the name of the document schema for this document definition. |
void |
setModifiedDate(Timestamp modifiedDate)
|
void |
setName(String name)
Set the name of this object. |
void |
setRootElementName(String rootElementName)
Set the root element name for this document definition. |
String |
toString()
Render this document definition as a String. |
Methods inherited from class java.lang.Object |
getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public DocumentDefinition()
public DocumentDefinition(boolean isNull)
Method Detail |
public String toString()
public boolean isNull()
IDocumentDefinition
isNull
in interface IDocumentDefinition
public void setName(String name)
IDocumentDefinition
setName
in interface IDocumentDefinition
public String getName()
IDocumentDefinition
getName
in interface IDocumentDefinition
public void setDescription(String desc)
IDocumentDefinition
setDescription
in interface IDocumentDefinition
public String getDescription()
IDocumentDefinition
getDescription
in interface IDocumentDefinition
public void setCreatedDate(Timestamp createdDate)
public Timestamp getCreatedDate()
public boolean equals(Object obj)
public void setModifiedDate(Timestamp modifiedDate)
public Timestamp getModifiedDate()
public SOMSchema getDocumentSchema()
IDocumentDefinition
getDocumentSchema
in interface IDocumentDefinition
public void setDocumentSchema(SOMSchema schema)
IDocumentDefinition
setDocumentSchema
in interface IDocumentDefinition
public String getDocumentSchemaName()
getDocumentSchemaName
in interface IDocumentDefinition
public void setDocumentSchemaName(String schemaName)
setDocumentSchemaName
in interface IDocumentDefinition
public String getRootElementName()
getRootElementName
in interface IDocumentDefinition
public void setRootElementName(String rootElementName)
setRootElementName
in interface IDocumentDefinition
public IDocument createDefaultDocument() throws Exception
IDocumentDefinition
createDefaultDocument
in interface IDocumentDefinition
Exception
public IDocument createDefaultDocument(DefaultDocumentOptions options) throws Exception
IDocumentDefinition
createDefaultDocument
in interface IDocumentDefinition
Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |