|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A base interface for all WLAI descriptors, providing for XML input/output and Serialize ability.
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(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(String xml)
Parse the given XML into the currect descriptor, replacing all contents of the current descriptor with the new XML data. |
String |
getDescription()
Return a description of the object that this descriptor represents and the service's intended use. |
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(String description)
Set the description of the object that this descriptor represents and its intended use. |
void |
setName(String name)
Set the name of the service this object represents. |
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(Writer writer)
Write an XML representation of this descriptor to the given Writer. |
Method Detail |
public String getName()
public void setName(String name) throws IllegalArgumentException
name
- The name of the object this descriptor represents. Null is
not allowed.
IllegalArgumentException
- If the name parameter is null.public String getDescription()
public void setDescription(String description)
description
- A description of the object that this
descriptor represents and its intended use, or null if no
description is known.public String toXML() throws DocumentException
DocumentException
- If any error occurs while processing the XML
for this descriptor.public void toXML(Writer writer) throws DocumentException, IOException
DocumentException
- If any error occurs while processing the XML
for this descriptor.
IOException
- If an error occurs writing to the given Writer.public void toXML(IDocument doc) throws DocumentException
doc
- An IDocument instance to receive the data for this descriptor.
DocumentException
- If any error occurs while processing the XML
for this descriptor.public void fromXML(String xml) throws DocumentParseException, DocumentException
DocumentParseException
- If any error occurs while parsing the XML
for this descriptor.
DocumentException
- If any error occurs while processing the XML
for this descriptor.public void fromXML(Reader reader) throws DocumentParseException, DocumentException, IOException
DocumentParseException
- If any error occurs while parsing the XML
for this descriptor.
DocumentException
- If any error occurs while processing the XML
for this descriptor.
IOException
- If an error occurs reading from the given Reader.public void fromXML(IDocument doc) throws DocumentException
doc
- An IDocument instance from which the data for this descriptor
will be extracted.
DocumentException
- If any error occurs while processing the XML
for this descriptor.public boolean isReadOnly()
public void makeReadOnly()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |