\section{Soap\-Serializer Class Reference}
\label{classSoapSerializer}\index{SoapSerializer@{SoapSerializer}}
interface for the Soap\-Serializer class. 


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

Inheritance diagram for Soap\-Serializer::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=3cm]{classSoapSerializer}
\end{center}
\end{figure}
\subsection*{Public Methods}
\begin{CompactItemize}
\item 
const Axis\-Char $\ast$AXISCALL {\bf get\-Namespace\-Prefix} (const Axis\-Char $\ast$p\-Namespace)
\item 
const Axis\-Char $\ast$AXISCALL {\bf get\-Namespace\-Prefix} (const Axis\-Char $\ast$p\-Namespace, bool \&bln\-Is\-New\-Prefix)
\item 
int {\bf set\-Soap\-Version} (SOAP\_\-VERSION)
\item 
int {\bf set\-Soap\-Header} ({\bf Soap\-Header} $\ast$p\-Soap\-Header)
\item 
{\bf IHeader\-Block} $\ast$ {\bf create\-Header\-Block} ()
\item 
{\bf IHeader\-Block} $\ast$ {\bf get\-Header\-Block} (const Axis\-Char $\ast$pc\-Name, const Axis\-Char $\ast$pc\-Namespace)
\item 
{\bf IHeader\-Block} $\ast$ {\bf get\-Header\-Block} ()
\item 
{\bf IHeader\-Block} $\ast$ {\bf create\-Header\-Block} (Axis\-Char $\ast$pach\-Local\-Name, Axis\-Char $\ast$pach\-Uri)
\item 
int AXISCALL {\bf add\-Header\-Block} ({\bf IHeader\-Block} $\ast$p\-Blk)
\item 
\index{setBodyAsHexBinary@{setBodyAsHexBinary}!SoapSerializer@{SoapSerializer}}\index{SoapSerializer@{SoapSerializer}!setBodyAsHexBinary@{setBodyAsHexBinary}}
int AXISCALL {\bf set\-Body\-As\-Hex\-Binary} ({\bf xsd\_\-\_\-hex\-Binary} body)\label{classSoapSerializer_a43}

\item 
\index{setBodyAsBase64Binary@{setBodyAsBase64Binary}!SoapSerializer@{SoapSerializer}}\index{SoapSerializer@{SoapSerializer}!setBodyAsBase64Binary@{setBodyAsBase64Binary}}
int AXISCALL {\bf set\-Body\-As\-Base64Binary} ({\bf xsd\_\-\_\-base64Binary} body)\label{classSoapSerializer_a44}

\item 
\index{getBodyAsString@{getBodyAsString}!SoapSerializer@{SoapSerializer}}\index{SoapSerializer@{SoapSerializer}!getBodyAsString@{getBodyAsString}}
const Axis\-Char $\ast$AXISCALL {\bf get\-Body\-As\-String} ()\label{classSoapSerializer_a45}

\end{CompactItemize}


\subsection{Detailed Description}
interface for the Soap\-Serializer class.

\begin{Desc}
\item[Author: ]\par
Roshan Weerasuriya ({\tt roshan@jkcs.slt.lk}, {\tt roshan@opensource.lk}) , Susantha Kumara ({\tt susantha@opensource.lk}, {\tt skumara@virtusa.com}) \end{Desc}




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


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}


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


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}


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


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}


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


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. 

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


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. 

Implements {\bf IHandler\-Soap\-Serializer} {\rm (p.\,\pageref{classIHandlerSoapSerializer_a7})}.\index{SoapSerializer@{Soap\-Serializer}!getNamespacePrefix@{getNamespacePrefix}}
\index{getNamespacePrefix@{getNamespacePrefix}!SoapSerializer@{Soap\-Serializer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const Axis\-Char$\ast$ AXISCALL Soap\-Serializer::get\-Namespace\-Prefix (const Axis\-Char $\ast$ {\em p\-Namespace}, bool \& {\em bln\-Is\-New\-Prefix})}\label{classSoapSerializer_a5}


Returns the corrosponding namespace prefix. This method is  called when the caller also wants to know whether this is a new  namespace or not as appose to its overloaded other member. \begin{Desc}
\item[Parameters: ]\par
\begin{description}
\item[{\em 
p\-Namespace}]The namespace. \item[{\em 
bln\-Is\-New\-Prefix}]The boolean which behaves as  a out parameter to indicate whether this is a new namespace or not. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns: ]\par
The corrosponding prefix. \end{Desc}
\index{SoapSerializer@{Soap\-Serializer}!getNamespacePrefix@{getNamespacePrefix}}
\index{getNamespacePrefix@{getNamespacePrefix}!SoapSerializer@{Soap\-Serializer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const Axis\-Char$\ast$ AXISCALL Soap\-Serializer::get\-Namespace\-Prefix (const Axis\-Char $\ast$ {\em p\-Namespace})}\label{classSoapSerializer_a4}


Returns the corrosponding namespace prefix. \begin{Desc}
\item[Parameters: ]\par
\begin{description}
\item[{\em 
p\-Namespace}]The namespace. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns: ]\par
The corrosponding prefix. \end{Desc}
\index{SoapSerializer@{Soap\-Serializer}!setSoapHeader@{setSoapHeader}}
\index{setSoapHeader@{setSoapHeader}!SoapSerializer@{Soap\-Serializer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Soap\-Serializer::set\-Soap\-Header ({\bf Soap\-Header} $\ast$ {\em p\-Soap\-Header})\hspace{0.3cm}{\tt  [virtual]}}\label{classSoapSerializer_a14}


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}


Implements {\bf IHandler\-Soap\-Serializer} {\rm (p.\,\pageref{classIHandlerSoapSerializer_a4})}.\index{SoapSerializer@{Soap\-Serializer}!setSoapVersion@{setSoapVersion}}
\index{setSoapVersion@{setSoapVersion}!SoapSerializer@{Soap\-Serializer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Soap\-Serializer::set\-Soap\-Version (SOAP\_\-VERSION)\hspace{0.3cm}{\tt  [virtual]}}\label{classSoapSerializer_a7}


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}


Implements {\bf IHandler\-Soap\-Serializer} {\rm (p.\,\pageref{classIHandlerSoapSerializer_a5})}.

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