com.novell.nds.dirxml.driver.xds
Interface ParamParent

All Superinterfaces:
XDSElement
All Known Subinterfaces:
OptionsParent, StateParent
All Known Implementing Classes:
XDSAuthenticationInfoElement, XDSDriverOptionsElement, XDSDriverStateElement, XDSPublisherOptionsElement, XDSPublisherStateElement, XDSSubscriberOptionsElement, XDSSubscriberStateElement

public interface ParamParent
extends XDSElement

A <driver-options>, <publisher-options>, <subscriber-options>, <driver-state>, <publisher-state>, <subscriber-state>, or <authentication-info> element.


Method Summary
 ParamElement paramElement(String tagName)
          Returns this element's child parameter element with a tag name equal to tagName.
 void parameters(Map params)
          Extracts parameter values from this element's child elements.
 String paramText(String tagName)
          Returns the concatenated child text nodes from this element's child parameter element with a tag name equal to tagName.
 
Methods inherited from interface com.novell.nds.dirxml.driver.xds.XDSElement
attributeValueGet, attributeValueGet, attributeValueSet, childElements, domDocument, domElement, localName, namespaceName, position, tagName
 

Method Detail

paramElement

public ParamElement paramElement(String tagName)
                          throws XDSParameterException
Returns this element's child parameter element with a tag name equal to tagName.

Invocation Context:
READ

Parameters:
tagName - may be null
Returns:
may be null
Throws:
XDSParameterException - if parameter tag names are not unique

paramText

public String paramText(String tagName)
                 throws XDSParameterException
Returns the concatenated child text nodes from this element's child parameter element with a tag name equal to tagName.

Invocation Context:
READ

Parameters:
tagName - may be null
Returns:
may be null; will not return ""
Throws:
XDSParameterException - if parameter tag names are not unique

parameters

public void parameters(Map params)
                throws XDSParameterException
Extracts parameter values from this element's child elements.

Invocation Context:
READ

Parameters:
params - the map of Parameters to extract; must not be null
Throws:
XDSParameterException - if parameter tag names are not unique or if a parameter constraint is violated