|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.gen.EPPRecipient
public class EPPRecipient
Identifies the Recipient DataCollectionPolicy supported by the server:
setOther
, setPublic
,
setSame
, setUnRelated
with a boolean value of
true to create the necessary child element nodes. Use setOurs
to set a Vector
of ours child element nodes with optional
descriptions.
EPPStatement
,
Serialized FormConstructor Summary | |
---|---|
EPPRecipient()
Default constructor. |
|
EPPRecipient(boolean aOther,
java.util.Vector aOurs,
boolean aPublic,
boolean aSame,
boolean aUnrelated)
Allocates a new EPPRecipient with differnt child elements
based on the input parameters. |
Method Summary | |
---|---|
void |
addOurs(java.lang.String aOursDesc)
Add <ours> element with an optional description. |
java.lang.Object |
clone()
Clone EPPRecipient . |
void |
decode(org.w3c.dom.Element aElement)
decode EPPRecipient from a DOM element tree. |
org.w3c.dom.Element |
encode(org.w3c.dom.Document aDocument)
encode EPPRecipient into a DOM element tree. |
boolean |
equals(java.lang.Object aObject)
implements a deep EPPRecipient compare. |
java.util.Vector |
getOurs()
Gets the ours recipient descriptions. |
boolean |
isOther()
<other> element set? |
boolean |
isPublic()
<public> element set? |
boolean |
isSame()
<same> element set? |
boolean |
isUnrelated()
<unrelated> element set? |
void |
setOther(boolean aOther)
Sets the <other> element. |
void |
setOurs(java.util.Vector aOurs)
Sets the <ours> elements that include a description String per ours element. |
void |
setPublic(boolean aPublic)
Sets the <public> element to specify public forums. |
void |
setSame(boolean aSame)
Sets the <same> element to specify other entities following server practices. |
void |
setUnrelated(boolean aUnrelated)
Sets the <unrelated> element to specify Unrelated third parties. |
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 |
Constructor Detail |
---|
public EPPRecipient()
public EPPRecipient(boolean aOther, java.util.Vector aOurs, boolean aPublic, boolean aSame, boolean aUnrelated)
EPPRecipient
with differnt child elements
based on the input parameters. The child element are created based on
the following input parameter values: other
is created
Vector
of String
that describes the
recipient. A null String
indicates that the recipient
has no description.
public
is created
same
is created
unrelated
is created
aOther
- DOCUMENT ME!aOurs
- DOCUMENT ME!aPublic
- DOCUMENT ME!aSame
- DOCUMENT ME!aUnrelated
- DOCUMENT ME!Method Detail |
---|
public boolean isOther()
true
if is set; false
otherwise.public void setOther(boolean aOther)
aOther
- true
to include the <other> element;
false
otherwise.public java.util.Vector getOurs()
null
description
indicates a ours recipient without a description.
Vector
of String
ours descriptions if
defined; null
otherwise.public void setOurs(java.util.Vector aOurs)
String
per ours
element. A
null
String
indicates no description for the
<ours> element.
aOurs
- Vector
of nullable String
<ours> descriptionspublic void addOurs(java.lang.String aOursDesc)
null
aOursDesc represents a description, while a
null
value represents a <ours> element without a
description.
aOursDesc
- A nullable <ours> descriptionpublic boolean isPublic()
true
if is set; false
otherwise.public void setPublic(boolean aPublic)
aPublic
- true
to include the <public> element;
false
otherwise.public boolean isSame()
true
if is set; false
otherwise.public void setSame(boolean aSame)
aSame
- true
to include the <same> element;
false
otherwise.public boolean isUnrelated()
true
if is set; false
otherwise.public void setUnrelated(boolean aUnrelated)
aUnrelated
- true
to include the <unrelated>
element; false
otherwise.public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPRecipient
into a DOM element tree. The
"recipient" element is created and the child nodes are appended
as children.
encode
in interface EPPCodecComponent
aDocument
- DOCUMENT ME!
EPPEncodeException
- Error encoding the DOM element tree.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPRecipient
from a DOM element tree. The
aElement
argument needs to be the <recipient> element
decode
in interface EPPCodecComponent
aElement
- root element tree.
EPPDecodeException
- Error decoding the DOM element tree.public boolean equals(java.lang.Object aObject)
EPPRecipient
compare.
equals
in class java.lang.Object
aObject
- EPPRecipient
instance to compare with
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPRecipient
.
clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPRecipient
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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |