|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.contact.EPPContactPostalDefinition
public class EPPContactPostalDefinition
Represents a contact postal address definition that is used in
EPPContactCreateCmd
, EPPContactUpdateCmd
, and
EPPContactInfoResp
. The child elements associated with an
EPPContactPostalDefinition
include:
getName
and
setName
to get and set the element.
getOrg
and setOrg
to get and set the element.
getAddress
and setAdress
to
get and set the element.
Field Summary | |
---|---|
static java.lang.String |
ATTR_TYPE_INT
Value of the INT in contact postal info type mapping |
static java.lang.String |
ATTR_TYPE_LOC
Value of the LOC in contact postal info type mapping |
static java.lang.String |
ELM_NAME_POSTAL_INFO
XML tag name for the org attribute. |
Constructor Summary | |
---|---|
EPPContactPostalDefinition()
EPPContactPostalDefinition default constructor. |
|
EPPContactPostalDefinition(java.lang.String aType)
EPPContactPostalDefinition constructor that takes the
contact address type as argument. |
|
EPPContactPostalDefinition(java.lang.String aType,
EPPContactAddress aAddress)
EPPContactPostalDefinition constructor that sets the
required attributes with the parameters. |
|
EPPContactPostalDefinition(java.lang.String aName,
java.lang.String aType,
EPPContactAddress aAddress)
EPPContactPostalDefinition constructor that sets the
required attributes with the parameters. |
|
EPPContactPostalDefinition(java.lang.String aName,
java.lang.String aOrg,
java.lang.String aType,
EPPContactAddress aAddress)
EPPContactPostalDefinition constructor that sets all of the
attribute with the parameter values. |
Method Summary | |
---|---|
java.lang.Object |
clone()
Clone EPPContactPostalDefinition . |
void |
decode(org.w3c.dom.Element aElement)
Decode the EPPContactPostalDefinition 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 EPPContactPostalDefinition instance. |
boolean |
equals(java.lang.Object aObject)
implements a deep EPPContactPostalDefinition compare. |
EPPContactAddress |
getAddress()
Gets the contact address |
java.lang.String |
getName()
Gets the contact name |
java.lang.String |
getOrg()
Gets the contact organization |
java.lang.String |
getRootName()
Get root tag name for contact postal definition. |
java.lang.String |
getType()
Get contact address type. |
boolean |
isValidated()
Show whether needs to call validateState() |
void |
setAddress(EPPContactAddress aAddress)
Sets the contact address |
void |
setName(java.lang.String aName)
Sets the contact name. |
void |
setOrg(java.lang.String aOrg)
Sets the contact organization |
void |
setRootName(java.lang.String newRootName)
Set root tag name for contact postal definition. |
void |
setType(java.lang.String newType)
Set contact type. |
void |
setValidatedFlag(boolean newValidatedFlag)
Set validated flag. |
java.lang.String |
toString()
Implementation of Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
protected void |
validateState()
Validate the state of the EPPContactPostalDefination
instance. |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ELM_NAME_POSTAL_INFO
org
attribute.
public static final java.lang.String ATTR_TYPE_LOC
public static final java.lang.String ATTR_TYPE_INT
Constructor Detail |
---|
public EPPContactPostalDefinition()
EPPContactPostalDefinition
default constructor. Must call
required setter methods before invoking encode
, which
include:setId
setName
setType
setAddress
setVoice
setEmail
setOrg
setFax
public EPPContactPostalDefinition(java.lang.String aType)
EPPContactPostalDefinition
constructor that takes the
contact address type as argument.
aType
- address type which should be one of the
ATTR_TYPE
constants.public EPPContactPostalDefinition(java.lang.String aType, EPPContactAddress aAddress)
EPPContactPostalDefinition
constructor that sets the
required attributes with the parameters. The following optional
attribute can be set:setOrg
setFax
setName
aType
- DOCUMENT ME!aAddress
- contact addresspublic EPPContactPostalDefinition(java.lang.String aName, java.lang.String aType, EPPContactAddress aAddress)
EPPContactPostalDefinition
constructor that sets the
required attributes with the parameters. The following optional
attribute can be set:setOrg
setFax
aName
- contact nameaType
- DOCUMENT ME!aAddress
- contact addresspublic EPPContactPostalDefinition(java.lang.String aName, java.lang.String aOrg, java.lang.String aType, EPPContactAddress aAddress)
EPPContactPostalDefinition
constructor that sets all of the
attribute with the parameter values.
aName
- contact nameaOrg
- contact organization if defined; null
otherwiseaType
- DOCUMENT ME!aAddress
- contact addressMethod Detail |
---|
public java.lang.String getOrg()
null
otherwise.public void setOrg(java.lang.String aOrg)
aOrg
- Client organizationpublic EPPContactAddress getAddress()
null
otherwise.public void setAddress(EPPContactAddress aAddress)
aAddress
- Contact addresspublic org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPContactPostalDefinition
instance.
encode
in interface EPPCodecComponent
aDocument
- DOM Document that is being built. Used as an Element
factory.
EPPEncodeException
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPContactPostalDefinition
attributes from the
aElement DOM Element tree.
decode
in interface EPPCodecComponent
aElement
- Root DOM Element to decode
EPPContactPostalDefinition
from.
EPPDecodeException
- Unable to decode aElementpublic boolean equals(java.lang.Object aObject)
EPPContactPostalDefinition
compare.
equals
in class java.lang.Object
aObject
- EPPContactPostalDefinition
instance to
compare with
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPContactPostalDefinition
.
clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPContactPostalDefinition
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic java.lang.String toString()
Object.toString
, which will result in an
indented XML String
representation of the concrete
EPPCodecComponent
.
toString
in class java.lang.Object
String
if successful;
ERROR
otherwise.protected void validateState() throws EPPCodecException
EPPContactPostalDefination
instance. A valid state means that all of the required attributes have
been set. If validateState returns without an exception, the state
is valid. If the state is not valid, the EPPCodecException will
contain a description of the error. throws EPPCodecException
State error. This will contain the name of the attribute that is
not valid.
EPPCodecException
- DOCUMENT ME!public java.lang.String getName()
null
otherwise.public java.lang.String getRootName()
public void setName(java.lang.String aName)
aName
- Contact Namepublic void setRootName(java.lang.String newRootName)
newRootName
- Stringpublic boolean isValidated()
public void setValidatedFlag(boolean newValidatedFlag)
newValidatedFlag
- booleanpublic java.lang.String getType()
public void setType(java.lang.String newType)
newType
- String
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |