de.knipp.rritoolkit.request
Class ContactCreateRequest

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

public class ContactCreateRequest
extends Request

request to create a given contact

Version:
$Revision: 14936 $
Author:
Klaus Malorny

Field Summary
private  ContactData contact
          the contact data
 
Constructor Summary
ContactCreateRequest()
          constructor
ContactCreateRequest(ContactData theContact)
          constructor
 
Method Summary
 ContactCreateResponse execute(Port port)
          execute the this request on the given port.
protected  java.lang.String getActionCode()
          return the action string for this request
 ContactData getContact()
          return the contact
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 setContact(ContactData theContact)
          set the contact that shall be created
 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

contact

private ContactData contact
the contact data

Constructor Detail

ContactCreateRequest

public ContactCreateRequest()
constructor


ContactCreateRequest

public ContactCreateRequest(ContactData theContact)
constructor

Parameters:
theContact - the contact
Method Detail

execute

public ContactCreateResponse 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

setContact

public void setContact(ContactData theContact)
set the contact that shall be created

Parameters:
theContact - the contact

getContact

public ContactData getContact()
return the contact

Returns:
the contact or null if it hasn't been set yet


Copyright © 2005-2011 Knipp Medien und Kommunikation GmbH