|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.gen.EPPCommand
com.verisign.epp.codec.gen.EPPInfoCmd
com.verisign.epp.codec.suggestion.EPPSuggestionInfoCmd
public class EPPSuggestionInfoCmd
Represents an EPP Suggestion <info> command that is used to retrieve
domain name suggestions. The <suggestion:info> element MUST contain the
following child elements:
getKey
and
setKey
to get and set the element.getLanguage
and
setLanguage
to get and set the element. If not specified, this
element defaults to ENG (english)EPPSuggestionInfoResp
is the concrete EPPReponse
associated with EPPSuggestionInfoCmd
.
EPPSuggestionInfoResp
,
Serialized FormField Summary |
---|
Fields inherited from class com.verisign.epp.codec.gen.EPPCommand |
---|
extensions, OP_APPROVE, OP_CANCEL, OP_QUERY, OP_REJECT, OP_REQUEST, transId, TYPE_CHECK, TYPE_CREATE, TYPE_DELETE, TYPE_INFO, TYPE_LOGIN, TYPE_LOGOUT, TYPE_POLL, TYPE_RENEW, TYPE_TRANSFER, TYPE_UPDATE |
Constructor Summary | |
---|---|
EPPSuggestionInfoCmd()
Constructor. |
|
EPPSuggestionInfoCmd(java.lang.String aTransId)
Constructor. |
Method Summary | |
---|---|
java.lang.Object |
clone()
Clone EPPCommand . |
protected void |
doDecode(org.w3c.dom.Element aElement)
Must be defined by EPPInfoCmd extensions (Command Mappings)
to decode the attributes to a DOM Element tree. |
protected org.w3c.dom.Element |
doEncode(org.w3c.dom.Document aDocument)
Must be defined by EPPInfoCmd extensions (Command Mappings)
to encode the attributes to a DOM Element tree. |
boolean |
equals(java.lang.Object o)
Compares an instance of EPPInfoCmd with this instance. |
EPPSuggestionFilter |
getFilter()
Filter getter. |
UnsignedLong |
getFilterId()
FilterId getter. |
java.lang.String |
getKey()
Key getter. |
java.lang.String |
getLanguage()
Returns the value for the language element, which should be
one of the
EPPSuggestionConstants language
code constants. |
java.lang.String |
getNamespace()
Gets the EPP command Namespace associated with EPPSuggestionInfoCmd . |
java.lang.String |
getSubId()
SubId getter. |
void |
setFilter(EPPSuggestionFilter aFilter)
Filter setter. |
void |
setFilterId(long aFilterId)
Filter id setter. |
void |
setFilterId(UnsignedLong aFilterId)
Filter id setter. |
void |
setKey(java.lang.String aKey)
Key setter. |
void |
setLanguage(java.lang.String aLanguage)
Set the desired language code. |
void |
setSubId(java.lang.String aSubId)
SubId setter. |
java.lang.String |
toString()
Implementation of Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
void |
unsetFilterId()
Unset the filter id. |
Methods inherited from class com.verisign.epp.codec.gen.EPPInfoCmd |
---|
doGenDecode, doGenEncode, getType |
Methods inherited from class com.verisign.epp.codec.gen.EPPCommand |
---|
addExtension, decode, encode, getExtension, getExtension, getExtensions, getOp, getTransId, hasExtension, hasExtensions, hasTransId, setExtension, setExtensions, setTransId |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public EPPSuggestionInfoCmd()
public EPPSuggestionInfoCmd(java.lang.String aTransId)
aTransId
- a transaction idMethod Detail |
---|
public EPPSuggestionFilter getFilter()
public UnsignedLong getFilterId()
public java.lang.String getKey()
public java.lang.String getSubId()
public java.lang.String getNamespace()
EPPSuggestionInfoCmd
.
getNamespace
in interface EPPMessage
getNamespace
in class EPPCommand
EPPSuggestionMapFactory.NS
public void setFilter(EPPSuggestionFilter aFilter)
aFilter
- a filterpublic void setFilterId(long aFilterId) throws InvalidValueException
aFilterId
- a filter id
InvalidValueException
public void setFilterId(UnsignedLong aFilterId)
aFilterId
- a filter id
InvalidValueException
public void unsetFilterId()
public void setKey(java.lang.String aKey)
aKey
- a keypublic void setSubId(java.lang.String aSubId)
aSubId
- a subIdpublic java.lang.String getLanguage()
language
element, which should be
one of the
EPPSuggestionConstants
language
code constants.
EPPSuggestionConstants.ENGLISH_CODE
EPPSuggestionConstants.ENGLISH_CODE
,
EPPSuggestionConstants.GERMAN_CODE
,
EPPSuggestionConstants.SPANISH_CODE
,
EPPSuggestionConstants.PORTUGUESE_CODE
,
EPPSuggestionConstants.FRENCH_CODE
public void setLanguage(java.lang.String aLanguage)
language
code.
aLanguage
- One of the
EPPSuggestionConstants
language code constants.EPPSuggestionConstants.ENGLISH_CODE
,
EPPSuggestionConstants.GERMAN_CODE
,
EPPSuggestionConstants.SPANISH_CODE
,
EPPSuggestionConstants.PORTUGUESE_CODE
,
EPPSuggestionConstants.FRENCH_CODE
public java.lang.String toString()
Object.toString
, which will result in an
indented XML String
representation of the concrete
EPPCodecComponent
.
toString
in class EPPCommand
String
if successful;
ERROR
otherwise.protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPInfoCmd
EPPInfoCmd
extensions (Command Mappings)
to decode the attributes to a DOM Element tree.
doGenDecode
is a Template Method and this
method is a Primitive Operation within the Template Method
Design Pattern.
doDecode
in class EPPInfoCmd
aElement
- Root DOM Element representing the
EPPInfoCmd
extension instance.
EPPDecodeException
- Unable to decode aElement
.protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPInfoCmd
EPPInfoCmd
extensions (Command Mappings)
to encode the attributes to a DOM Element tree.
doGenEncode
is a Template Method and this
method is a Primitive Operation within the Template Method
Design Pattern.
doEncode
in class EPPInfoCmd
aDocument
- - DOM Document that is being built. Used as an Element
factory.
EPPEncodeException
- Unable to encode EPPInfoCmd extension
instance.public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPCommand
EPPCommand
.
clone
in interface EPPCodecComponent
clone
in class EPPCommand
EPPCommand
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic boolean equals(java.lang.Object o)
EPPInfoCmd
EPPInfoCmd
with this instance.
equals
in class EPPInfoCmd
o
- Object to compare with.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |