Contains information about one of the errors found when handling a request. More...

#include <Safir/Dob/ResponseErrorInfo.h>

Inheritance diagram for Safir::Dob::ResponseErrorInfo:

Collaboration diagram for Safir::Dob::ResponseErrorInfo:

Public Member Functions
	ResponseErrorInfo ()

virtual Safir::Dob::Typesystem::ObjectPtr	Clone () const
	Create a copy of the object. More...

const Safir::Dob::Typesystem::ContainerProxy < Safir::Dob::Typesystem::Int32Container >	Member () const
	The id of the erroneous member (when applicable). More...

Safir::Dob::Typesystem::ContainerProxy < Safir::Dob::Typesystem::Int32Container >	Member ()

const Safir::Dob::Typesystem::ContainerProxy < Safir::Dob::Typesystem::Int32Container >	Index () const
	The index of the erroneous member (when applicable). More...

Safir::Dob::Typesystem::ContainerProxy < Safir::Dob::Typesystem::Int32Container >	Index ()

const Safir::Dob::Typesystem::ContainerProxy < Safir::Dob::Typesystem::StringContainer >	Code () const
	The error code. More...

Safir::Dob::Typesystem::ContainerProxy < Safir::Dob::Typesystem::StringContainer >	Code ()

const Safir::Dob::Typesystem::ContainerProxy < Safir::Dob::Typesystem::StringContainer >	Parameters () const
	Extra information when applicable. More...

Safir::Dob::Typesystem::ContainerProxy < Safir::Dob::Typesystem::StringContainer >	Parameters ()

virtual Safir::Dob::Typesystem::TypeId	GetTypeId () const
	Get the type id of this object. More...

virtual bool	IsChanged ()
	Check if any member of this object is changed. More...

virtual void	SetChanged (const bool changed)
	Recursively set change flags in all members of this object. More...

virtual Safir::Dob::Typesystem::ContainerBase &	GetMember (const Safir::Dob::Typesystem::MemberIndex member, const Safir::Dob::Typesystem::ArrayIndex index)
	Get a reference to a member container from an object. More...

virtual const Safir::Dob::Typesystem::ContainerBase &	GetMember (const Safir::Dob::Typesystem::MemberIndex member, const Safir::Dob::Typesystem::ArrayIndex index) const
	Get a const reference to a member container from an object. More...

virtual Safir::Dob::Typesystem::Int32	CalculateBlobSize () const
	Calculate the size of the blob-serialized form of this object. More...

virtual void	WriteToBlob (char blob, char &beginningOfUnused) const
	Write the object to a blob. More...

	ResponseErrorInfo (char const *const blob)

Public Member Functions inherited from Safir::Dob::Item
	Item ()

	Item (char const *const blob)

Public Member Functions inherited from Safir::Dob::Typesystem::Object
	Object ()
	Default constructor. More...

virtual	~Object ()
	Virtual destructor. More...

	Object (char const *const blob)
	Create an Object from a blob. More...

Static Public Member Functions
static ResponseErrorInfoPtr	Create ()

static ResponseErrorInfoPtr	CreateResponseErrorInfo (const std::wstring &Code, const std::wstring &Parameters)
	Create a ResponseErrorInfo with one parameter. More...

static ResponseErrorInfoPtr	CreateResponseErrorInfo (const std::wstring &Code, const Safir::Dob::Typesystem::Int32 Member, const std::wstring &Parameters)
	Create a ResponseErrorInfo for a specified member, with one parameter. More...

static ResponseErrorInfoPtr	CreateResponseErrorInfo (const std::wstring &Code, const Safir::Dob::Typesystem::Int32 Member, const Safir::Dob::Typesystem::Int32 Index, const std::wstring &Parameters)
	Create a ResponseErrorInfo for a specified member index, with one parameter. More...

static Safir::Dob::Typesystem::MemberIndex	MemberMemberIndex ()

static Safir::Dob::Typesystem::MemberIndex	IndexMemberIndex ()

static Safir::Dob::Typesystem::MemberIndex	CodeMemberIndex ()

static Safir::Dob::Typesystem::Int32	CodeMaxStringLength ()

static Safir::Dob::Typesystem::MemberIndex	ParametersMemberIndex ()

static Safir::Dob::Typesystem::Int32	ParametersMaxStringLength ()

Static Public Member Functions inherited from Safir::Dob::Item
static ItemPtr	Create ()

Static Public Member Functions inherited from Safir::Dob::Typesystem::Object
static Dob::Typesystem::ObjectPtr	Create ()
	Creates a new Object. More...

Static Public Attributes
static const Safir::Dob::Typesystem::TypeId	ClassTypeId = 3197952542434689553LL
	Type id for ResponseErrorInfo. More...

Static Public Attributes inherited from Safir::Dob::Item
static const Safir::Dob::Typesystem::TypeId	ClassTypeId = 6050262633936372658LL
	Type id for Item. More...

Static Public Attributes inherited from Safir::Dob::Typesystem::Object
static const Dob::Typesystem::TypeId	ClassTypeId = 5955188366590963785LL
	The TypeId of the Object class. More...

Detailed Description

Contains information about one of the errors found when handling a request.

Constructor & Destructor Documentation

Safir::Dob::ResponseErrorInfo::ResponseErrorInfo ( )

Safir::Dob::ResponseErrorInfo::ResponseErrorInfo ( char const *const blob )

explicit

Member Function Documentation

virtual Safir::Dob::Typesystem::Int32 Safir::Dob::ResponseErrorInfo::CalculateBlobSize ( ) const

virtual

Calculate the size of the blob-serialized form of this object.

Returns: The needed size in bytes.

Reimplemented from Safir::Dob::Item.

virtual Safir::Dob::Typesystem::ObjectPtr Safir::Dob::ResponseErrorInfo::Clone ( ) const

virtual

Create a copy of the object.

Will create a copy of the object on the heap and return a smart pointer to it. Use boost::static_pointer_cast or boost::dynamic_pointer_cast to cast it to the pointer type that you're after.

Returns: A smart pointer to the copy of the object.

Reimplemented from Safir::Dob::Item.

const Safir::Dob::Typesystem::ContainerProxy<Safir::Dob::Typesystem::StringContainer> Safir::Dob::ResponseErrorInfo::Code ( ) const

The error code.

Should be a mnemonic defined by a parameter, eg Safir.Dob.ResponseGeneralErrorCodes.SafirNullMember

Safir::Dob::Typesystem::ContainerProxy<Safir::Dob::Typesystem::StringContainer> Safir::Dob::ResponseErrorInfo::Code ( )

static Safir::Dob::Typesystem::Int32 Safir::Dob::ResponseErrorInfo::CodeMaxStringLength ( )

static

static Safir::Dob::Typesystem::MemberIndex Safir::Dob::ResponseErrorInfo::CodeMemberIndex ( )

static

static ResponseErrorInfoPtr Safir::Dob::ResponseErrorInfo::Create ( )

static

static ResponseErrorInfoPtr Safir::Dob::ResponseErrorInfo::CreateResponseErrorInfo	(	const std::wstring &	Code,
		const std::wstring &	Parameters
	)

static

Create a ResponseErrorInfo with one parameter.

static ResponseErrorInfoPtr Safir::Dob::ResponseErrorInfo::CreateResponseErrorInfo	(	const std::wstring &	Code,
		const Safir::Dob::Typesystem::Int32	Member,
		const std::wstring &	Parameters
	)

static

Create a ResponseErrorInfo for a specified member, with one parameter.

static ResponseErrorInfoPtr Safir::Dob::ResponseErrorInfo::CreateResponseErrorInfo	(	const std::wstring &	Code,
		const Safir::Dob::Typesystem::Int32	Member,
		const Safir::Dob::Typesystem::Int32	Index,
		const std::wstring &	Parameters
	)

static

Create a ResponseErrorInfo for a specified member index, with one parameter.

virtual Safir::Dob::Typesystem::ContainerBase& Safir::Dob::ResponseErrorInfo::GetMember	(	const Safir::Dob::Typesystem::MemberIndex	member,
		const Safir::Dob::Typesystem::ArrayIndex	index
	)

virtual

Get a reference to a member container from an object.

Use the methods in Members to get member indices and array sizes for use with this method.

Note: Do not use this method unless you're very sure it is the one you need!

Parameters

member	[in] - The index of the member to get.
index	[in] - The array index of the member to get.

Returns: A reference to the member container.

Exceptions

