Package com.verisign.epp.codec.maintenance.v1_0

Class EPPMaintenanceId

java.lang.Object

com.verisign.epp.codec.maintenance.v1_0.EPPMaintenanceId

All Implemented Interfaces:

EPPCodecComponent, Serializable, Cloneable

public class EPPMaintenanceId
extends Object
implements EPPCodecComponent

Server unique id for the maintenance with an optional human-readable description of the maintenance.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ELM_NAME	XML Element Name of EPPMaintenenceId root element.

Constructor Summary

Constructors

Constructor	Description
EPPMaintenanceId()	Default constructor for EPPMaintenenceId.
EPPMaintenanceId(String aId)	Constructor for EPPMaintenenceId that the takes the required id value.
EPPMaintenanceId(String aId, String aName, String aNameLang)	Constructor for EPPMaintenenceId that takes all attributes.

Method Summary

Modifier and Type	Method	Description
Object	clone()	Clone EPPMaintenenceId.
void	decode(Element aElement)	Decode the EPPMaintenenceId attributes from the aElement DOM Element tree.
Element	encode(Document aDocument)	Encode a DOM Element tree from the attributes of the EPPMaintenenceId instance.
boolean	equals(Object aObject)	implements a deep EPPMaintenenceId compare.
String	getId()	Gets the id value of the maintenance.
void	getId(String aId)	Sets the id value of the maintenance.
String	getName()	Gets the human-readable name of the maintenance.
String	getNameLang()	Gets the name language value.
String	getNamespace()	Returns the XML namespace associated with the EPPCodecComponent.
boolean	hasName()	Is the name defined?
boolean	hasNameLang()	Is the name language defined with a non-default value?
void	setName(String aName)	Sets the human-readable name of the maintenance without having to create an external resource.
void	setNameLang(String aNameLang)	Sets the name language value.
String	toString()	Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

ELM_NAME

public static final String ELM_NAME

XML Element Name of EPPMaintenenceId root element.

See Also:

• Constant Field Values

Constructor Details

EPPMaintenanceId

public EPPMaintenanceId()

Default constructor for EPPMaintenenceId. The id attribute must be set using setId before invoking encode(Document).

EPPMaintenanceId

public EPPMaintenanceId(String aId)

Constructor for EPPMaintenenceId that the takes the required id value.

Parameters:

aId - Id value for the maintenance

EPPMaintenanceId

public EPPMaintenanceId(String aId,
 String aName,
 String aNameLang)

Constructor for EPPMaintenenceId that takes all attributes.

Parameters:

aId - Id value for the maintenance

aName - Optional id description that provides a human-readable description of the maintenance. Set to null to undefine.

aNameLang - Optional id description language. Set to null to undefine.

Method Details

getId

public String getId()

Gets the id value of the maintenance.

Returns:

Maintenance id value if defined; null otherwise.

getId

public void getId(String aId)

Sets the id value of the maintenance.

Parameters:

aId - Id value of the maintenance

hasName

public boolean hasName()

Is the name defined?

Returns:

true if the name is defined; false otherwise.

getName

public String getName()

Gets the human-readable name of the maintenance.

Returns:

The human-readable name of the maintenance if defined; null otherwise.

setName

public void setName(String aName)

Sets the human-readable name of the maintenance without having to create an external resource.

Parameters:

aName - Free-form name of the maintenance without having to create an external resource.

hasNameLang

public boolean hasNameLang()

Is the name language defined with a non-default value?

Returns:

true if the name language is defined; false otherwise.

getNameLang

public String getNameLang()

Gets the name language value.

Returns:

Name language if defined; DEFAULT_LANG otherwise.

setNameLang

public void setNameLang(String aNameLang)

Sets the name language value.

Parameters:

aNameLang - Name language.

encode

public Element encode(Document aDocument)
               throws EPPEncodeException

Encode a DOM Element tree from the attributes of the EPPMaintenenceId instance.

Specified by:

encode in interface EPPCodecComponent

Parameters:

aDocument - DOM Document that is being built. Used as an Element factory.

Returns:

Root DOM Element representing the EPPMaintenenceId instance.

Throws:

EPPEncodeException - Unable to encode EPPMaintenenceId instance.

decode

public void decode(Element aElement)
            throws EPPDecodeException

Decode the EPPMaintenenceId attributes from the aElement DOM Element tree.

Specified by:

decode in interface EPPCodecComponent

Parameters:

aElement - Root DOM Element to decode EPPMaintenenceId from.

Throws:

EPPDecodeException - Unable to decode aElement.

equals

public boolean equals(Object aObject)

implements a deep EPPMaintenenceId compare.

Overrides:

equals in class Object

Parameters:

aObject - EPPMaintenenceId instance to compare with

Returns:

true if aObject is equal; false otherwise.

clone

public Object clone()
             throws CloneNotSupportedException

Clone EPPMaintenenceId.

Specified by:

clone in interface EPPCodecComponent

Overrides:

clone in class Object

Returns:

clone of EPPMaintenenceId

Throws:

CloneNotSupportedException - standard Object.clone exception

toString

public String toString()

Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.

Overrides:

toString in class Object

Returns:

Indented XML String if successful; ERROR otherwise.

getNamespace

public String getNamespace()

Returns the XML namespace associated with the EPPCodecComponent.

Specified by:

getNamespace in interface EPPCodecComponent

Returns:

XML namespace for the EPPCodecComponent.