Package com.verisign.epp.codec.org

Class EPPOrgPostalDefinition

java.lang.Object

com.verisign.epp.codec.org.EPPOrgPostalDefinition

All Implemented Interfaces:

EPPCodecComponent, java.io.Serializable, java.lang.Cloneable

public class EPPOrgPostalDefinition
extends java.lang.Object
implements EPPCodecComponent

Represents a org postal address definition. The child elements associated with an EPPOrgPostalDefinition include:

• A localization type, represented by the EPPOrgPostalDefinition.Type enumeration. Use getType() and setType(Type) to get and set the attribute.
• A name that contains the name of the org. Use getName() and setName(String) to get and set the attribute.
• An address that contains address information associated with the org. Use getAddress() and setAddress(EPPOrgAddress) to get and set the attribute.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EPPOrgPostalDefinition.Type	Localized type with one of the following values: LOC - Localized form of data that MAY be represented in unrestricted UTF-8. INT - Internationalized form o data that MUST be represented in a subset of UTF-8 that can be represented in the 7-bit US-ASCII character set.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ELM_LOCALNAME	XML local name for EPPOrgDisclose.
static java.lang.String	ELM_NAME	XML root tag for EPPOrgPostalDefinition.

Constructor Summary

Constructors

Constructor	Description
EPPOrgPostalDefinition()	EPPOrgPostalDefinition default constructor.
EPPOrgPostalDefinition(EPPOrgPostalDefinition.Type aType)	EPPOrgPostalDefinition constructor that takes the contact postal type as an argument.
EPPOrgPostalDefinition(EPPOrgPostalDefinition.Type aType, java.lang.String aName, EPPOrgAddress aAddress)	EPPOrgPostalDefinition constructor that sets the required attributes with the parameters.

Method Summary

Modifier and Type	Method	Description
java.lang.Object	clone()	Clone EPPOrgPostalDefinition.
void	decode(org.w3c.dom.Element aElement)	Decode the EPPOrgPostalDefinition attributes from the aElement DOM Element tree.
org.w3c.dom.Element	encode(org.w3c.dom.Document aDocument)	Encode a DOM Element tree from the attributes of the EPPOrgPostalDefinition instance.
boolean	equals(java.lang.Object aObject)	implements a deep EPPOrgPostalDefinition compare.
EPPOrgAddress	getAddress()	Gets the contact address
java.lang.String	getName()	Gets the contact name
java.lang.String	getNamespace()	Returns the XML namespace associated with the EPPCodecComponent.
EPPOrgPostalDefinition.Type	getType()	Gets the contact postal type.
void	setAddress(EPPOrgAddress aAddress)	Sets the contact address
void	setName(java.lang.String aName)	Sets the contact name.
void	setType(EPPOrgPostalDefinition.Type aType)	Sets the contact type.
java.lang.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 Detail

ELM_LOCALNAME

public static final java.lang.String ELM_LOCALNAME

XML local name for EPPOrgDisclose.

See Also:

Constant Field Values

ELM_NAME

public static final java.lang.String ELM_NAME

XML root tag for EPPOrgPostalDefinition.

See Also:

Constant Field Values

Constructor Detail

EPPOrgPostalDefinition

public EPPOrgPostalDefinition()

EPPOrgPostalDefinition default constructor.

EPPOrgPostalDefinition

public EPPOrgPostalDefinition(EPPOrgPostalDefinition.Type aType)

EPPOrgPostalDefinition constructor that takes the contact postal type as an argument.

Parameters:

aType - Postal type

EPPOrgPostalDefinition

public EPPOrgPostalDefinition(EPPOrgPostalDefinition.Type aType,
                              java.lang.String aName,
                              EPPOrgAddress aAddress)

EPPOrgPostalDefinition constructor that sets the required attributes with the parameters.

Parameters:

aName - contact name

aType - Postal type

aAddress - contact address

Method Detail

getType

public EPPOrgPostalDefinition.Type getType()

Gets the contact postal type.

Returns:

Contact postal type

setType

public void setType(EPPOrgPostalDefinition.Type aType)

Sets the contact type.

Parameters:

aType - Contact postal type

getName

public java.lang.String getName()

Gets the contact name

Returns:

Contact Name if defined; null otherwise.

setName

public void setName(java.lang.String aName)

Sets the contact name.

Parameters:

aName - Contact Name

getAddress

public EPPOrgAddress getAddress()

Gets the contact address

Returns:

Contact address if defined; null otherwise.

setAddress

public void setAddress(EPPOrgAddress aAddress)

Sets the contact address

Parameters:

aAddress - Contact address

encode

public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument)
                           throws EPPEncodeException

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

Specified by:

encode in interface EPPCodecComponent

Parameters:

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

Returns:

Encoded DOM Element

Throws:

EPPEncodeException - On encoding error

decode

public void decode(org.w3c.dom.Element aElement)
            throws EPPDecodeException

Decode the EPPOrgPostalDefinition attributes from the aElement DOM Element tree.

Specified by:

decode in interface EPPCodecComponent

Parameters:

aElement - Root DOM Element to decode EPPOrgPostalDefinition from.

Throws:

EPPDecodeException - Unable to decode aElement

equals

public boolean equals(java.lang.Object aObject)

implements a deep EPPOrgPostalDefinition compare.

Overrides:

equals in class java.lang.Object

Parameters:

aObject - EPPOrgPostalDefinition instance to compare with

Returns:

true if the object is equal to aObject; false otherwise.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone EPPOrgPostalDefinition.

Specified by:

clone in interface EPPCodecComponent

Overrides:

clone in class java.lang.Object

Returns:

clone of EPPOrgPostalDefinition

Throws:

java.lang.CloneNotSupportedException - standard Object.clone exception

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

Indented XML String if successful; ERROR otherwise.

getNamespace

public java.lang.String getNamespace()

Returns the XML namespace associated with the EPPCodecComponent.

Specified by:

getNamespace in interface EPPCodecComponent

Returns:

XML namespace for the EPPCodecComponent.