public class EPPEmailFwdAddRemove extends java.lang.Object implements EPPCodecComponent
EPPEmailFwdUpdateCmd
. In
EPPEmailFwdUpdateCmd
, an instance of
EPPEmailFwdAddRemove
is used to specify the attributes to
add; an instance of EPPEmailFwdAddRemove
is used to
specify the attributes to remove, and an instance of
EPPEmailFwdAddRemove
is used to specify the attributes to changegetContacts
and
setContacts
to get and set the element. This attribute will
only be allowed if the Contact Mapping is supported.
getStatuses
and setStatuses
to get and set the
element.
change
only, A <emailFwd:registrant> element that
contains the identifier for the human or organizational social information
(contact) object to be associated with the emailFwd object as the object
registrant. This object identifier MUST be known to the server before the
contact object can be associated with the emailFwd object. Use
getRegistrant
and setRegistrant
to get and set
the element.
change
only, An OPTIONAL <emailFwd:fwdTo> element
that contains the email forwardTo addresses. Use getForwardTo
and setForwardTo
to get and set the forwardTo addresses.
EPPEmailFwdAddRemove
will delegate the
validation of the cardinality of the emailFwd attributes elements to
the EPP Server. EPPEmailFwdUpdateCmd
,
Serialized FormConstructor and Description |
---|
EPPEmailFwdAddRemove()
Default constructor for
EPPEmailFwdAddRemove . |
EPPEmailFwdAddRemove(java.lang.String aRegistrant,
java.lang.String aForwardTo,
EPPAuthInfo aAuthInfo)
Constructor for
EPPEmailFwdAddRemove that includes the
attributes as arguments. |
EPPEmailFwdAddRemove(java.util.Vector someContacts,
java.util.Vector someStatuses)
Constructor for
EPPEmailFwdAddRemove that includes the
attributes as arguments. |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Clone
EPPEmailFwdAddRemove . |
boolean |
contactsSupported()
Return if EmailFwd Contacts is supported.
|
void |
decode(org.w3c.dom.Element aElement)
Decode the
EPPEmailFwdAddRemove 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
EPPEmailFwdAddRemove instance. |
boolean |
equals(java.lang.Object aObject)
implements a deep
EPPEmailFwdAddRemove compare. |
EPPAuthInfo |
getAuthInfo()
Get authorization information for the change mode
|
java.util.Vector |
getContacts()
Gets the contacts to add or remove.
|
java.lang.String |
getForwardTo()
Get forwardTo Address
|
java.lang.String |
getNamespace()
Returns the XML namespace associated with the
EPPCodecComponent . |
java.lang.String |
getRegistrant()
Get registrant for the change mode
|
java.util.Vector |
getStatuses()
Gets the statuses to add or remove.
|
void |
setAuthInfo(EPPAuthInfo newAuthInfo)
Set authorization information for the change mode
|
void |
setContacts(java.util.Vector aContacts)
Sets the contacts to add or remove.
|
void |
setForwardTo(java.lang.String newForwardTo)
Set forwardTo Address for the change mode
|
void |
setRegistrant(java.lang.String newRegistrant)
Set registrant for the change mode
|
void |
setStatuses(java.util.Vector aStatuses)
Sets the statuses to add or remove.
|
java.lang.String |
toString()
Implementation of
Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
public EPPEmailFwdAddRemove()
EPPEmailFwdAddRemove
. All of the
attribute default to null
to indicate no modification.public EPPEmailFwdAddRemove(java.util.Vector someContacts, java.util.Vector someStatuses)
EPPEmailFwdAddRemove
that includes the
attributes as arguments.someContacts
- Vector of EPPEmailFwdContact
instances.
Is null
or empty for no modifications. If the
Contact Mapping is not supported, this value should be
null
.someStatuses
- Vector of status String
's. One of the
EPPEmailFwdInfoResp.STATUS_
contants can be used
for each of the status values. Is null
or
empty for no modifications.public EPPEmailFwdAddRemove(java.lang.String aRegistrant, java.lang.String aForwardTo, EPPAuthInfo aAuthInfo)
EPPEmailFwdAddRemove
that includes the
attributes as arguments.aRegistrant
- String
registrant for the
change modeaForwardTo
- String
forwardTo address of the
email.aAuthInfo
- EPPAuthInfo
authorization information
for the change modepublic java.util.Vector getContacts()
EPPEmailFwdContact
instances.public void setContacts(java.util.Vector aContacts)
aContacts
- DOCUMENT ME!public java.util.Vector getStatuses()
EPPEmailFwdInfoResp.STATUS_
constants can be used for
the statuses.String
instances.public void setStatuses(java.util.Vector aStatuses)
EPPEmailFwdInfoResp.STATUS_
constants can be used for
the statuses.aStatuses
- Vector of status String
instances.public boolean contactsSupported()
true
if contacts are supported; false
otherwise.public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPEmailFwdAddRemove
instance.encode
in interface EPPCodecComponent
aDocument
- DOM Document that is being built. Used as an Element
factory.EPPEmailFwdAddRemove
instance.EPPEncodeException
- Unable to encode
EPPEmailFwdAddRemove
instance.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPEmailFwdAddRemove
attributes from the
aElement DOM Element tree.decode
in interface EPPCodecComponent
aElement
- Root DOM Element to decode
EPPEmailFwdAddRemove
from.EPPDecodeException
- Unable to decode aElement.public boolean equals(java.lang.Object aObject)
EPPEmailFwdAddRemove
compare.equals
in class java.lang.Object
aObject
- EPPEmailFwdAddRemove
instance to compare
withpublic java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPEmailFwdAddRemove
.clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPEmailFwdAddRemove
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 EPPAuthInfo getAuthInfo()
public java.lang.String getRegistrant()
public java.lang.String getForwardTo()
public void setAuthInfo(EPPAuthInfo newAuthInfo)
newAuthInfo
- com.verisign.epp.codec.emailFwd.EPPEmailFwdAuthInfopublic void setRegistrant(java.lang.String newRegistrant)
newRegistrant
- java.lang.Stringpublic void setForwardTo(java.lang.String newForwardTo)
newForwardTo
- java.lang.Stringpublic java.lang.String getNamespace()
EPPCodecComponent
.getNamespace
in interface EPPCodecComponent
EPPCodecComponent
.