|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.novell.nds.dirxml.driver.xds.ElementImpl
com.novell.nds.dirxml.driver.xds.XDSStatusElement
A <status>
element.
StatusDocument.appendStatusElement()
,
StatusDocument.appendStatusElement()
,
QueryResultDocument.extractStatusElements(java.lang.String)
Method Summary | |
void |
appendText(String someText)
Appends a single, child text node containing someText to
this element. |
int |
compareTo(Object someStatus)
Compares this level to someStatus . |
void |
descriptionAppend(String someText)
Appends a child <description> element to this
element. |
DescriptionElement |
descriptionElementExtract()
Returns this element's child <description> element. |
String |
descriptionTextExtract()
Returns the concatenated child text nodes from this element's child <description> element. |
void |
documentAppend(com.novell.nds.dirxml.driver.XmlDocument xml)
Appends a child <document> element to this element. |
void |
exceptionAppend(Exception e,
boolean stack)
Appends a child <exception> element to this element. |
void |
exceptionAppend(Throwable t,
boolean stack)
Appends a child <exception> element to this element. |
String |
extractText()
Returns the concatenated child text nodes of this element. |
String |
getEventID()
Gets the value of this element's event-id attribute. |
StatusLevel |
getLevel()
Gets the value of this element's level attribute. |
StatusType |
getType()
Gets the value of this element's type attribute. |
void |
parametersAppend(Map params)
Appends a child <parameters> element to this element
containing the Parameter s in params . |
void |
setEventID(String someID)
Sets this element's event-id attribute to
someID . |
void |
setLevel(StatusLevel someLevel)
Sets this element's level attribute to
someLevel . |
void |
setType(StatusType someType)
Sets this element's type attribute to
someType . |
Methods inherited from class com.novell.nds.dirxml.driver.xds.ElementImpl |
attributeValueGet, attributeValueGet, attributeValueSet, childElements, documentImpl, domDocument, domElement, localName, namespaceName, position, tagName |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.novell.nds.dirxml.driver.xds.XDSElement |
attributeValueGet, attributeValueGet, attributeValueSet, childElements, domDocument, domElement, localName, namespaceName, position, tagName |
Method Detail |
public String extractText()
TextParent
extractText
in interface TextParent
null
; will not return ""
public StatusType getType()
type
attribute.
null
public StatusLevel getLevel()
level
attribute.
null
public String getEventID()
event-id
attribute.
null
; will not return ""
public DescriptionElement descriptionElementExtract()
<description>
element.
null
public String descriptionTextExtract()
<description>
element.
null
; will not return ""
public void setLevel(StatusLevel someLevel)
level
attribute to
someLevel
.
someLevel
- if null
, no action is takenpublic void setType(StatusType someType)
type
attribute to
someType
.
someType
- if null
, no action is takenpublic void setEventID(String someID)
event-id
attribute to
someID
.
someID
- if null
or ""
, no action is
takenpublic void appendText(String someText)
TextParent
someText
to
this element.
appendText
in interface TextParent
someText
- the text being appended; if null
or
""
, no action is takenpublic void parametersAppend(Map params)
<parameters>
element to this element
containing the Parameter
s in params
.
This method is useful for displaying the parameter values a driver is
using in the status document returned from
init(XmlDocument)
params
- must not be null
public void descriptionAppend(String someText)
<description>
element to this
element. The <description>
element contains the text
someText
.
someText
- if null
or ""
, no action is
takenpublic void documentAppend(com.novell.nds.dirxml.driver.XmlDocument xml)
<document>
element to this element.
The <document;gt;
element contains the element in
xml
.
xml
- if null
or ""
, an empty
<document>
is appendedpublic void exceptionAppend(Exception e, boolean stack)
<exception>
element to this element.
The <exception>
element contains the text
someText
.
e
- if null
, no action is takenstack
- append stack trace?public void exceptionAppend(Throwable t, boolean stack)
<exception>
element to this element.
The <exception>
element contains the text
someText
.
t
- if null
, no action is takenstack
- append stack trace?public int compareTo(Object someStatus)
someStatus
.
compareTo
in interface Comparable
someStatus
- may be null
; this element is greater than
null
XDS.LESS_THAN
:someStatus
XDS.EQUAL
:someStatus
XDS.GREATER_THAN
:someStatus
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |