com.novell.nds.dirxml.shimhost

Class OldStyleParams.Param

java.lang.Object

com.novell.nds.dirxml.shimhost.OldStyleParams.Param

Direct Known Subclasses:

OldStyleParams.PasswordParam

Enclosing class:

OldStyleParams

public static class OldStyleParams.Param
extends java.lang.Object

Encapsulation of a single shim parameter.

Constructor Summary

Constructors

Constructor and Description
Param(java.lang.String name) Create a Param instance.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplayName() Return the display name of this Param
java.lang.String	getName() Get the name of this Param
java.lang.String	getValue() Get the value of this Param
boolean	hasBeenModified() Return true if this instance has been modified.
void	resetModified() Reset the modified flag for this instance such that hasBeenModified() will return false.
void	setDisplayName(java.lang.String newName) Set the display name for this Param
void	setName(java.lang.String newName) Set the name of this Param
void	setValue(java.lang.String newValue) Set the value of this Param
org.w3c.dom.Element	toXML(org.w3c.dom.Node parent) Construct an XML representation of this Param Note that the act of creating an XML representation does not reset this instance's modified flag.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Param

public Param(java.lang.String name)
      throws java.lang.IllegalArgumentException

Create a Param instance.

Parameters:

name - name of the parameter (and name of XML element)

Throws:

java.lang.IllegalArgumentException - if name does not match the XML Name production

Method Detail

hasBeenModified

public boolean hasBeenModified()

Return true if this instance has been modified.

The instance is considered to have been modified if a change was made that affects the persistent representation since:

1. The instance was constructed from an XML representation.
2. resetModified() was last called

Returns:

true or false

See Also:

resetModified(), toXML(org.w3c.dom.Node)

resetModified

public void resetModified()

Reset the modified flag for this instance such that hasBeenModified() will return false.

See Also:

hasBeenModified()

toXML

public org.w3c.dom.Element toXML(org.w3c.dom.Node parent)

Construct an XML representation of this Param

Note that the act of creating an XML representation does not reset this instance's modified flag. It must be reset by calling resetModified().

Parameters:

parent - Node under which to build representation

Returns:

constructed Element

See Also:

hasBeenModified(), resetModified()

getName

public java.lang.String getName()

Get the name of this Param

Returns:

name

setName

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

Set the name of this Param

Parameters:

newName - name

Throws:

java.lang.IllegalArgumentException - if newName doesn't match the XML Name production

getDisplayName

public java.lang.String getDisplayName()

Return the display name of this Param

Returns:

display name (may be null)

setDisplayName

public void setDisplayName(java.lang.String newName)

Set the display name for this Param

Parameters:

newName - display name

getValue

public java.lang.String getValue()

Get the value of this Param

Returns:

value

setValue

public void setValue(java.lang.String newValue)

Set the value of this Param

Parameters:

newValue - value