Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

oracle.calendar.soap.client
Class Calendarlet

java.lang.Object
  |
  +--oracle.calendar.soap.client.CalendarWebService
        |
        +--oracle.calendar.soap.client.Calendarlet
public class Calendarlet
extends CalendarWebService

The Calendarlet class is the main access point to the Calendaring Web Services. This class provides a simple abstraction layer for the generation and processing of the calendar Object Model to XML, to and from the Web Services host, through SOAP.

Field Summary
private static java.lang.String k_createNamespace
           
private static java.lang.String k_deleteNamespace
           
private static java.lang.String k_modifyNamespace
           
private static java.lang.String k_noopNamespace
           
private static java.lang.String k_pingNamespace
           
private static java.lang.String k_searchNamespace
           

 

Fields inherited from class oracle.calendar.soap.client.CalendarWebService
m_authenticationHeader, m_endpoint, m_proxy, m_wantIOBuffers

 

Constructor Summary
Calendarlet()
          The default constructor for the class.
Calendarlet(java.lang.String in_endPointURL)
          The class constructor taking the Web Services host URL.

 

Method Summary
 CalendaringResponse Create(org.w3c.dom.Element in_requestElem)
          The create method will perform an HTTP SOAP request using the Create method.
 CalendaringResponse Delete(org.w3c.dom.Element in_requestElem)
          The delete method will perform an HTTP SOAP request using the Delete method.
 CalendaringResponse Modify(org.w3c.dom.Element in_requestElem)
          The modify method will perform an HTTP SOAP request using the Modify method.
 CalendaringResponse NoOp(org.w3c.dom.Element in_requestElem)
          The Noop method will perform an HTTP SOAP request using the Noop method.
 CalendaringResponse Ping(org.w3c.dom.Element in_requestElem)
          The ping method will perform an HTTP SOAP request using the Ping method.
private  CalendaringResponse processSOAPRequest(org.w3c.dom.Element in_requestElem, java.lang.String in_soapAction)
          This is the work horse method that will perform the SOAP transactions.
 CalendaringResponse Search(org.w3c.dom.Element in_requestElem)
          The search method will perform an HTTP SOAP request using the Search method.

 

Methods inherited from class oracle.calendar.soap.client.CalendarWebService
getAuthenticationHeader, getEndPointURL, getProxy, getWantIOBuffers, setAuthenticationHeader, setEndPointURL, setProxy, setWantIOBuffers

 

Methods inherited from class java.lang.Object
<clinit>, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait

 

Field Detail

k_createNamespace

private static java.lang.String k_createNamespace

k_deleteNamespace

private static java.lang.String k_deleteNamespace

k_modifyNamespace

private static java.lang.String k_modifyNamespace

k_noopNamespace

private static java.lang.String k_noopNamespace

k_pingNamespace

private static java.lang.String k_pingNamespace

k_searchNamespace

private static java.lang.String k_searchNamespace
Constructor Detail

Calendarlet

public Calendarlet()
The default constructor for the class.

Calendarlet

public Calendarlet(java.lang.String in_endPointURL)
The class constructor taking the Web Services host URL.
Parameters:
in_endPointURL - the Web Services host URL
Method Detail

Create

public CalendaringResponse Create(org.w3c.dom.Element in_requestElem)
                           throws java.lang.Exception
The create method will perform an HTTP SOAP request using the Create method. The input element is the XML DOM returned from the CreateCommand's getElement() method. The response object will contain the parsed XML received from the host Web Services. This method can cause an exception for various reasons, however a SOAP fault is not one of them. The SOAP fault will be returned in the response.
Parameters:
in_requestElem - the XML DOM to send
Returns:
CalendaringResponse the SOAP packet from the host
Throws:
java.lang.Exception - lower level calls throw exceptions
See Also:
CreateCommand

Modify

public CalendaringResponse Modify(org.w3c.dom.Element in_requestElem)
                           throws java.lang.Exception
The modify method will perform an HTTP SOAP request using the Modify method. The input element is the XML DOM returned from the ModifyCommand's getElement() method. The response object will contain the parsed XML received from the host Web Services. This method can cause an exception for various reasons, however a SOAP fault is not one of them. The SOAP fault will be returned in the response.
Parameters:
in_requestElem - the XML DOM to send
Returns:
CalendaringResponse the SOAP packet from the host
Throws:
java.lang.Exception - lower level calls throw exceptions
See Also:
ModifyCommand

Delete

public CalendaringResponse Delete(org.w3c.dom.Element in_requestElem)
                           throws java.lang.Exception
The delete method will perform an HTTP SOAP request using the Delete method. The input element is the XML DOM returned from the DeleteCommand's getElement() method. The response object will contain the parsed XML received from the host Web Services. This method can cause an exception for various reasons, however a SOAP fault is not one of them. The SOAP fault will be returned in the response.
Parameters:
in_requestElem - the XML DOM to send
Returns:
CalendaringResponse the SOAP packet from the host
Throws:
java.lang.Exception - lower level calls throw exceptions
See Also:
DeleteCommand

Search

public CalendaringResponse Search(org.w3c.dom.Element in_requestElem)
                           throws java.lang.Exception
The search method will perform an HTTP SOAP request using the Search method. The input element is the XML DOM returned from the SearchCommand's getElement() method. The response object will contain the parsed XML received from the host Web Services. This method can cause an exception for various reasons, however a SOAP fault is not one of them. The SOAP fault will be returned in the response.
Parameters:
in_requestElem - the XML DOM to send
Returns:
CalendaringResponse the SOAP packet from the host
Throws:
java.lang.Exception - lower level calls throw exceptions
See Also:
SearchCommand

NoOp

public CalendaringResponse NoOp(org.w3c.dom.Element in_requestElem)
                         throws java.lang.Exception
The Noop method will perform an HTTP SOAP request using the Noop method. The input element is the XML DOM returned from the NoopCommand's getElement() method. The response object will contain the parsed XML received from the host Web Services. This method can cause an exception for various reasons, however a SOAP fault is not one of them. The SOAP fault will be returned in the response.
Parameters:
in_requestElem - the XML DOM to send
Returns:
CalendaringResponse the SOAP packet from the host
Throws:
java.lang.Exception - lower level calls throw exceptions
See Also:
NoopCommand

Ping

public CalendaringResponse Ping(org.w3c.dom.Element in_requestElem)
                         throws java.lang.Exception
The ping method will perform an HTTP SOAP request using the Ping method. The input element is the XML DOM returned from the PingCommand's getElement() method. The response object will contain the parsed XML received from the host Web Services. This method can cause an exception for various reasons, however a SOAP fault is not one of them. The SOAP fault will be returned in the response.
Parameters:
in_requestElem - the XML DOM to send
Returns:
CalendaringResponse the SOAP packet from the host
Throws:
java.lang.Exception - lower level calls throw exceptions
See Also:
PingCommand

processSOAPRequest

private CalendaringResponse processSOAPRequest(org.w3c.dom.Element in_requestElem,
                                               java.lang.String in_soapAction)
                                        throws java.lang.Exception
This is the work horse method that will perform the SOAP transactions. All the public methods call this to do the work.
Parameters:
in_requestElem - the XML DOM to send
in_soapAction - the SOAP namespace
Returns:
CalendaringResponse the SOAP packet from the host
Throws:
java.lang.Exception - lower level calls throw exceptions
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD