public class EPPRealNameVerification extends java.lang.Object implements EPPCodecComponent
EPPNameVerificationCreateCmd
and the
EPPNameVerificationInfoResp
.Modifier and Type | Class and Description |
---|---|
static class |
EPPRealNameVerification.ProofType
Real Name Verification (RNV) proof type include:
POC - Proof of Citizen, where the POC represents the
citizen's identification card (ID) material.
POE - Proof of Enterprise, where the POE represents the
Organization Code Certificate (OCC) or Business License (BL)
material.
POOT - Proof of Other Types, in the POOT represents other
certificate materials except the POC or POE.
|
static class |
EPPRealNameVerification.Role
Real Name Verification (RNV) role that include:
PERSON - The RNV is for a person.
ORG - The RNV is for an organization.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ELM_LOCALNAME
XML local name for
EPPRealNameVerification . |
static java.lang.String |
ELM_NAME
XML root tag for
EPPRealNameVerification . |
static java.lang.String |
ROLE_PERSON
Contact for the default contact type.
|
Constructor and Description |
---|
EPPRealNameVerification()
EPPRealNameVerification default constructor. |
EPPRealNameVerification(EPPRealNameVerification.Role aRole,
java.lang.String aName,
java.lang.String aNum,
EPPRealNameVerification.ProofType aProofType)
EPPRealNameVerification constructor the required attributes. |
EPPRealNameVerification(EPPRealNameVerification.Role aRole,
java.lang.String aName,
java.lang.String aNum,
EPPRealNameVerification.ProofType aProofType,
EPPNameVerificationDocument aDocument)
EPPRealNameVerification constructor that takes all attributes
with a single document. |
EPPRealNameVerification(EPPRealNameVerification.Role aRole,
java.lang.String aName,
java.lang.String aNum,
EPPRealNameVerification.ProofType aProofType,
java.util.List<EPPNameVerificationDocument> aDocuments)
EPPRealNameVerification constructor that takes all
attributes. |
Modifier and Type | Method and Description |
---|---|
void |
addDocument(EPPNameVerificationDocument aDocument)
Adds a document to the list of verification documents.
|
java.lang.Object |
clone()
Clone
EPPRealNameVerification . |
void |
decode(org.w3c.dom.Element aElement)
Decode the
EPPRealNameVerification 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
EPPRealNameVerification instance. |
boolean |
equals(java.lang.Object aObject)
Compare an instance of
EPPRealNameVerification with this
instance. |
java.util.List<EPPNameVerificationDocument> |
getDocuments()
Gets the verification documents.
|
java.lang.String |
getName()
Gets the full name of the contact
|
java.lang.String |
getNamespace()
Returns the XML namespace associated with the
EPPCodecComponent . |
java.lang.String |
getNum()
Gets the citizen or the organization ID of the contact.
|
EPPRealNameVerification.ProofType |
getProofType()
Gets the proof material type of the contact.
|
EPPRealNameVerification.Role |
getRole()
Gets the contact role.
|
boolean |
hasDocuments()
Are there any verification documents?
|
void |
setDocuments(java.util.List<EPPNameVerificationDocument> aDocuments)
Sets the verification documents.
|
void |
setName(java.lang.String aName)
Sets the full name of the contact.
|
void |
setNum(java.lang.String aNum)
Sets the citizen or the organization ID of the contact.
|
void |
setProofType(EPPRealNameVerification.ProofType aProofType)
Sets the proof material type of the contact.
|
void |
setRole(EPPRealNameVerification.Role aRole)
Sets the contact role.
|
java.lang.String |
toString()
Implementation of
Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
public static final java.lang.String ELM_LOCALNAME
EPPRealNameVerification
.public static final java.lang.String ELM_NAME
EPPRealNameVerification
.public static final java.lang.String ROLE_PERSON
public EPPRealNameVerification()
EPPRealNameVerification
default constructor.public EPPRealNameVerification(EPPRealNameVerification.Role aRole, java.lang.String aName, java.lang.String aNum, EPPRealNameVerification.ProofType aProofType)
EPPRealNameVerification
constructor the required attributes.aRole
- Contact role.aNum
- Citizen or organization ID of the contact.aName
- Real name to verifyaProofType
- Proof typepublic EPPRealNameVerification(EPPRealNameVerification.Role aRole, java.lang.String aName, java.lang.String aNum, EPPRealNameVerification.ProofType aProofType, EPPNameVerificationDocument aDocument)
EPPRealNameVerification
constructor that takes all attributes
with a single document.
* @param aType Contact type with default of TYPE_REGISTRANT
.aRole
- Role of the contactaName
- Full name of the contactaNum
- Citizen or the organization ID of the contact.aProofType
- Proof material type of the contact.aDocument
- Single proof documentpublic EPPRealNameVerification(EPPRealNameVerification.Role aRole, java.lang.String aName, java.lang.String aNum, EPPRealNameVerification.ProofType aProofType, java.util.List<EPPNameVerificationDocument> aDocuments)
EPPRealNameVerification
constructor that takes all
attributes.
* @param aType Contact type with default of TYPE_REGISTRANT
.aRole
- Role of the contactaName
- Full name of the contactaNum
- Citizen or the organization ID of the contact.aProofType
- Proof material type of the contact.aDocuments
- List of proof documentspublic EPPRealNameVerification.Role getRole()
public void setRole(EPPRealNameVerification.Role aRole)
aRole
- Contact rolepublic java.lang.String getNum()
public void setNum(java.lang.String aNum)
aNum
- Citizen or the organization ID of the contact.public java.lang.String getName()
public void setName(java.lang.String aName)
aName
- Full name of the contactpublic EPPRealNameVerification.ProofType getProofType()
public void setProofType(EPPRealNameVerification.ProofType aProofType)
aProofType
- proof material type of the contactpublic boolean hasDocuments()
true
if there are documents; false
otherwise.public java.util.List<EPPNameVerificationDocument> getDocuments()
public void setDocuments(java.util.List<EPPNameVerificationDocument> aDocuments)
aDocuments
- Verification documentspublic void addDocument(EPPNameVerificationDocument aDocument)
aDocument
- Document to add to the list of verification documents.public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPRealNameVerification
instance.encode
in interface EPPCodecComponent
aDocument
- DOM Document that is being built. Used as an Element factory.EPPRealNameVerification
instance.EPPEncodeException
- Unable to encode EPPRealNameVerification
instance.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPRealNameVerification
attributes from the
aElement DOM Element tree.decode
in interface EPPCodecComponent
aElement
- Root DOM Element to decode EPPRealNameVerification
from.EPPDecodeException
- Unable to decode aElementpublic boolean equals(java.lang.Object aObject)
EPPRealNameVerification
with this
instance.equals
in class java.lang.Object
aObject
- Object to compare with.true
if this object is the same as the aObject argument;
false
otherwise.public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPRealNameVerification
.clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPRealNameVerification
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.public java.lang.String getNamespace()
EPPCodecComponent
.getNamespace
in interface EPPCodecComponent
EPPCodecComponent
.