Package com.verisign.epp.codec.nameWatch
Class EPPNameWatchAddRemove
- java.lang.Object
-
- com.verisign.epp.codec.nameWatch.EPPNameWatchAddRemove
-
- All Implemented Interfaces:
EPPCodecComponent
,java.io.Serializable
,java.lang.Cloneable
public class EPPNameWatchAddRemove extends java.lang.Object implements EPPCodecComponent
Represents attributes to change with aEPPNameWatchUpdateCmd
. InEPPNameWatchUpdateCmd
, an instance ofEPPNameWatchAddRemove
is used to specify the attributes to change
The NameWatch Mapping Specification describes the following attributes:
-
Zero or more <nameWatch:registrant> element that contains the
identifier for the human or organizational social information (contact)
object to be associated with the nameWatch object as the object registrant.
This object identifier MUST be known to the server before the contact
object can be associated with the nameWatch object. Use
getRegistrant
andsetRegistrant
to get and set the element. -
Zero or more <nameWatch:rptTo> elements that contain the email address
and frequency type to be associated with the nameWatch. Use
getRptTo
andsetRptTo
to get and set the element. -
One or two <nameWatch:AuthInfo> element that contains authorization
information for the nameWatch object. Use
getAuthInfo
andsetAuthInfo
to get and set the element.
It is important to note that the maximum number of nameWatch attribute elements is subject to the number of values currently associated with the nameWatch object.EPPNameWatchAddRemove
will delegate the validation of the cardinality of the nameWatch attributes elements to the EPP Server.- See Also:
EPPNameWatchUpdateCmd
, Serialized Form
-
-
Constructor Summary
Constructors Constructor Description EPPNameWatchAddRemove()
Default constructor forEPPNameWatchAddRemove
.EPPNameWatchAddRemove(java.lang.String aRegistrant, EPPNameWatchRptTo aRptTo, EPPAuthInfo aAuthInfo)
Constructor forEPPNameWatchAddRemove
that includes the attributes as arguments.EPPNameWatchAddRemove(java.util.Vector aStatuses)
Constructor forEPPNameWatchAddRemove
that includes the attributes as arguments.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPNameWatchAddRemove
.void
decode(org.w3c.dom.Element aElement)
Decode theEPPNameWatchAddRemove
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 theEPPNameWatchAddRemove
instance.boolean
equals(java.lang.Object aObject)
implements a deepEPPNameWatchAddRemove
compare.EPPAuthInfo
getAuthInfo()
Get authorization informationjava.lang.String
getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.java.lang.String
getRegistrant()
Get registrantEPPNameWatchRptTo
getRptTo()
Gets the rptTojava.util.Vector
getStatuses()
Gets the statuses to add or remove.void
setAuthInfo(EPPAuthInfo newAuthInfo)
Set authorization informationvoid
setRegistrant(java.lang.String newRegistrant)
Set registrantvoid
setRptTo(EPPNameWatchRptTo aRptTo)
Sets the rptTovoid
setStatuses(java.util.Vector aStatuses)
Sets the statuses to add or remove.java.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.
-
-
-
Constructor Detail
-
EPPNameWatchAddRemove
public EPPNameWatchAddRemove()
Default constructor forEPPNameWatchAddRemove
. All of the attribute default tonull
to indicate no modification.
-
EPPNameWatchAddRemove
public EPPNameWatchAddRemove(java.util.Vector aStatuses)
Constructor forEPPNameWatchAddRemove
that includes the attributes as arguments.- Parameters:
aStatuses
-Vector
statuses
-
EPPNameWatchAddRemove
public EPPNameWatchAddRemove(java.lang.String aRegistrant, EPPNameWatchRptTo aRptTo, EPPAuthInfo aAuthInfo)
Constructor forEPPNameWatchAddRemove
that includes the attributes as arguments.- Parameters:
aRegistrant
-String
registrantaRptTo
-EPPNameWatchRptTo
reply toaAuthInfo
-EPPAuthInfo
authorization information
-
-
Method Detail
-
encode
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPNameWatchAddRemove
instance.- Specified by:
encode
in interfaceEPPCodecComponent
- Parameters:
aDocument
- DOM Document that is being built. Used as an Element factory.- Returns:
- Root DOM Element representing the
EPPNameWatchAddRemove
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPNameWatchAddRemove
instance.
-
decode
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPNameWatchAddRemove
attributes from the aElement DOM Element tree.- Specified by:
decode
in interfaceEPPCodecComponent
- Parameters:
aElement
- Root DOM Element to decodeEPPNameWatchAddRemove
from.- Throws:
EPPDecodeException
- Unable to decode aElement.
-
equals
public boolean equals(java.lang.Object aObject)
implements a deepEPPNameWatchAddRemove
compare.- Overrides:
equals
in classjava.lang.Object
- Parameters:
aObject
-EPPNameWatchAddRemove
instance to compare with- Returns:
- DOCUMENT ME!
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPNameWatchAddRemove
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classjava.lang.Object
- Returns:
- clone of
EPPNameWatchAddRemove
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
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.
-
getAuthInfo
public EPPAuthInfo getAuthInfo()
Get authorization information- Returns:
- Instance of
EPPAuthInfo
if defined;null
otherwise.
-
getRegistrant
public java.lang.String getRegistrant()
Get registrant- Returns:
- registrant if defined;
null
otherwise.
-
getRptTo
public EPPNameWatchRptTo getRptTo()
Gets the rptTo- Returns:
- Instance of
EPPNameWatchRptTo
if defined;null
otherwise.
-
getStatuses
public java.util.Vector getStatuses()
Gets the statuses to add or remove. TheEPPNameWatchStatus.STATUS_
constants can be used for the statuses.- Returns:
- Vector of status
String
instances.
-
setStatuses
public void setStatuses(java.util.Vector aStatuses)
Sets the statuses to add or remove. TheEPPNameWatchStatus.STATUS_
constants can be used for the statuses.- Parameters:
aStatuses
- Vector of statusString
instances.
-
setRptTo
public void setRptTo(EPPNameWatchRptTo aRptTo)
Sets the rptTo- Parameters:
aRptTo
- EPPNameWatchRptTo
-
setAuthInfo
public void setAuthInfo(EPPAuthInfo newAuthInfo)
Set authorization information- Parameters:
newAuthInfo
- EPPAuthInfo
-
setRegistrant
public void setRegistrant(java.lang.String newRegistrant)
Set registrant- Parameters:
newRegistrant
- registrant
-
getNamespace
public java.lang.String getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Returns:
- XML namespace for the
EPPCodecComponent
.
-
-