|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.verificationcode.EPPVerificationCodeProfile
public class EPPVerificationCodeProfile
Information associated with compliance with a verification code profile. A Verification Profile defines the set of verification code types, the commands that the verification code types are required, supported, or not supported, and the grace period by which the verification code types MUST be set. A server MAY support many verification profiles, each with a unique name and a unique verification policy that is implemented by the server.
Nested Class Summary | |
---|---|
static class |
EPPVerificationCodeProfile.Status
Verification statuses that include: NOT_APPLICABLE - The profile status is not applicable to
the client based on the assigned verification profiles or the profile
specified. |
Field Summary | |
---|---|
static java.lang.String |
ELM_LOCALNAME
Constant for the profile local name |
static java.lang.String |
ELM_NAME
Constant for the profile tag |
Constructor Summary | |
---|---|
EPPVerificationCodeProfile()
Create an EPPVerificationCodeInfData instance. |
|
EPPVerificationCodeProfile(java.lang.String aProfileName,
EPPVerificationCodeProfile.Status aStatus)
Create a EPPVerificationCodeInfData instance with the required attributes status. |
|
EPPVerificationCodeProfile(java.lang.String aProfileName,
EPPVerificationCodeProfile.Status aStatus,
java.util.List<EPPVerificationCode> aMissingCodes,
java.util.List<EPPVerificationCode> aSetCodes)
Create a EPPVerificationCodeInfData instance with the all required and optional attributes. |
Method Summary | |
---|---|
void |
addMissingCode(EPPVerificationCode aMissingCode)
Add a missing code to the list of missing codes. |
void |
addSetCode(EPPVerificationCode aSetCode)
Add a set code to the list of set codes. |
java.lang.Object |
clone()
Clone EPPVerificationCodeInfData . |
void |
decode(org.w3c.dom.Element aElement)
Decode the EPPVerificationCodeInfData component |
org.w3c.dom.Element |
encode(org.w3c.dom.Document aDocument)
Sets all this instance's data in the given XML document |
boolean |
equals(java.lang.Object aObject)
implements a deep EPPVerificationCodeInfData compare. |
java.util.List<EPPVerificationCode> |
getMissingCodes()
Returns the list of missing codes. |
java.lang.String |
getProfileName()
Gets the verification profile name. |
java.util.List<EPPVerificationCode> |
getSetCodes()
Returns the list of set codes. |
EPPVerificationCodeProfile.Status |
getStatus()
Gets the verification status. |
boolean |
hasMissingCodes()
Are there any missing codes? |
boolean |
hasSetCodes()
Are there any set codes? |
void |
setMissingCodes(java.util.List<EPPVerificationCode> aMissingCodes)
Sets the missing codes. |
void |
setProfileName(java.lang.String aProfileName)
Sets the verification profile name. |
void |
setSetCodes(java.util.List<EPPVerificationCode> aSetCodes)
Sets the set codes. |
void |
setStatus(EPPVerificationCodeProfile.Status aStatus)
Sets the verification status. |
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 |
---|
public static final java.lang.String ELM_LOCALNAME
public static final java.lang.String ELM_NAME
Constructor Detail |
---|
public EPPVerificationCodeProfile()
EPPVerificationCodeInfData
instance.
public EPPVerificationCodeProfile(java.lang.String aProfileName, EPPVerificationCodeProfile.Status aStatus)
aProfileName
- Name of the profileaStatus
- Status of the verificationpublic EPPVerificationCodeProfile(java.lang.String aProfileName, EPPVerificationCodeProfile.Status aStatus, java.util.List<EPPVerificationCode> aMissingCodes, java.util.List<EPPVerificationCode> aSetCodes)
aProfileName
- Name of the profileaStatus
- Status of the verificationaMissingCodes
- OPTIONAL missing codes. Set to null
if there are
no missing codes.aSetCodes
- OPTIONAL set codes. Set to null
if there are no
set codes.Method Detail |
---|
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPVerificationCodeInfData
.
clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPVerificationCodeInfData
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
encode
in interface EPPCodecComponent
aDocument
- a DOM Document to attach data to.
EPPEncodeException
- Thrown if any errors prevent encoding.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
decode
in interface EPPCodecComponent
aElement
-
EPPDecodeException
public boolean equals(java.lang.Object aObject)
EPPVerificationCodeInfData
compare.
equals
in class java.lang.Object
aObject
- EPPVerificationCodeInfData
instance to compare
with
public java.lang.String getProfileName()
null
otherwise.public void setProfileName(java.lang.String aProfileName)
aProfileName
- Verification profilepublic EPPVerificationCodeProfile.Status getStatus()
public void setStatus(EPPVerificationCodeProfile.Status aStatus)
aStatus
- Verification statuspublic boolean hasMissingCodes()
true
if there are missing codes; false
otherwise.public java.util.List<EPPVerificationCode> getMissingCodes()
public void setMissingCodes(java.util.List<EPPVerificationCode> aMissingCodes)
aMissingCodes
- The list of missing codes. Set to null
or an
empty list to indicate that there are no missing codes.public void addMissingCode(EPPVerificationCode aMissingCode)
aMissingCode
- Missing code to add to the list of missing codes.public boolean hasSetCodes()
true
if there are set codes; false
otherwise.public java.util.List<EPPVerificationCode> getSetCodes()
public void setSetCodes(java.util.List<EPPVerificationCode> aSetCodes)
aSetCodes
- The list of set codes. Set to null
or an empty
list to indicate that there are no set codes.public void addSetCode(EPPVerificationCode aSetCode)
aSetCode
- Set code to add to the list of set codes.public 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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |