com.bea.wlai.common
Interface IDocumentDescriptor

All Known Implementing Classes:

DocumentDescriptor

public interface IDocumentDescriptor

extends IDescriptor, java.io.Serializable

This is an interface describing a class of documents that all conform to the same schema, and have the same root element name.

Author:

Copyright © 2000, 2001 BEA Systems, Inc. All Rights Reserved.

Method Summary

QualifiedName	getQualifiedName() Get the qualified name corresponding to this document descriptor.
java.lang.String	getRootElementName() Get the name of the root element for the documents of this type.
java.lang.String	getSchemaNameString() Get the name of the schema for the document type represented by this descriptor.
void	setRootElementName(java.lang.String name) Set the name of the root element for the documents of this type.
void	setSchemaNameString(java.lang.String name) Set the name of the schema for the document type represented by this descriptor.

Methods inherited from interface com.bea.wlai.common.IDescriptor

fromXML, fromXML, fromXML, getDescription, getName, isReadOnly, makeReadOnly, setDescription, setName, toXML, toXML, toXML

Method Detail

getSchemaNameString

public java.lang.String getSchemaNameString()

Get the name of the schema for the document type represented by this descriptor. The schema defines the structure and content of the documents of this type.

Returns:

The name of the schema for the document type for this descriptor.

setSchemaNameString

public void setSchemaNameString(java.lang.String name)

Set the name of the schema for the document type represented by this descriptor. The schema defines the structure and content of the documents of this type.

Parameters:

name - The name of the schema for the document type for this descriptor.

getRootElementName

public java.lang.String getRootElementName()

Get the name of the root element for the documents of this type.

Returns:

The name of the root element present in the documents of this type.

setRootElementName

public void setRootElementName(java.lang.String name)

Set the name of the root element for the documents of this type.

Parameters:

name - The name of the root element present in the documents of this type.

getQualifiedName

public QualifiedName getQualifiedName()

Get the qualified name corresponding to this document descriptor.

Returns:

A QualifiedName object containing the qualified name.