rwsf::SoapBase Class Reference

Common abstract base class for all SOAP parsing objects. More...

#include <rwsf/webservice/SoapBase.h>

Inheritance diagram for rwsf::SoapBase:

Public Member Functions
	SoapBase ()
	SoapBase (const SoapBase &sb)
virtual	~SoapBase ()
bool	getXsiNil () const
std::string	getXsiNoNamespaceSchemaLocation () const
std::string	getXsiSchemaLocation () const
std::string	getXsiType () const
bool	isXsiNilSet () const
bool	isXsiNoNamespaceSchemaLocationSet () const
bool	isXsiSchemaLocationSet () const
bool	isXsiTypeSet () const
void	setXsiNil (bool XsiNil)
void	setXsiNilSet (bool setValue)
void	setXsiNoNamespaceSchemaLocation (const std::string &XsiNoNamespaceSchemaLocation)
void	setXsiNoNamespaceSchemaLocationSet (bool setValue)
void	setXsiSchemaLocation (const std::string &XsiSchemaLocation)
void	setXsiSchemaLocationSet (bool setValue)
void	setXsiType (const std::string &XsiType)
void	setXsiTypeSet (bool setValue)

Protected Member Functions
virtual rwsf::XmlName	getDefaultElementName () const =0
virtual void	populateAttributes (rwsf::XmlAttributeSet &attributes) const
void	unmarshalAttributes (rwsf::XmlAttributeSet &attrs)

Detailed Description

Class rwsf::SoapBase is the common abstract base class for all SOAP parsing objects, and contains functionality to get and set values for all xsi attributes, including xsi:type, xsi:nil, xsi:schemaLocation, and xsi:noNamespaceSchemaLocation.

For more information, see section "2.6 Schema-Related Markup in Documents Being Validated" in the W3C specification XML Schema Part 1: Structures.

The prefix xsi: indicates a schema instance and is conventionally mapped to the URI http://www.w3.org/2001/XMLSchema-instance.

Constructor & Destructor Documentation

SoapBase() [1/2]

rwsf::SoapBase::SoapBase

(

)

Default constructor.

SoapBase() [2/2]

rwsf::SoapBase::SoapBase

(

const SoapBase &

sb

)

Copy constructor. Sets the same defaults for all settings as the object sb.

~SoapBase()

virtual rwsf::SoapBase::~SoapBase ( )

virtual

Destructor.

Member Function Documentation

getDefaultElementName()

virtual rwsf::XmlName rwsf::SoapBase::getDefaultElementName ( ) const

protectedpure virtual

Pure virtual function. In derived classes, returns the DefaultElementName.

Implemented in rwsf::SoapBodyType, rwsf::SoapDetail, rwsf::SoapEnvelopeType, rwsf::SoapFault, and rwsf::SoapHeaderType.

getXsiNil()

bool rwsf::SoapBase::getXsiNil

(

)

const

Returns the bool value of xsi:nil. If true, this element should be accepted as valid when empty, even if this is a content type that does not allow empty content. If true, this element must be empty, but can carry attributes if permitted by the corresponding complex type.

getXsiNoNamespaceSchemaLocation()

std::string rwsf::SoapBase::getXsiNoNamespaceSchemaLocation

(

)

const

Returns the value of xsi:noNamespaceSchemaLocation. The xsi:schemaLocation and xsi:noNamespaceSchemaLocation attributes are optional hints to help locate the physical location of schema documents.

getXsiSchemaLocation()

std::string rwsf::SoapBase::getXsiSchemaLocation

(

)

const

Returns the xsi:schemaLocation value. The xsi:schemaLocation and xsi:noNamespaceSchemaLocation attributes are optional hints to help locate the physical location of schema documents.

getXsiType()

std::string rwsf::SoapBase::getXsiType

(

)

const

Returns the value of xsi:type.

isXsiNilSet()

bool rwsf::SoapBase::isXsiNilSet

(

)

const

Returns true if the xsi:nil value is set, otherwise returns false.

isXsiNoNamespaceSchemaLocationSet()

bool rwsf::SoapBase::isXsiNoNamespaceSchemaLocationSet

(

)

const

Returns true if the xsi:noNamespaceSchemaLocation value is set, otherwise returns false.

isXsiSchemaLocationSet()

bool rwsf::SoapBase::isXsiSchemaLocationSet

(

)

const

Returns true if the xsi:schemaLocation value is set, otherwise returns false.

isXsiTypeSet()

bool rwsf::SoapBase::isXsiTypeSet

(

)

const

Returns true if the xsi:type value is set, otherwise returns false.

populateAttributes()

virtual void rwsf::SoapBase::populateAttributes ( rwsf::XmlAttributeSet & attributes ) const

protectedvirtual

Populates this element with the attributes from attributes.

Reimplemented in rwsf::SoapDetail.

setXsiNil()

void rwsf::SoapBase::setXsiNil

(

bool

XsiNil

)

Sets the bool value of xsi:nil. If true, this element should be accepted as valid when empty, even if this is a content type that does not allow empty content. If true, this element must be empty, but can carry attributes if permitted by the corresponding complex type.

setXsiNilSet()

void rwsf::SoapBase::setXsiNilSet

(

bool

setValue

)

Sets whether or not the xsi:nil has been set. A value of true means it has been set; a value of false means it has not been set.

setXsiNoNamespaceSchemaLocation()

void rwsf::SoapBase::setXsiNoNamespaceSchemaLocation

(

const std::string &

XsiNoNamespaceSchemaLocation

)

Sets the value of xsi:noNamespaceSchemaLocation.

setXsiNoNamespaceSchemaLocationSet()

void rwsf::SoapBase::setXsiNoNamespaceSchemaLocationSet

(

bool

setValue

)

Sets whether xsi:noNamespaceSchemaLocation has been set. A value of true means it has been set; a value of false means it has not been set.

setXsiSchemaLocation()

void rwsf::SoapBase::setXsiSchemaLocation

(

const std::string &

XsiSchemaLocation

)

Sets the value of xsi:schemaLocation.

setXsiSchemaLocationSet()

void rwsf::SoapBase::setXsiSchemaLocationSet

(

bool

setValue

)

Sets whether xsi:schemaLocation has been set. A value of true means it has been set; a value of false means it has not been set.

setXsiType()

void rwsf::SoapBase::setXsiType

(

const std::string &

XsiType

)

Sets the xsi:type value.

setXsiTypeSet()

void rwsf::SoapBase::setXsiTypeSet

(

bool

setValue

)

Sets whether or not the xsi:type is set. A value of true means it is set; a value of false means it is not set.

unmarshalAttributes()

void rwsf::SoapBase::unmarshalAttributes ( rwsf::XmlAttributeSet & attrs )

protected

Unmarshals the attributes in object attrs. For all included attributes, sets the corresponding <attribute>Set variable to true. For example, if a XsiTypeAttributeName_ attribute exists, this method sets the variable XsiTypeSet_ to true.