rwsf::SoapBase

Does not inherit

• Local Index
• Header File
• Description
• Public Constructors
• Public Destructors
• Public Member Functions
• Protected Member Functions

Members

getDefaultElementName() getXsiNil() getXsiNoNamespaceSchemaLocation() getXsiSchemaLocation() getXsiType() isXsiNilSet()

isXsiNoNamespaceSchemaLocationSet() isXsiSchemaLocationSet() isXsiTypeSet() populateAttributes() setXsiNil() setXsiNilSet()

setXsiNoNamespaceSchemaLocation() setXsiNoNamespaceSchemaLocationSet() setXsiSchemaLocation() setXsiSchemaLocationSet() setXsiType() setXsiTypeSet()

SoapBase() unmarshalAttributes() ~SoapBase()

#include rwsf/webservice/SoapBase.h

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.

SoapBase();

Default constructor. Sets the following defaults:

SoapBase(const SoapBase & sb);

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

virtual
~SoapBase();

Destructor.

bool
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 which 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
getXsiNoNamespaceSchemaLocation() const;

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

std::string
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
getXsiType() const;

Returns the value of xsi:type.

bool
isXsiNilSet() const;

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

bool
isXsiNoNamespaceSchemaLocationSet() const;

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

bool
isXsiSchemaLocationSet() const;

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

bool
isXsiTypeSet() const;

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

void
setXsiNil(bool XsiNil);

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

void
setXsiNilSet(bool setValue);

Sets the bool value of XsiNilSet_. A value of true means that the xsi:nil has been set.

void
setXsiNoNamespaceSchemaLocation(const std::string & XsiNoNamespaceSchemaLocation);

Sets the value of xsi:noNamespaceSchemaLocation.

void
setXsiNoNamespaceSchemaLocationSet(bool setValue);

Sets the bool value of XsiNoNamespaceSchemaLocation_. A value of true means that the xsi:noNamespaceSchemaLocation has been set.

void
setXsiSchemaLocation(const std::string & XsiSchemaLocation);

Sets the value of xsi:schemaLocation.

void
setXsiSchemaLocationSet(bool setValue);

Sets the bool value of XsiSchemaLocation_. A value of true means that the xsi:schemaLocation has been set.

void
setXsiType(const std::string & XsiType);

Sets the xsi:type value.

void
setXsiTypeSet(bool setValue);

Sets the bool value of setXsiTypeSet. A value of true means that the xsi:type has been set.

rwsf::XmlName
getDefaultElementName() const = 0;

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

void
populateAttributes(rwsf::XmlAttributeSet & attributes) const;

Populates this element with the attributes attributes.

void
unmarshalAttributes(rwsf::XmlAttributeSet & attrs);

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_totrue.

© Copyright Rogue Wave Software, Inc. All Rights Reserved. All Rights Reserved. Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. HydraExpress is a trademark of Rogue Wave Software, Inc. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.