|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.reseller.EPPResellerDisclose
public class EPPResellerDisclose
Represents a reseller disclose definition.
Nested Class Summary | |
---|---|
static class |
EPPResellerDisclose.Type
Localized type with one of the following values: LOC - Localized form of data that MAY be represented in
unrestricted UTF-8. |
Field Summary | |
---|---|
static java.lang.String |
ELM_LOCALNAME
XML local name for EPPResellerDisclose . |
static java.lang.String |
ELM_NAME
XML root tag for EPPResellerContact . |
Constructor Summary | |
---|---|
EPPResellerDisclose()
EPPResellerDisclose default constructor. |
|
EPPResellerDisclose(boolean aFlag)
EPPResellerDisclose that takes the required disclosure flag
attribute. |
Method Summary | |
---|---|
void |
addAddress(EPPResellerDisclose.Type aType)
Adds an address element with the specific type to the list of addresses. |
void |
addName(EPPResellerDisclose.Type aType)
Adds a name element with the specific type to the list of names. |
void |
addOrg(EPPResellerDisclose.Type aType)
Adds an org element with the specific type to the list of orgs. |
java.lang.Object |
clone()
Clone EPPResellerDisclose . |
void |
decode(org.w3c.dom.Element aElement)
Decode the EPPResellerDisclose 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 EPPResellerDisclose instance. |
boolean |
equals(java.lang.Object aObject)
implements a deep EPPResellerDisclose compare. |
java.util.List<EPPResellerDisclose.Type> |
getAddresses()
Gets disclose address types set. |
java.util.List<EPPResellerDisclose.Type> |
getNames()
Gets disclose names types set. |
java.util.List<EPPResellerDisclose.Type> |
getOrgs()
Gets disclose org types set. |
boolean |
hasAddresses()
Are any addresses defined in the list of addresses? |
boolean |
hasNames()
Are any names defined in the list of names? |
boolean |
hasOrgs()
Are any orgs defined in the list of orgs? |
boolean |
isContact()
Is the contact element included in the disclosure? |
boolean |
isEmail()
Is the email element included in the disclosure? |
boolean |
isFax()
Is the fax element included in the disclosure? |
boolean |
isFlag()
Is the client preference to allow disclosure? |
boolean |
isUrl()
Is the url element included in the disclosure? |
boolean |
isVoice()
Will the voice element included in the disclosure? |
void |
setAddresses(java.util.List<EPPResellerDisclose.Type> aAddresses)
Sets disclose address types. |
void |
setContact(boolean aContact)
Sets the inclusion of the contact element in the disclosure. |
void |
setEmail(boolean aEmail)
Sets the inclusion of the email element in the disclosure. |
void |
setFax(boolean aFax)
Sets the inclusion of the fax element in the disclosure. |
void |
setFlag(boolean aFlag)
Sets the client preference for disclosure. |
void |
setNames(java.util.List<EPPResellerDisclose.Type> aNames)
Sets disclose name types. |
void |
setOrgs(java.util.List<EPPResellerDisclose.Type> aOrgs)
Sets disclose org types. |
void |
setUrl(boolean aUrl)
Sets the inclusion of the url element in the disclosure. |
void |
setVoice(boolean aVoice)
Sets the inclusion of the voice element in the disclosure. |
java.lang.String |
toString()
Implementation of Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
protected void |
validateState()
Validate the state of the EPPResllerDisclose instance. |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ELM_LOCALNAME
EPPResellerDisclose
.
public static final java.lang.String ELM_NAME
EPPResellerContact
.
Constructor Detail |
---|
public EPPResellerDisclose()
EPPResellerDisclose
default constructor. Must call required
setter methods before invoking encode(Document)
.
public EPPResellerDisclose(boolean aFlag)
EPPResellerDisclose
that takes the required disclosure flag
attribute.
aFlag
- true
if the client preference is to allow
disclosure; false
otherwise to indicate that the
client preference is to not allow disclosure.Method Detail |
---|
public boolean hasNames()
true
if there is at least one name defined;
false
otherwise.public void addName(EPPResellerDisclose.Type aType)
aType
- Type of name element to add to the list of names.public java.util.List<EPPResellerDisclose.Type> getNames()
List
of name Type
values.public void setNames(java.util.List<EPPResellerDisclose.Type> aNames)
aNames
- List
of name Type
values.public boolean hasOrgs()
true
if there is at least one org defined;
false
otherwise.public void addOrg(EPPResellerDisclose.Type aType)
aType
- Type of org element to add to the list of orgs.public java.util.List<EPPResellerDisclose.Type> getOrgs()
List
of org Type
values.public void setOrgs(java.util.List<EPPResellerDisclose.Type> aOrgs)
aOrgs
- List
of org Type
values.public boolean hasAddresses()
true
if there is at least one address defined;
false
otherwise.public void addAddress(EPPResellerDisclose.Type aType)
aType
- Type of address element to add to the list of addresses.public java.util.List<EPPResellerDisclose.Type> getAddresses()
List
of address Type
values.public void setAddresses(java.util.List<EPPResellerDisclose.Type> aAddresses)
aAddresses
- List
of address Type
values.public boolean isFlag()
true
if the client preference is to allow
disclosure; false
otherwise to indicate that the
client preference is to not allow disclosure.public void setFlag(boolean aFlag)
aFlag
- true
if the client preference is to allow
disclosure; false
otherwise to indicate that the
client preference is to not allow disclosure.public boolean isVoice()
true
if the voice element is included in the
disclosure; false
otherwise.public void setVoice(boolean aVoice)
aVoice
- true
to include the voice element in the
disclosure; false
otherwise.public boolean isFax()
true
if the fax element is included in the
disclosure; false
otherwise.public void setFax(boolean aFax)
aFax
- true
to include the fax element in the
disclosure; false
otherwise.public boolean isEmail()
true
if the email element is included in the
disclosure; false
otherwise.public void setEmail(boolean aEmail)
aEmail
- true
to include the email element in the
disclosure; false
otherwise.public boolean isUrl()
true
to include the url element in the disclosure;
false
otherwise.public void setUrl(boolean aUrl)
aUrl
- true
to include the url element in the
disclosure; false
otherwise.public boolean isContact()
true
to include the contact element in the
disclosure; false
otherwise.public void setContact(boolean aContact)
aContact
- true
to include the contact element in the
disclosure; false
otherwise.public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPResellerDisclose
instance.
encode
in interface EPPCodecComponent
aDocument
- DOM Document that is being built. Used as an Element factory.
EPPResellerDisclose
.
EPPEncodeException
- On errorpublic void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPResellerDisclose
attributes from the aElement
DOM Element tree.
decode
in interface EPPCodecComponent
aElement
- Root DOM Element to decode EPPResellerDisclose
from.
EPPDecodeException
- Unable to decode aElementpublic boolean equals(java.lang.Object aObject)
EPPResellerDisclose
compare.
equals
in class java.lang.Object
aObject
- EPPResellerDisclose
instance to compare with
true
if this object is the same as the aObject argument;
false
otherwisepublic java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPResellerDisclose
.
clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPResellerDisclose
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.protected void validateState() throws EPPEncodeException
EPPResllerDisclose
instance. A
valid state means that all of the required attributes have been set. If
validateState returns without an exception, the state is valid. If the
state is not valid, the EPPCodecException will contain a description of
the error. throws EPPCodecException State error. This will contain the
name of the attribute that is not valid.
EPPEncodeException
- Error with the state
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |