Main Page   Class Hierarchy   Compound List   File List   Compound Members   File Members   Examples  

CharacterElement Class Reference

interface for the CharacterElement class. More...

#include <CharacterElement.h>

Inheritance diagram for CharacterElement:

List of all members.

Public Methods

int setValue (const AxisChar *pachValue)
const AxisChar * getValue () const
int getNoOfChildren ()
const BasicNode * getFirstChild () const
const BasicNode * getLastChild () const
const BasicNode * getChild (int iChildPosition) const
int setURI (const AxisChar *sURI)
int addChild (BasicNode *pBasicNode)
int setLocalName (const AxisChar *sLocalName)
int setPrefix (const AxisChar *sPrefix)
int serialize (SoapSerializer &pSZ, list< AxisChar * > &lstTmpNameSpaceStack)
NODE_TYPE getNodeType () const
 CharacterElement (const AxisChar *sValue)
 CharacterElement ()
virtual ~CharacterElement ()

Detailed Description

interface for the CharacterElement class.

Author:
Roshan Weerasuriya (roshan@opensource.lk, roshanw@jkcsworld.com) , Samisa Abeysinghe (sabeysinghe@virtusa.com)


Constructor & Destructor Documentation

CharacterElement::CharacterElement const AxisChar *    sValue
 

The Constructor.

Parameters:
sValue  The value of the Character Element.

CharacterElement::CharacterElement  
 

The Constructor.

virtual CharacterElement::~CharacterElement   [virtual]
 

The Destructor.


Member Function Documentation

int CharacterElement::addChild BasicNode *    pBasicNode [inline]
 

This method is overridden to return fail(AXIS_FAIL) always because this is a CharacterElement. A user of a CharacterElement should not use this method.

Parameters:
pBasicNode  The child to be added.
Returns:
Always return fail (AXIS_FAIL) to indicate unsuccessfull operation.

const BasicNode* CharacterElement::getChild int    iChildPosition const [inline]
 

This method is overridden to return NULL always because this is a CharacterElement. A user of a CharacterElement should not use this method.

Parameters:
iChildPosition  The child position.
Returns:
Always return NULL to indicate unsuccessfull operation.

const BasicNode* CharacterElement::getFirstChild   const [inline]
 

This method is overridden to return NULL always because this is a CharacterElement. A user of a CharacterElement should not use this method.

Returns:
Always return NULL to indicate unsuccessfull operation.

const BasicNode* CharacterElement::getLastChild   const [inline]
 

This method is overridden to return NULL always because this is a CharacterElement. A user of a CharacterElement should not use this method.

Returns:
Always return NULL to indicate unsuccessfull operation.

NODE_TYPE CharacterElement::getNodeType  
 

Returns the Node Type of this Character Element, which is CHARACTER_NODE.

Returns:
The Node Type of this Character Element, which is CHARACTER_NODE

int CharacterElement::getNoOfChildren   [inline]
 

This method is overridden to return 0 always because this is a CharacterElement. A user of a CharacterElement should not use this method.

Returns:
Always return 0.

const AxisChar* CharacterElement::getValue  
 

Gets and return the value of this Character Element

Returns:
The value of this Character Element.

int CharacterElement::serialize SoapSerializer   pSZ,
list< AxisChar * > &    lstTmpNameSpaceStack
[inline]
 

This method is actualy not used in this class. This method was just included to adhere its interface.

int CharacterElement::setLocalName const AxisChar *    sLocalName [inline]
 

This method is overridden to return fail(AXIS_FAIL) always because this is a CharacterElement. A user of a CharacterElement should not use this method.

Parameters:
sLocalName  The localname.
Returns:
Always return fail (AXIS_FAIL) to indicate unsuccessfull operation.

int CharacterElement::setPrefix const AxisChar *    sPrefix [inline]
 

This method is overridden to return fail(AXIS_FAIL) always because this is a CharacterElement. A user of a CharacterElement should not use this method.

Parameters:
sPrefix  The prefix.
Returns:
Always return fail (AXIS_FAIL) to indicate unsuccessfull operation.

int CharacterElement::setURI const AxisChar *    sURI [inline]
 

This method is overridden to return fail(AXIS_FAIL) always because this is a CharacterElement. A user of a CharacterElement should not use this method.

Parameters:
sURI  The namespace URI.
Returns:
Always return fail (AXIS_FAIL) to indicate unsuccessfull operation.

int CharacterElement::setValue const AxisChar *    pachValue
 

Sets the value of this Character Element

Parameters:
pachValue  The value to be set
Returns:
AXIS_SUCCESS to indicate success.


The documentation for this class was generated from the following file:
Generated on Tue Jun 29 09:27:58 2004 for AxisC++ by doxygen1.2.18