com.bea.wlai.common
Interface IDocumentDescriptor

All Superinterfaces:

IDescriptor, Serializable

public interface IDocumentDescriptor
extends IDescriptor, Serializable

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

Method Summary

QualifiedName	getQualifiedName() Get the qualified name corresponding to this document descriptor.
String	getRootElementName() Get the name of the root element for the documents of this type.
String	getSchemaNameString() Get the name of the schema for the document type represented by this descriptor.
boolean	isNull() Indicates whether this IDocumentDescriptor represents a null (non-existent) document.
void	setRootElementName(String name) Set the name of the root element for the documents of this type.
void	setSchemaNameString(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, getDescription, getName, isReadOnly, makeReadOnly, setDescription, setName, toXML, toXML

Method Detail

isNull

boolean isNull()

Indicates whether this IDocumentDescriptor represents a null (non-existent) document. If this method returns true, no meaningful return values can be given from the getSchemaNameString() or getRootElementName() methods (they will throw IllegalStateException).
A document descriptor for a null document might be used to indicate that no request or resonse is provided from an ApplicationView service.

getSchemaNameString

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. If this method is called on an object for which isNull() returns true, this throws an IllegalStateException.

Returns:

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

setSchemaNameString

void setSchemaNameString(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. If this method is called on an object for which isNull() returns true, this method does nothing.

Parameters:

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

getRootElementName

String getRootElementName()

Get the name of the root element for the documents of this type. If this method is called on an object for which isNull() returns true, this throws an IllegalStateException.

Returns:

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

setRootElementName

void setRootElementName(String name)

Set the name of the root element for the documents of this type. If this method is called on an object for which isNull() returns true, this method does nothing.

Parameters:

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

getQualifiedName

QualifiedName getQualifiedName()

Get the qualified name corresponding to this document descriptor.

Returns:

A QualifiedName object containing the qualified name.