com.bea.wlai.common
Interface IDescriptor

All Known Subinterfaces:

IApplicationViewDescriptor, IConnectionFactoryDescriptor, IDocumentDescriptor, IEventDescriptor, IPropertiedDescriptor, IServiceDescriptor

All Known Implementing Classes:

AbstractDescriptor

public interface IDescriptor

extends java.io.Serializable

A base interface for all WLAI descriptors, providing for XML input/output and Serialize ability.

Author:

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

Method Summary

void	fromXML(IDocument doc) Extract the data for this descriptor from the given IDocument instance, replacing all contents of the current descriptor with the new data.
void	fromXML(java.io.Reader reader) Parse the XML from the given Reader into the currect descriptor, replacing all contents of the current descriptor with the new XML data.
void	fromXML(java.lang.String xml) Parse the given XML into the currect descriptor, replacing all contents of the current descriptor with the new XML data.
java.lang.String	getDescription() Return a description of the object that this descriptor represents and the service's intended use.
java.lang.String	getName() Get the name of the object this descriptor represents.
boolean	isReadOnly() Returns true if the user is not authorized to modify this object.
void	makeReadOnly() Makes this object immutable
void	setDescription(java.lang.String description) Set the description of the object that this descriptor represents and its intended use.
void	setName(java.lang.String name) Set the name of the service this object represents.
java.lang.String	toXML() Get an XML representation of this descriptor.
void	toXML(IDocument doc) Output an XML representation of this descriptor into an IDocument instance.
void	toXML(java.io.Writer writer) Write an XML representation of this descriptor to the given Writer.

Method Detail

getName

public java.lang.String getName()

Get the name of the object this descriptor represents.

Returns:

The name of the object this descriptor represents.

setName

public void setName(java.lang.String name)
             throws java.lang.IllegalArgumentException

Set the name of the service this object represents.

Parameters:

name - The name of the object this descriptor represents. Null is not allowed.

Throws:

java.lang.IllegalArgumentException - If the name parameter is null.

getDescription

public java.lang.String getDescription()

Return a description of the object that this descriptor represents and the service's intended use.

Returns:

A description of this object and its intended use, or null if no description has been set.

setDescription

public void setDescription(java.lang.String description)

Set the description of the object that this descriptor represents and its intended use.

Parameters:

description - A description of the object that this descriptor represents and its intended use, or null if no description is known.

toXML

public java.lang.String toXML()
                       throws DocumentException

Get an XML representation of this descriptor.

Returns:

An XML string containing the data for this descriptor.

Throws:

DocumentException - If any error occurs while processing the XML for this descriptor.

toXML

public void toXML(java.io.Writer writer)
           throws DocumentException,
                  java.io.IOException

Write an XML representation of this descriptor to the given Writer.

Parameters:

A - Writer object representing the destination for an XML stream containing the data for this descriptor.

Throws:

DocumentException - If any error occurs while processing the XML for this descriptor.

java.io.IOException - If an error occurs writing to the given Writer.

toXML

public void toXML(IDocument doc)
           throws DocumentException

Output an XML representation of this descriptor into an IDocument instance.

Parameters:

doc - An IDocument instance to receive the data for this descriptor.

Throws:

DocumentException - If any error occurs while processing the XML for this descriptor.

fromXML

public void fromXML(java.lang.String xml)
             throws DocumentParseException,
                    DocumentException

Parse the given XML into the currect descriptor, replacing all contents of the current descriptor with the new XML data.

Parameters:

An - XML string containing the data for this descriptor.

Throws:

DocumentParseException - If any error occurs while parsing the XML for this descriptor.

DocumentException - If any error occurs while processing the XML for this descriptor.

fromXML

public void fromXML(java.io.Reader reader)
             throws DocumentParseException,
                    DocumentException,
                    java.io.IOException

Parse the XML from the given Reader into the currect descriptor, replacing all contents of the current descriptor with the new XML data.

Parameters:

An - Reader object representing the source for an XML stream containing the data for this descriptor.

Throws:

DocumentParseException - If any error occurs while parsing the XML for this descriptor.

DocumentException - If any error occurs while processing the XML for this descriptor.

java.io.IOException - If an error occurs reading from the given Reader.

fromXML

public void fromXML(IDocument doc)
             throws DocumentException

Extract the data for this descriptor from the given IDocument instance, replacing all contents of the current descriptor with the new data.

Parameters:

doc - An IDocument instance from which the data for this descriptor will be extracted.

Throws:

DocumentException - If any error occurs while processing the XML for this descriptor.

isReadOnly

public boolean isReadOnly()

Returns true if the user is not authorized to modify this object.

makeReadOnly

public void makeReadOnly()

Makes this object immutable