Class EPPValidateCheckCmd
- java.lang.Object
-
- com.verisign.epp.codec.gen.EPPCommand
-
- com.verisign.epp.codec.gen.EPPCheckCmd
-
- com.verisign.epp.codec.validate.v02.EPPValidateCheckCmd
-
- All Implemented Interfaces:
EPPCodecComponent,EPPMessage,java.io.Serializable,java.lang.Cloneable
public class EPPValidateCheckCmd extends EPPCheckCmd
TheEPPValidateCheckCmdis used for the Validate Check Command, that is used for the validation of contact and eligibility data.- See Also:
EPPValidateCheckResp, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringELM_LOCALNAMEConstant for the name verification check command-
Fields inherited from class com.verisign.epp.codec.gen.EPPCommand
extensions, OP_APPROVE, OP_CANCEL, OP_QUERY, OP_REJECT, OP_REQUEST, transId, TYPE_CHECK, TYPE_CREATE, TYPE_DELETE, TYPE_INFO, TYPE_LOGIN, TYPE_LOGOUT, TYPE_POLL, TYPE_RENEW, TYPE_TRANSFER, TYPE_UPDATE
-
-
Constructor Summary
Constructors Constructor Description EPPValidateCheckCmd()EPPValidateCheckCmddefault constructor.EPPValidateCheckCmd(java.lang.String aTransId)EPPValidateCheckCmdconstructor with just the client transaction identifier.EPPValidateCheckCmd(java.lang.String aTransId, EPPValidateContact aContact)EPPValidateCheckCmdconstructor that will check an individual contact.EPPValidateCheckCmd(java.lang.String aTransId, java.util.List<EPPValidateContact> aContacts)EPPValidateCheckCmdconstructor that will check a list of contacts.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddContact(EPPValidateContact aContact)Add a contact to the list of contacts to validate.java.lang.Objectclone()CloneEPPValidateCheckCmd.protected voiddoDecode(org.w3c.dom.Element aElement)Decode theEPPValidateCheckCmdattributes from the aElement DOM Element tree.protected org.w3c.dom.ElementdoEncode(org.w3c.dom.Document aDocument)Encode a DOM Element tree from the attributes of theEPPValidateCheckCmdinstance.booleanequals(java.lang.Object aObject)Compare an instance ofEPPValidateCheckCmdwith this instance.java.util.List<EPPValidateContact>getContacts()Gets contacts to validate.java.lang.StringgetKey()Gets the key for the validate object, which is the contact identifier.java.lang.StringgetNamespace()Gets the EPP command Namespace associated withEPPValidateCheckCmd.booleanhasContacts()Is there any contacts set?voidsetContact(EPPValidateContact aContact)Sets individual contact to validate.voidsetLabels(java.util.List<EPPValidateContact> aContacts)Sets contacts to validate.java.lang.StringtoString()Implementation ofObject.toString, which will result in an indented XMLStringrepresentation of the concreteEPPCodecComponent.-
Methods inherited from class com.verisign.epp.codec.gen.EPPCheckCmd
doGenDecode, doGenEncode, getType
-
Methods inherited from class com.verisign.epp.codec.gen.EPPCommand
addExtension, decode, encode, findDuplicateExtNamespaces, findExtNamespaces, findExtNamespaceSuffixes, findUnsupportedExtNamespaces, findUnsupportedExtNamespaceSuffixes, getExtension, getExtension, getExtensions, getOp, getTransId, hasExtension, hasExtensions, hasKey, hasTransId, setExtension, setExtensions, setTransId
-
-
-
-
Field Detail
-
ELM_LOCALNAME
public static final java.lang.String ELM_LOCALNAME
Constant for the name verification check command- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EPPValidateCheckCmd
public EPPValidateCheckCmd()
EPPValidateCheckCmddefault constructor.
-
EPPValidateCheckCmd
public EPPValidateCheckCmd(java.lang.String aTransId)
EPPValidateCheckCmdconstructor with just the client transaction identifier.- Parameters:
aTransId- Transaction Id associated with command.
-
EPPValidateCheckCmd
public EPPValidateCheckCmd(java.lang.String aTransId, EPPValidateContact aContact)EPPValidateCheckCmdconstructor that will check an individual contact.- Parameters:
aTransId- Transaction Id associated with command.aContact- Contact to validate
-
EPPValidateCheckCmd
public EPPValidateCheckCmd(java.lang.String aTransId, java.util.List<EPPValidateContact> aContacts)EPPValidateCheckCmdconstructor that will check a list of contacts.- Parameters:
aTransId- Transaction Id associated with command.aContacts-Listof labels to check
-
-
Method Detail
-
getNamespace
public java.lang.String getNamespace()
Gets the EPP command Namespace associated withEPPValidateCheckCmd.- Specified by:
getNamespacein interfaceEPPCodecComponent- Specified by:
getNamespacein interfaceEPPMessage- Specified by:
getNamespacein classEPPCommand- Returns:
EPPValidateMapFactory.NS
-
getKey
public java.lang.String getKey()
Gets the key for the validate object, which is the contact identifier.- Overrides:
getKeyin classEPPCommand- Returns:
- The validate identifier if set with a single value;
nullotherwise.
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPValidateCheckCmdwith this instance.- Overrides:
equalsin classEPPCheckCmd- Parameters:
aObject- Object to compare with.- Returns:
trueif equal;falseotherwise.
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedExceptionCloneEPPValidateCheckCmd.- Specified by:
clonein interfaceEPPCodecComponent- Overrides:
clonein classEPPCommand- Returns:
- Deep copy clone of
EPPValidateCheckCmd - Throws:
java.lang.CloneNotSupportedException- standard Object.clone exception
-
toString
public java.lang.String toString()
Implementation ofObject.toString, which will result in an indented XMLStringrepresentation of the concreteEPPCodecComponent.- Overrides:
toStringin classEPPCommand- Returns:
- Indented XML
Stringif successful;ERRORotherwise.
-
hasContacts
public boolean hasContacts()
Is there any contacts set?- Returns:
trueif there is at least oneEPPValidateContactset;falseotherwise.
-
setContact
public void setContact(EPPValidateContact aContact)
Sets individual contact to validate.- Parameters:
aContact- Contact to validate
-
getContacts
public java.util.List<EPPValidateContact> getContacts()
Gets contacts to validate.- Returns:
- List of contacts.
-
setLabels
public void setLabels(java.util.List<EPPValidateContact> aContacts)
Sets contacts to validate.- Parameters:
aContacts- Contacts to validate.
-
addContact
public void addContact(EPPValidateContact aContact)
Add a contact to the list of contacts to validate.- Parameters:
aContact- Contact to add
-
doEncode
protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeExceptionEncode a DOM Element tree from the attributes of theEPPValidateCheckCmdinstance.- Specified by:
doEncodein classEPPCheckCmd- Parameters:
aDocument- DOM Document that is being built. Used as an Element factory.- Returns:
- Element Root DOM Element representing the
EPPValidateCheckCmdinstance. - Throws:
EPPEncodeException- Unable to encodeEPPValidateCheckCmdinstance.
-
doDecode
protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeExceptionDecode theEPPValidateCheckCmdattributes from the aElement DOM Element tree.- Specified by:
doDecodein classEPPCheckCmd- Parameters:
aElement- Root DOM Element to decodeEPPValidateCheckCmdfrom.- Throws:
EPPDecodeException- Unable to decode aElement
-
-