|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.gen.EPPResponse
com.verisign.epp.codec.suggestion.EPPSuggestionInfoResp
public class EPPSuggestionInfoResp
An EPPSuggestionInfoResp
provides an answer to an
EPPSuggestionInfoCmd
and includes the following attributes:
EPPSuggestionInfoCmd
key
EPPSuggestionInfoCmd
,
Serialized FormField Summary |
---|
Fields inherited from class com.verisign.epp.codec.gen.EPPResponse |
---|
extensions, TRANSFER_CLIENT_APPROVED, TRANSFER_CLIENT_CANCELLED, TRANSFER_CLIENT_REJECTED, TRANSFER_PENDING, TRANSFER_SERVER_APPROVED, TRANSFER_SERVER_CANCELLED |
Constructor Summary | |
---|---|
EPPSuggestionInfoResp()
Default constructor that needs the key attribute and the
transid attribute set prior to calling encode . |
|
EPPSuggestionInfoResp(EPPTransId aTransId)
Creates an EPPSuggestionInfoResp only the transaction id
set. |
|
EPPSuggestionInfoResp(EPPTransId aTransId,
java.lang.String aKey)
Creates an EPPSuggestionInfoResp with the required
attributes set. |
|
EPPSuggestionInfoResp(EPPTransId aTransId,
java.lang.String aKey,
java.lang.String aLanguage,
java.util.List<EPPSuggestionToken> aTokens,
EPPSuggestionAnswer aAnswer)
Creates an EPPSuggestionInfoResp with the all the
attributes. |
Method Summary | |
---|---|
void |
addToken(EPPSuggestionToken aToken)
Adds a suggestion token to the response. |
java.lang.Object |
clone()
Clone EPPResponse . |
protected void |
doDecode(org.w3c.dom.Element aElement)
Decodes the attributes of the concrete EPPResponse and must
be overridden by EPPResponse derived classes. |
protected org.w3c.dom.Element |
doEncode(org.w3c.dom.Document aDocument)
Encodes the attributes of the concrete EPPResponse and must
be overridden by EPPResponse derived classes. |
boolean |
equals(java.lang.Object o)
implements a deep EPPResponse compare. |
EPPSuggestionAnswer |
getAnswer()
Gets the suggestion answer that is either in table or grid view. |
java.lang.String |
getKey()
Gets the suggestion key. |
java.lang.String |
getLanguage()
|
java.lang.String |
getNamespace()
Gets the EPP command namespace associated with EPPSuggestionInfoResp . |
java.util.List<EPPSuggestionToken> |
getTokens()
Gets the suggestion tokens. |
java.lang.String |
getType()
Gets the EPP response type associated with EPPSuggestionInfoResp . |
boolean |
hasAnswer()
Is the answer defined? |
boolean |
hasTokens()
Does the response have tokens defined? |
void |
resetTokens()
Resets the tokens to an empty list. |
void |
setAnswer(EPPSuggestionAnswer aAnswer)
Sets the suggestion answer in either table or grid view. |
void |
setKey(java.lang.String aKey)
Sets the suggestion key |
void |
setLanguage(java.lang.String aLanguage)
sets the suggestion language |
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 com.verisign.epp.codec.gen.EPPResponse |
---|
addExtension, decode, encode, getExtension, getExtension, getExtensions, getMessageQueue, getMsgQueue, getMsgQueueCount, getMsgQueueDate, getMsgQueueMsg, getQDate, getResult, getResults, getTransId, hasExtension, hasExtensions, hasMessageQueue, hasMsgQueue, hasResultCode, isSuccess, setExtension, setExtensions, setMsgQueue, setResult, setResult, setResult, setResult, setResults, setTransId |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public EPPSuggestionInfoResp()
key
attribute and the
transid attribute set prior to calling encode
.
public EPPSuggestionInfoResp(EPPTransId aTransId)
EPPSuggestionInfoResp
only the transaction id
set. The key
attribute must be set prior to calling
encode
.
aTransId
- The transaction id containing the server transaction and
optionally the client transaction idpublic EPPSuggestionInfoResp(EPPTransId aTransId, java.lang.String aKey)
EPPSuggestionInfoResp
with the required
attributes set.
aTransId
- The transaction id containing the server transaction and
optionally the client transaction idaKey
- Suggestion keypublic EPPSuggestionInfoResp(EPPTransId aTransId, java.lang.String aKey, java.lang.String aLanguage, java.util.List<EPPSuggestionToken> aTokens, EPPSuggestionAnswer aAnswer)
EPPSuggestionInfoResp
with the all the
attributes.
aTransId
- The transaction id containing the server transaction and
optionally the client transaction idaKey
- Suggestion keyaLanguage
- Suggestion languageaTokens
- The optional suggestion tokensaAnswer
- the optional answer in table or grid viewMethod Detail |
---|
public void addToken(EPPSuggestionToken aToken) throws InvalidValueException
aToken
- Suggestion token to add
InvalidValueException
public boolean hasAnswer()
true
if is defined;false
otherwise.public EPPSuggestionAnswer getAnswer()
null
otherwise.public java.lang.String getKey()
public java.lang.String getNamespace()
EPPSuggestionInfoResp
.
getNamespace
in interface EPPMessage
getNamespace
in class EPPResponse
EPPSuggestionMapFactory.NS
public boolean hasTokens()
true
if is defined;false
otherwise.public java.util.List<EPPSuggestionToken> getTokens()
null
otherwise.public java.lang.String getType()
EPPSuggestionInfoResp
.
getType
in class EPPResponse
EPPSuggestionInfoResp.ELM_NAME
public void resetTokens()
public void setAnswer(EPPSuggestionAnswer aAnswer)
aAnswer
- The suggestion answerpublic void setKey(java.lang.String aKey)
aKey
- Suggestion keypublic java.lang.String getLanguage()
public void setLanguage(java.lang.String aLanguage)
aLanguage
- The language to set - a null value will force the default to be setpublic java.lang.String toString()
Object.toString
, which will result in an
indented XML String
representation of the concrete
EPPCodecComponent
.
toString
in class EPPResponse
String
if successful;
ERROR
otherwise.protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPResponse
EPPResponse
and must
be overridden by EPPResponse
derived classes. The default
implementation is to do nothing, since EPPResponse
is a
concrete class. decode
is a Template Method and
this method is a Primitive Operation within the Template Method
Design Pattern.
doDecode
in class EPPResponse
aElement
- root DOM element associated with instance
EPPDecodeException
- Error decoding the DOM element tree.protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPResponse
EPPResponse
and must
be overridden by EPPResponse
derived classes. The default
implementation is to do nothing, since EPPResponse
is a
concrete class. encode
is a Template Method and
this method is a Primitive Operation within the Template Method
Design Pattern.
doEncode
in class EPPResponse
aDocument
- DOM document used as a factory of DOM objects.
EPPEncodeException
- Error encoding the DOM element tree.public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPResponse
EPPResponse
.
clone
in interface EPPCodecComponent
clone
in class EPPResponse
EPPResponse
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic boolean equals(java.lang.Object o)
EPPResponse
EPPResponse
compare.
equals
in class EPPResponse
o
- EPPResponse
instance to compare with
true
if equal; false
otherwise
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |