Package com.verisign.epp.codec.nameWatch
Class EPPNameWatchRptTo
- java.lang.Object
-
- com.verisign.epp.codec.nameWatch.EPPNameWatchRptTo
-
- All Implemented Interfaces:
EPPCodecComponent
,java.io.Serializable
,java.lang.Cloneable
public class EPPNameWatchRptTo extends java.lang.Object implements EPPCodecComponent
Specifies the e-mail address to send the NameWatch reports and the frequency of the reports.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
RPTTO_FREQ_DAILY
Daily Report Frequencystatic java.lang.String
RPTTO_FREQ_MONTHLY
Monthly Report Frequencystatic java.lang.String
RPTTO_FREQ_WEEKLY
Weekly Report Frequency
-
Constructor Summary
Constructors Constructor Description EPPNameWatchRptTo()
EPPNameWatchRptTo
default constructor.EPPNameWatchRptTo(java.lang.String aRptTo)
EPPNameWatchRptTo
constructor that takes the nameWatch e-mail address to report to.EPPNameWatchRptTo(java.lang.String aFreqType, java.lang.String aRptTo)
EPPNameWatchRptTo
constructor that takes the nameWatch frequency and namewatch e-mail address to report to.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPNameWatchRptTo
.void
decode(org.w3c.dom.Element aElement)
Decode the EPPNameWatchRptTo 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 EPPNameWatchRptTo instance.boolean
equals(java.lang.Object aObject)
implements a deepEPPNameWatchRptTo
compare.java.lang.String
getFreqType()
Get nameWatch report frequency.java.lang.String
getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.java.lang.String
getRptTo()
Gets the email address to report to.boolean
isRptToUnspec()
Test whether the report to attribute is unspecified.void
setFreqType(java.lang.String newFreqType)
Sets the frequency of the report.void
setRptTo(java.lang.String newRptTo)
Sets the namewatch e-mail address to report to.java.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.
-
-
-
Field Detail
-
RPTTO_FREQ_DAILY
public static final java.lang.String RPTTO_FREQ_DAILY
Daily Report Frequency- See Also:
- Constant Field Values
-
RPTTO_FREQ_WEEKLY
public static final java.lang.String RPTTO_FREQ_WEEKLY
Weekly Report Frequency- See Also:
- Constant Field Values
-
RPTTO_FREQ_MONTHLY
public static final java.lang.String RPTTO_FREQ_MONTHLY
Monthly Report Frequency- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EPPNameWatchRptTo
public EPPNameWatchRptTo()
EPPNameWatchRptTo
default constructor. The period is initialized tounspecified
. The period must be set before invokingencode
.
-
EPPNameWatchRptTo
public EPPNameWatchRptTo(java.lang.String aRptTo)
EPPNameWatchRptTo
constructor that takes the nameWatch e-mail address to report to. The frequency is set toRPTTO_FREQ_DAILY
.- Parameters:
aRptTo
- e-mail address to report to.
-
EPPNameWatchRptTo
public EPPNameWatchRptTo(java.lang.String aFreqType, java.lang.String aRptTo)
EPPNameWatchRptTo
constructor that takes the nameWatch frequency and namewatch e-mail address to report to.- Parameters:
aFreqType
- Report frequency, which should be one of theRPTTO_FREQ_
constant values. Ifnull
, it will be set toRPTTO_FREQ_DAILY
by default.aRptTo
- E-mail address to report to.
-
-
Method Detail
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPNameWatchRptTo
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classjava.lang.Object
- Returns:
- clone of
EPPNameWatchRptTo
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
decode
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode the EPPNameWatchRptTo attributes from the aElement DOM Element tree.- Specified by:
decode
in interfaceEPPCodecComponent
- Parameters:
aElement
- - Root DOM Element to decode EPPNameWatchRptTo from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
encode
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of the EPPNameWatchRptTo instance.- Specified by:
encode
in interfaceEPPCodecComponent
- Parameters:
aDocument
- - DOM Document that is being built. Used as an Element factory.- Returns:
- Element - Root DOM Element representing the EPPNameWatchRptTo instance.
- Throws:
EPPEncodeException
- - Unable to encode EPPNameWatchRptTo instance.
-
equals
public boolean equals(java.lang.Object aObject)
implements a deepEPPNameWatchRptTo
compare.- Overrides:
equals
in classjava.lang.Object
- Parameters:
aObject
-EPPNameWatchRptTo
instance to compare with- Returns:
- DOCUMENT ME!
-
getRptTo
public java.lang.String getRptTo()
Gets the email address to report to.- Returns:
- Report to e-mail address if defined;
null
otherwise.
-
getFreqType
public java.lang.String getFreqType()
Get nameWatch report frequency.- Returns:
- Report frequency, which should be one of the
RPTTO_FREQ_
constant values.
-
isRptToUnspec
public boolean isRptToUnspec()
Test whether the report to attribute is unspecified.- Returns:
true
is unspecified andfalse
is specified.
-
setRptTo
public void setRptTo(java.lang.String newRptTo) throws EPPCodecException
Sets the namewatch e-mail address to report to.- Parameters:
newRptTo
- e-mail address to report to- Throws:
EPPCodecException
- Format error
-
setFreqType
public void setFreqType(java.lang.String newFreqType)
Sets the frequency of the report.- Parameters:
newFreqType
- Should be one of theRPTTO_FREQ_
constant values.
-
toString
public java.lang.String toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.- Overrides:
toString
in classjava.lang.Object
- Returns:
- Indented XML
String
if successful;ERROR
otherwise.
-
getNamespace
public java.lang.String getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Returns:
- XML namespace for the
EPPCodecComponent
.
-
-