HydraExpress™ C++ API Reference Guide

Product Documentation:
   HydraExpress C++
Documentation Home
List of all members | Public Member Functions | Protected Member Functions
rwsf::SoapBase Class Referenceabstract

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

#include <rwsf/webservice/SoapBase.h>

Inheritance diagram for rwsf::SoapBase:
rwsf::SoapBodyType rwsf::SoapDetail rwsf::SoapEnvelopeType rwsf::SoapFault rwsf::SoapHeaderType

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

rwsf::SoapBase::SoapBase ( )

Default constructor.

rwsf::SoapBase::SoapBase ( const SoapBase sb)

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

virtual rwsf::SoapBase::~SoapBase ( )
virtual

Destructor.

Member Function Documentation

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

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

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

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.

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.

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.

std::string rwsf::SoapBase::getXsiType ( ) const

Returns the value of xsi:type.

bool rwsf::SoapBase::isXsiNilSet ( ) const

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

bool rwsf::SoapBase::isXsiNoNamespaceSchemaLocationSet ( ) const

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

bool rwsf::SoapBase::isXsiSchemaLocationSet ( ) const

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

bool rwsf::SoapBase::isXsiTypeSet ( ) const

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

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

Populates this element with the attributes from attributes.

Reimplemented in rwsf::SoapDetail.

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.

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.

void rwsf::SoapBase::setXsiNoNamespaceSchemaLocation ( const std::string &  XsiNoNamespaceSchemaLocation)

Sets the value of xsi:noNamespaceSchemaLocation.

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.

void rwsf::SoapBase::setXsiSchemaLocation ( const std::string &  XsiSchemaLocation)

Sets the value of xsi:schemaLocation.

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.

void rwsf::SoapBase::setXsiType ( const std::string &  XsiType)

Sets the xsi:type value.

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.

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.

Copyright © 2020 Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is registered trademark of Rogue Wave Software, Inc. in the United States and other countries, and HydraExpress is a trademark of Rogue Wave Software. All other trademarks are the property of their respective owners.
Provide feedback to Rogue Wave about its documentation.