zeus::IPropertyAccess Class Reference

#include <IPropertyAccess.hpp>

Inheritance diagram for zeus::IPropertyAccess:

List of all members.

Public Member Functions
virtual Retval MQUALIFIER	addProperty (const IString &rstrName, const IString &rstrValue)=0
virtual bool MQUALIFIER	existsProperty (const IString &rstrName) const =0
virtual void MQUALIFIER	getPropertyNames (IStringList &rList) const =0
virtual void MQUALIFIER	getPropertyNamesByNameSpace (const IString &rstrNameSpace, IStringList &rList) const =0
virtual Retval MQUALIFIER	getPropertyValue (const IString &rstrName, IString &rstrValue) const =0
virtual Retval MQUALIFIER	setPropertyValue (const IString &rstrName, const IString &rstrValue)=0
virtual Retval MQUALIFIER	getPropertyPathValue (const IString &rstrName, IString &rstrValue) const =0
virtual Retval MQUALIFIER	getPropertyFileValue (const IString &rstrName, IString &rstrValue) const =0

---

Detailed Description

This interface defines the access to a property collection (file)

---

Member Function Documentation

virtual Retval MQUALIFIER zeus::IPropertyAccess::addProperty	(	const IString &	rstrName,
		const IString &	rstrValue
	)		[pure virtual]

adds a property value

Parameters:

rstrName,:	Name of the property
rstrValue,:	Property value

Return values:

RET_NOERROR,:	value set
RET_REQUEST_FAILED,:	Invalid name

Implemented in zeus::TPropertyFile, and zeus::TSettingsManager.

virtual bool MQUALIFIER zeus::IPropertyAccess::existsProperty

(

const IString &

rstrName )

const [pure virtual]

Checks if a property exists

Parameters:

rstrName,:

Name of the property

Return values:

true,:	Property exists
false,:	Property does not exist

Implemented in zeus::TPropertyFile, and zeus::TSettingsManager.

virtual Retval MQUALIFIER zeus::IPropertyAccess::getPropertyFileValue	(	const IString &	rstrName,
		IString &	rstrValue
	)		const [pure virtual]

Returns a property file value. This converts any path variables into the normal absolute file path.

Parameters:

rstrName,:	Name of the property
rstrValue,:	Property file value

Return values:

RET_NOERROR,:	value returned
RET_REQUEST_FAILED,:	Invalid name
RET_INVALID_PARAMETER,:	name or value is not valid

Implemented in zeus::TPropertyFile, and zeus::TSettingsManager.

virtual void MQUALIFIER zeus::IPropertyAccess::getPropertyNames

(

IStringList &

rList )

const [pure virtual]

Returns all property names of this set

Parameters:

rList,:

Return parameter

Implemented in zeus::TPropertyFile, and zeus::TSettingsManager.

virtual void MQUALIFIER zeus::IPropertyAccess::getPropertyNamesByNameSpace	(	const IString &	rstrNameSpace,
		IStringList &	rList
	)		const [pure virtual]

This Method will collect all properties matching a name space.

Parameters:

rstrNameSpace,:	name space of the property
rList,:	List of property name

Implemented in zeus::TPropertyFile, and zeus::TSettingsManager.

virtual Retval MQUALIFIER zeus::IPropertyAccess::getPropertyPathValue	(	const IString &	rstrName,
		IString &	rstrValue
	)		const [pure virtual]

Returns a property path value. This converts any path variables into the normal absolute path.

Parameters:

rstrName,:	Name of the property
rstrValue,:	Property path value

Return values:

RET_NOERROR,:	value returned
RET_REQUEST_FAILED,:	Invalid name
RET_INVALID_PARAMETER,:	name or value is not valid

Implemented in zeus::TPropertyFile, and zeus::TSettingsManager.

virtual Retval MQUALIFIER zeus::IPropertyAccess::getPropertyValue	(	const IString &	rstrName,
		IString &	rstrValue
	)		const [pure virtual]

Returns a property value

Parameters:

rstrName,:	Name of the property
rstrValue,:	Property value

Return values:

RET_NOERROR,:	Value returned
RET_REQUEST_FAILED,:	Invalid name

Implemented in zeus::TPropertyFile, and zeus::TSettingsManager.

virtual Retval MQUALIFIER zeus::IPropertyAccess::setPropertyValue	(	const IString &	rstrName,
		const IString &	rstrValue
	)		[pure virtual]

Sets a property value

Parameters:

rstrName,:	Name of the property
rstrValue,:	Property value

Return values:

RET_NOERROR,:	value set
RET_REQUEST_FAILED,:	Invalid name

Implemented in zeus::TPropertyFile, and zeus::TSettingsManager.

---

The documentation for this class was generated from the following file:

• IPropertyAccess.hpp