\section{IHandler\-Soap\-Serializer Class Reference}
\label{classIHandlerSoapSerializer}\index{IHandlerSoapSerializer@{IHandlerSoapSerializer}}
interface for the IHandler\-Soap\-Serializer class. This interface is exposed to a {\bf Handler} {\rm (p.\,\pageref{classHandler})} Writer, to let him manipulate on the Serialzer object. Example usage is given below. 


{\tt \#include $<$IHandler\-Soap\-Serializer.h$>$}

Inheritance diagram for IHandler\-Soap\-Serializer::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=3cm]{classIHandlerSoapSerializer}
\end{center}
\end{figure}
\subsection*{Public Methods}
\begin{CompactItemize}
\item 
virtual {\bf IHeader\-Block} $\ast$ {\bf create\-Header\-Block} ()=0
\item 
virtual {\bf IHeader\-Block} $\ast$ {\bf create\-Header\-Block} (Axis\-Char $\ast$pach\-Local\-Name, Axis\-Char $\ast$pach\-Uri)=0
\item 
virtual int AXISCALL {\bf add\-Header\-Block} ({\bf IHeader\-Block} $\ast$p\-Blk)=0
\item 
virtual int {\bf set\-Soap\-Header} ({\bf Soap\-Header} $\ast$p\-Soap\-Header)=0
\item 
virtual int {\bf set\-Soap\-Version} (SOAP\_\-VERSION e\-SOAP\_\-VERSION)=0
\item 
virtual {\bf IHeader\-Block} $\ast$ {\bf get\-Header\-Block} ()=0
\item 
virtual {\bf IHeader\-Block} $\ast$ {\bf get\-Header\-Block} (const Axis\-Char $\ast$pc\-Name, const Axis\-Char $\ast$pc\-Namespace)=0
\end{CompactItemize}


\subsection{Detailed Description}
interface for the IHandler\-Soap\-Serializer class. This interface is exposed to a {\bf Handler} {\rm (p.\,\pageref{classHandler})} Writer, to let him manipulate on the Serialzer object. Example usage is given below.

\small\begin{alltt}
 int ESHHandler::invoke(void *pvIMsg)
 \{
	IMessageData *pIMsg = (IMessageData*) pvIMsg;
  AxisChar* pachTemp;
	if(pIMsg->isPastPivot()) \{
		//this is a response

		IHandlerSoapSerializer* pISZ;
		pIMsg->getSoapSerializer(&pISZ);

		{\bf IHeaderBlock} {\rm (p.\,\pageref{classIHeaderBlock})}* pIHeaderBlock= pISZ->{\bf createHeaderBlock()} {\rm (p.\,\pageref{classIHandlerSoapSerializer_a1})};

		pIHeaderBlock->setLocalName("echoMeStringResponse");
 \end{alltt}\normalsize 


\begin{Desc}
\item[Author: ]\par
Roshan Weerasuriya ({\tt roshan@opensource.lk}, {\tt roshanw@jkcsworld.com}) \end{Desc}




\subsection{Member Function Documentation}
\index{IHandlerSoapSerializer@{IHandler\-Soap\-Serializer}!addHeaderBlock@{addHeaderBlock}}
\index{addHeaderBlock@{addHeaderBlock}!IHandlerSoapSerializer@{IHandler\-Soap\-Serializer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual int AXISCALL IHandler\-Soap\-Serializer::add\-Header\-Block ({\bf IHeader\-Block} $\ast$ {\em p\-Blk})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classIHandlerSoapSerializer_a3}


Adds the given Header Block to the Serialzer.\begin{Desc}
\item[Parameters: ]\par
\begin{description}
\item[{\em 
p\-Blk}]The Header Block to be added. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns: ]\par
AXIS\_\-SUCCESS or AXIS\_\-FAIL to indicate success or fail. \end{Desc}


Implemented in {\bf Soap\-Serializer} {\rm (p.\,\pageref{classSoapSerializer_a35})}.\index{IHandlerSoapSerializer@{IHandler\-Soap\-Serializer}!createHeaderBlock@{createHeaderBlock}}
\index{createHeaderBlock@{createHeaderBlock}!IHandlerSoapSerializer@{IHandler\-Soap\-Serializer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf IHeader\-Block}$\ast$ IHandler\-Soap\-Serializer::create\-Header\-Block (Axis\-Char $\ast$ {\em pach\-Local\-Name}, Axis\-Char $\ast$ {\em pach\-Uri})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classIHandlerSoapSerializer_a2}


Will create a Header Block using the given local name and the namespace uri, and adds it to the Serializer.\begin{Desc}
\item[Parameters: ]\par
\begin{description}
\item[{\em 
pach\-Local\-Name}]The local name of the Header Block \item[{\em 
pach\-Uri}]The namespace uri of the Header Block. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns: ]\par
The created Header Block pointer will be returned, which the user can manipulate on it. \end{Desc}


Implemented in {\bf Soap\-Serializer} {\rm (p.\,\pageref{classSoapSerializer_a34})}.\index{IHandlerSoapSerializer@{IHandler\-Soap\-Serializer}!createHeaderBlock@{createHeaderBlock}}
\index{createHeaderBlock@{createHeaderBlock}!IHandlerSoapSerializer@{IHandler\-Soap\-Serializer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf IHeader\-Block}$\ast$ IHandler\-Soap\-Serializer::create\-Header\-Block ()\hspace{0.3cm}{\tt  [pure virtual]}}\label{classIHandlerSoapSerializer_a1}


Will create a Header Block and adds it to the Serializer.

\begin{Desc}
\item[Returns: ]\par
The created Header Block pointer will be returned, which the user can manipulate on it. \end{Desc}


Implemented in {\bf Soap\-Serializer} {\rm (p.\,\pageref{classSoapSerializer_a29})}.\index{IHandlerSoapSerializer@{IHandler\-Soap\-Serializer}!getHeaderBlock@{getHeaderBlock}}
\index{getHeaderBlock@{getHeaderBlock}!IHandlerSoapSerializer@{IHandler\-Soap\-Serializer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf IHeader\-Block}$\ast$ IHandler\-Soap\-Serializer::get\-Header\-Block (const Axis\-Char $\ast$ {\em pc\-Name}, const Axis\-Char $\ast$ {\em pc\-Namespace})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classIHandlerSoapSerializer_a7}


Gets and returns the Header Block of the given local name and  namespace uri.After returning the Header Block pointer, it will not be removed from the available Header Block list of the Serializer. The caller of this method should not delete the returned pointer  object. 

Implemented in {\bf Soap\-Serializer} {\rm (p.\,\pageref{classSoapSerializer_a30})}.\index{IHandlerSoapSerializer@{IHandler\-Soap\-Serializer}!getHeaderBlock@{getHeaderBlock}}
\index{getHeaderBlock@{getHeaderBlock}!IHandlerSoapSerializer@{IHandler\-Soap\-Serializer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf IHeader\-Block}$\ast$ IHandler\-Soap\-Serializer::get\-Header\-Block ()\hspace{0.3cm}{\tt  [pure virtual]}}\label{classIHandlerSoapSerializer_a6}


Gets the Header Block. After returning the Header Block pointer, it  will not be removed from the available Header Block list of the  Serializer.The caller of this method should not delete the returned  pointer object. 

Implemented in {\bf Soap\-Serializer} {\rm (p.\,\pageref{classSoapSerializer_a31})}.\index{IHandlerSoapSerializer@{IHandler\-Soap\-Serializer}!setSoapHeader@{setSoapHeader}}
\index{setSoapHeader@{setSoapHeader}!IHandlerSoapSerializer@{IHandler\-Soap\-Serializer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual int IHandler\-Soap\-Serializer::set\-Soap\-Header ({\bf Soap\-Header} $\ast$ {\em p\-Soap\-Header})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classIHandlerSoapSerializer_a4}


Sets the given Soap Header to the Serializer. If a Soap Header already exists then this method doesn't do anything, but returns a state to indicate this situation.\begin{Desc}
\item[Parameters: ]\par
\begin{description}
\item[{\em 
p\-Soap\-Header}]The Soap Header to be set. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns: ]\par
Returns the following status:\begin{CompactItemize}
\item 
AXIS\_\-FAIL : to indicate failuer.\item 
AXIS\_\-SUCCESS : to indicate success.\item 
AXIS\_\-OBJECT\_\-ALREADY\_\-EXISTS : if a Soap Header already exists. \end{CompactItemize}
\end{Desc}


Implemented in {\bf Soap\-Serializer} {\rm (p.\,\pageref{classSoapSerializer_a13})}.\index{IHandlerSoapSerializer@{IHandler\-Soap\-Serializer}!setSoapVersion@{setSoapVersion}}
\index{setSoapVersion@{setSoapVersion}!IHandlerSoapSerializer@{IHandler\-Soap\-Serializer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual int IHandler\-Soap\-Serializer::set\-Soap\-Version (SOAP\_\-VERSION {\em e\-SOAP\_\-VERSION})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classIHandlerSoapSerializer_a5}


Sets the SOAP Version. \begin{Desc}
\item[Parameters: ]\par
\begin{description}
\item[{\em 
e\-SOAP\_\-VERSION}]The SOAP version to set. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns: ]\par
AXIS\_\-SUCCESS to indicate success. \end{Desc}


Implemented in {\bf Soap\-Serializer} {\rm (p.\,\pageref{classSoapSerializer_a6})}.

The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
IHandler\-Soap\-Serializer.h\end{CompactItemize}