IllegalValueException	If the index is not in the range of the array.
SoftwareViolationException	If the element is not an array and the index is not 0.

Reimplemented from Safir::Dob::Item.

virtual const Safir::Dob::Typesystem::ContainerBase& Safir::Dob::ResponseErrorInfo::GetMember	(	const Safir::Dob::Typesystem::MemberIndex	member,
		const Safir::Dob::Typesystem::ArrayIndex	index
	)		const

virtual

Get a const reference to a member container from an object.

Use the methods in Members to get member indices and array sizes for use with this method.

Note: Do not use this method unless you're very sure it is the one you need!

Parameters

member	[in] - The index of the member to get.
index	[in] - The array index of the member to get.

Returns: A const reference to the member container.

Exceptions

IllegalValueException	If the index is not in the range of the array.
SoftwareViolationException	If the element is not an array and the index is not 0.

Reimplemented from Safir::Dob::Item.

virtual Safir::Dob::Typesystem::TypeId Safir::Dob::ResponseErrorInfo::GetTypeId ( ) const

virtual

Get the type id of this object.

Gets the type id of the object. Method is virtual to ensure that the right value gets returned for pointers or references.

Note: this method is overridden by all auto-generated classes.

Returns: The TypeId of the object.

Reimplemented from Safir::Dob::Item.

const Safir::Dob::Typesystem::ContainerProxy<Safir::Dob::Typesystem::Int32Container> Safir::Dob::ResponseErrorInfo::Index ( ) const

The index of the erroneous member (when applicable).

Safir::Dob::Typesystem::ContainerProxy<Safir::Dob::Typesystem::Int32Container> Safir::Dob::ResponseErrorInfo::Index ( )

static Safir::Dob::Typesystem::MemberIndex Safir::Dob::ResponseErrorInfo::IndexMemberIndex ( )

static

virtual bool Safir::Dob::ResponseErrorInfo::IsChanged ( )

virtual

Check if any member of this object is changed.

This method will recursively check if any member of the object has its change flag set.

Note: this method is overridden by all auto-generated classes.

Returns: True if any member has changed.

Reimplemented from Safir::Dob::Item.

const Safir::Dob::Typesystem::ContainerProxy<Safir::Dob::Typesystem::Int32Container> Safir::Dob::ResponseErrorInfo::Member ( ) const

The id of the erroneous member (when applicable).

Safir::Dob::Typesystem::ContainerProxy<Safir::Dob::Typesystem::Int32Container> Safir::Dob::ResponseErrorInfo::Member ( )

static Safir::Dob::Typesystem::MemberIndex Safir::Dob::ResponseErrorInfo::MemberMemberIndex ( )

static

const Safir::Dob::Typesystem::ContainerProxy<Safir::Dob::Typesystem::StringContainer> Safir::Dob::ResponseErrorInfo::Parameters ( ) const

Extra information when applicable.

Expected to be handled similar to alert parameters in the future.

Safir::Dob::Typesystem::ContainerProxy<Safir::Dob::Typesystem::StringContainer> Safir::Dob::ResponseErrorInfo::Parameters ( )

static Safir::Dob::Typesystem::Int32 Safir::Dob::ResponseErrorInfo::ParametersMaxStringLength ( )

static

static Safir::Dob::Typesystem::MemberIndex Safir::Dob::ResponseErrorInfo::ParametersMemberIndex ( )

static

virtual void Safir::Dob::ResponseErrorInfo::SetChanged ( const bool changed )

virtual

Recursively set change flags in all members of this object.

Note: this method is overridden by all auto-generated classes.

Parameters

changed [in] - The value to set the change flags to

Reimplemented from Safir::Dob::Item.

virtual void Safir::Dob::ResponseErrorInfo::WriteToBlob	(	char *	blob,
		char *&	beginningOfUnused
	)		const

virtual

Write the object to a blob.

Note that the size of the blob is assumed to be correct! No checks are made!

Parameters

blob	[in,out] - The blob to write to.
beginningOfUnused	[in,out] - The beginning of unused dynamic blob space.

Reimplemented from Safir::Dob::Item.

Member Data Documentation

const Safir::Dob::Typesystem::TypeId Safir::Dob::ResponseErrorInfo::ClassTypeId = 3197952542434689553LL

static

Type id for ResponseErrorInfo.

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation