|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.contact.EPPContactDisclose
public class EPPContactDisclose
Represents a contact disclose definition.
Field Summary | |
---|---|
static java.lang.String |
ATTR_FLAG_FALSE
Deprecated. Flag should not be get or set via a String . |
static java.lang.String |
ATTR_FLAG_TRUE
Deprecated. Flag should not be get or set via a String . |
static java.lang.String |
ATTR_TYPE_INT
Value of the INT in contact disclose type mapping |
static java.lang.String |
ATTR_TYPE_LOC
Value of the LOC in contact disclose type mapping |
static java.lang.String |
ELM_LOCALNAME
Constant for disclose local name |
static java.lang.String |
ELM_NAME
Constant for the disclose full name |
Constructor Summary | |
---|---|
EPPContactDisclose()
EPPContactDisclose default constructor. |
|
EPPContactDisclose(boolean aFlag,
boolean aNameInt,
boolean aNameLoc,
boolean aOrgInt,
boolean aOrgLoc,
boolean aAddrInt,
boolean aAddrLoc,
boolean aVoice,
boolean aFax,
boolean aEmail)
EPPContactDisclose constructor that takes all of the disclose
settings. |
Method Summary | |
---|---|
java.lang.Object |
clone()
Clone EPPContactDisclose . |
void |
decode(org.w3c.dom.Element aElement)
Decode the EPPContactDisclose 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 EPPContactDisclose instance. |
boolean |
equals(java.lang.Object aObject)
implements a deep EPPContactDisclose compare. |
java.util.Vector |
getAddresses()
Deprecated. Use isAddrInt() and isAddrLoc() instead. |
java.lang.String |
getEmail()
Deprecated. Use isEmail() instead. |
java.lang.String |
getFax()
Deprecated. Use isFax() instead. |
java.lang.String |
getFlag()
Deprecated. |
java.util.Vector |
getNames()
Deprecated. Use isNameInt() and isNameLoc() instead. |
java.util.Vector |
getOrgs()
Deprecated. Use isOrgInt() and isOrgLoc() instead. |
java.lang.String |
getRootName()
Gets the root tag name for the disclose. |
java.lang.String |
getVoice()
Deprecated. Use isVoice() instead. |
boolean |
isAddrInt()
Is the internationalized addr element set? |
boolean |
isAddrLoc()
Is the localized addr element set? |
boolean |
isAll()
Are all of the disclose elements set? |
boolean |
isAllInt()
Are all of the internationalized disclose elements set? |
boolean |
isAllLoc()
Are all of the localized disclose elements set? |
boolean |
isAllOther()
Are all of the other (voice, fax, email) disclose elements set? |
boolean |
isEmail()
Is the email element set? |
boolean |
isFax()
Is the fax element set? |
boolean |
isFlag()
Is the disclose flag set to true ? |
boolean |
isNameInt()
Is the internationalized name element set? |
boolean |
isNameLoc()
Is the localized name element set? |
boolean |
isOrgInt()
Is the internationalized org element set? |
boolean |
isOrgLoc()
Is the localized org element set? |
boolean |
isVoice()
Is the voice element set? |
void |
setAddresses(java.util.Vector aAddresses)
Deprecated. Use setAddrInt(boolean) and
setAddrLoc(boolean) instead. |
void |
setAddrInt(boolean aAddrInt)
Set to include the internationalized addr element. |
void |
setAddrLoc(boolean aAddrLoc)
Set to include the localized addr element. |
void |
setAll()
Set all of the disclose elements to true . |
void |
setAllInt()
Set all of the internationalized disclose elements to true . |
void |
setAllLoc()
Set all of the localized disclose elements to true . |
void |
setAllOther()
Set all of the other (voice, fax, email) disclose elements to true . |
void |
setEmail(boolean aEmail)
Set to include the email element. |
void |
setEmail(java.lang.String aEmail)
Deprecated. Use setEmail(boolean) instead. |
void |
setFax(boolean aFax)
Set to include the fax element. |
void |
setFax(java.lang.String aFax)
Deprecated. Use setFax(boolean) instead. |
void |
setFlag(boolean aFlag)
Sets the contact disclose flag. |
void |
setFlag(java.lang.String aFlag)
Deprecated. Use setFlag(boolean) instead. |
void |
setNameInt(boolean aNameInt)
Set to include the internationalized name element. |
void |
setNameLoc(boolean aNameLoc)
Set to include the localized name element. |
void |
setNames(java.util.Vector aNames)
Deprecated. Use setNameInt(boolean) and
setNameLoc(boolean) instead. |
void |
setOrgInt(boolean aOrgInt)
Set to include the internationalized org element. |
void |
setOrgLoc(boolean orgLoc)
Set to include the localized org element. |
void |
setOrgs(java.util.Vector aOrgs)
Deprecated. Use setOrgInt(boolean) and
setOrgLoc(boolean) instead. |
void |
setRootName(java.lang.String aRootName)
Set root tag name for contact postal definition. |
void |
setVoice(boolean aVoice)
Set to include the voice element. |
void |
setVoice(java.lang.String aVoice)
Deprecated. Use setVoice(boolean) instead. |
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 |
---|
@Deprecated public static final java.lang.String ATTR_FLAG_FALSE
String
.
@Deprecated public static final java.lang.String ATTR_FLAG_TRUE
String
.
public static final java.lang.String ATTR_TYPE_INT
public static final java.lang.String ATTR_TYPE_LOC
public static final java.lang.String ELM_LOCALNAME
public static final java.lang.String ELM_NAME
Constructor Detail |
---|
public EPPContactDisclose()
EPPContactDisclose
default constructor. Must call required
setter methods before invoking encode(Document)
.
public EPPContactDisclose(boolean aFlag, boolean aNameInt, boolean aNameLoc, boolean aOrgInt, boolean aOrgLoc, boolean aAddrInt, boolean aAddrLoc, boolean aVoice, boolean aFax, boolean aEmail)
EPPContactDisclose
constructor that takes all of the disclose
settings. All of the parameters except for the aFlag
parameter will include the element if the boolean
value is
true
and won't if the boolean
value is
false
.
aFlag
- Disclosure flagaNameInt
- Include the internalized name element in the disclose?aNameLoc
- Include the localized name element in the disclose?aOrgInt
- Include the internationalized org element in the disclose?aOrgLoc
- Include the localized org element in the disclose?aAddrInt
- Include the internationalized address element in the disclose?aAddrLoc
- Include the localized address element in the disclose?aVoice
- Include the voice element in the disclose?aFax
- Include the fax element in the disclose?aEmail
- Include the email element in the disclose?Method Detail |
---|
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPContactDisclose
.
clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPContactDisclose
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPContactDisclose
attributes from the aElement
DOM Element tree.
decode
in interface EPPCodecComponent
aElement
- Root DOM Element to decode EPPContactDisclose
from.
EPPDecodeException
- Unable to decode aElementpublic org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPContactDisclose
instance.
encode
in interface EPPCodecComponent
aDocument
- DOM Document that is being built. Used as an Element factory.
Element
EPPEncodeException
public boolean equals(java.lang.Object aObject)
EPPContactDisclose
compare.
equals
in class java.lang.Object
aObject
- EPPContactDisclose
instance to compare with
true
if equal; false
otherwise@Deprecated public java.util.Vector getAddresses()
isAddrInt()
and isAddrLoc()
instead.
Vector
of EPPContactDiscloseAddress
instances
if at least one address is set; null
otherwise.@Deprecated public java.lang.String getEmail()
isEmail()
instead.
String
if set; null
otherwise.@Deprecated public java.lang.String getFax()
isFax()
instead.
String
if set; null
otherwise.@Deprecated public java.lang.String getFlag()
ATTR_FLAG_TRUE
if true
;
ATTR_FLAG_FALSE
otherwise.@Deprecated public java.util.Vector getNames()
isNameInt()
and isNameLoc()
instead.
Vector
of EPPContactDiscloseName
instances if
at least one name is set; null
otherwise.@Deprecated public java.util.Vector getOrgs()
isOrgInt()
and isOrgLoc()
instead.
Vector
of EPPContactDiscloseOrg
instances if
at least one org is set; null
otherwise.public java.lang.String getRootName()
@Deprecated public java.lang.String getVoice()
isVoice()
instead.
String
if set; null
otherwise.public boolean isAddrInt()
true
if the internationalized addr element is set;
false
otherwise.public boolean isAddrLoc()
true
if the localized addr element is set;
false
otherwise.public boolean isAll()
true
if all of the disclose elements are set;
false
otherwise.public boolean isAllInt()
true
if all of the internationalized disclose
elements are set; false
otherwise.public boolean isAllLoc()
true
if all of the localized disclose elements are
set; false
otherwise.public boolean isAllOther()
true
if all of the other (voice, fax, email) disclose
elements are set; false
otherwise.public boolean isEmail()
true
if the email element is set; false
otherwise.public boolean isFax()
true
if the fax element is set; false
otherwise.public boolean isFlag()
true
?
true
if the disclose flag is set to true
; false
otherwise.public boolean isNameInt()
true
if the internationalized name element is set;
false
otherwise.public boolean isNameLoc()
true
if the localized name element is set;
false
otherwise.public boolean isOrgInt()
true
if the internationalized org element is set;
false
otherwise.public boolean isOrgLoc()
true
if the localized org element is set;
false
otherwise.public boolean isVoice()
true
if the voice element is set; false
otherwise.@Deprecated public void setAddresses(java.util.Vector aAddresses)
setAddrInt(boolean)
and
setAddrLoc(boolean)
instead.
aAddresses
- Vector
of EPPContactDiscloseAddress
instances to set.public void setAddrInt(boolean aAddrInt)
true
the element will be included in the disclose.
aAddrInt
- true
to include the internationalized addr;
false
otherwise.public void setAddrLoc(boolean aAddrLoc)
true
the
element will be included in the disclose.
aAddrLoc
- true
to include the localized addr;
false
otherwise.public void setAll()
true
.
public void setAllInt()
true
.
public void setAllLoc()
true
.
public void setAllOther()
true
.
public void setEmail(boolean aEmail)
true
the element will be
included in the disclose.
aEmail
- true
to include the email; false
otherwise.@Deprecated public void setEmail(java.lang.String aEmail)
setEmail(boolean)
instead.
aEmail
- null
to set email element to false
;
otherwise set email element to true
.public void setFax(boolean aFax)
true
the element will be
included in the disclose.
aFax
- true
to include the fax; false
otherwise.@Deprecated public void setFax(java.lang.String aFax)
setFax(boolean)
instead.
aEmail
- null
to set fax element to false
;
otherwise set fax element to true
.public void setFlag(boolean aFlag)
aFlag
- true
to allow disclosure as an exception to the
stated data-collection policy; false
to not allow
disclosure of the specified elements as an exception to the
stated data-collection policy.@Deprecated public void setFlag(java.lang.String aFlag)
setFlag(boolean)
instead.
aFlag
- ATTR_FLAG_TRUE
if true
and
ATTR_FLAG_FALSE
if false
.public void setNameInt(boolean aNameInt)
true
the element will be included in the disclose.
aNameInt
- true
to include the internationalized name;
false
otherwise.public void setNameLoc(boolean aNameLoc)
true
the
element will be included in the disclose.
aNameLoc
- true
to include the localized name;
false
otherwise.@Deprecated public void setNames(java.util.Vector aNames)
setNameInt(boolean)
and
setNameLoc(boolean)
instead.
aNames
- Vector
of EPPContactDiscloseName
instances
to set.public void setOrgInt(boolean aOrgInt)
true
the
element will be included in the disclose.
aOrgInt
- true
to include the internationalized org;
false
otherwise.public void setOrgLoc(boolean orgLoc)
true
the element
will be included in the disclose.
aOrgInt
- true
to include the localized org;
false
otherwise.@Deprecated public void setOrgs(java.util.Vector aOrgs)
setOrgInt(boolean)
and
setOrgLoc(boolean)
instead.
aOrgs
- Vector
of EPPContactDiscloseOrg
instances
to set.public void setRootName(java.lang.String aRootName)
aRootName
- Stringpublic void setVoice(boolean aVoice)
true
the element will be
included in the disclose.
aVoice
- true
to include the voice; false
otherwise.@Deprecated public void setVoice(java.lang.String aVoice)
setVoice(boolean)
instead.
aEmail
- null
to set voice element to false
;
otherwise set voice element to true
.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 |