de.knipp.rritoolkit.request
Class ContactCheckRequest

java.lang.Object
  extended by de.knipp.rritoolkit.request.Request
      extended by de.knipp.rritoolkit.request.ContactCheckRequest

public class ContactCheckRequest
extends Request

request to retrieve the status of a given contact handle

Version:
$Revision: 14936 $
Author:
Klaus Malorny

Field Summary
private  java.lang.String handle
          the handle
 
Constructor Summary
ContactCheckRequest()
          constructor
ContactCheckRequest(java.lang.String theHandle)
          constructor
 
Method Summary
 ContactCheckResponse execute(Port port)
          execute the this request on the given port.
protected  java.lang.String getActionCode()
          return the action string for this request
 java.lang.String getHandle()
          return the handle
protected  void requestToKVList(KVList list)
          method that needs to be implemented by subclasses for the key-value list conversion
protected  void requestToXml(org.w3c.dom.Node node)
          method that needs to be implemented by subclasses for the XML conversion
 void setHandle(java.lang.String theHandle)
          set the handle
 java.lang.String toString()
          return a string representation for debugging purposes
 
Methods inherited from class de.knipp.rritoolkit.request.Request
getClientTxnID, getProtocolVersion, setClientTxnID, toList, toXml
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

handle

private java.lang.String handle
the handle

Constructor Detail

ContactCheckRequest

public ContactCheckRequest()
constructor


ContactCheckRequest

public ContactCheckRequest(java.lang.String theHandle)
constructor

Parameters:
theHandle - the handle
Method Detail

execute

public ContactCheckResponse execute(Port port)
                             throws java.io.IOException
execute the this request on the given port.

Overrides:
execute in class Request
Parameters:
port - the port on which this request shall be executed
Returns:
the response
Throws:
java.io.IOException - if the execution failed

requestToXml

protected void requestToXml(org.w3c.dom.Node node)
                     throws org.w3c.dom.DOMException,
                            EncodeException
method that needs to be implemented by subclasses for the XML conversion

Specified by:
requestToXml in class Request
Parameters:
node - the node where the request shall be added to
Throws:
org.w3c.dom.DOMException - on DOM exceptions
EncodeException - if the encoding fails for some reason

getActionCode

protected java.lang.String getActionCode()
return the action string for this request

Specified by:
getActionCode in class Request
Returns:
the action string

requestToKVList

protected void requestToKVList(KVList list)
                        throws EncodeException
method that needs to be implemented by subclasses for the key-value list conversion

Specified by:
requestToKVList in class Request
Parameters:
list - the list that has to be filled
Throws:
EncodeException - if the encoding fails for some reason

toString

public java.lang.String toString()
return a string representation for debugging purposes

Overrides:
toString in class Request
Returns:
the representation

getHandle

public java.lang.String getHandle()
return the handle

Returns:
the handle

setHandle

public void setHandle(java.lang.String theHandle)
set the handle

Parameters:
theHandle - the handle


Copyright © 2005-2011 Knipp Medien und Kommunikation GmbH