IFMEServerPropertyAccessor Class Reference

IFMEServerPropertyAccessor interface. More...

#include <ifmeserverpropertyaccessor.h>

List of all members.

Public Member Functions
virtual void	getAllProperties (const IFMEServerString &propertyCategory, IFMEServerStringArray &properties)=0
virtual void	getAllPropertyCategories (IFMEServerStringArray &propertyCategories)=0
virtual void	getAllPropertyNames (const IFMEServerString &propertyCategory, IFMEServerStringArray &propertyNames)=0
virtual void	getAllPropertyObjects (const IFMEServerString &propertyCategory, IFMEServerPropertyVector &properties)=0
virtual void	getProperty (const IFMEServerString &propertyCategory, const IFMEServerString &propertyName, IFMEServerString &property)=0
virtual IFMEServerProperty *	getPropertyObject (const IFMEServerString &propertyCategory, const IFMEServerString &propertyName)=0
virtual FME_Boolean	removeProperty (const IFMEServerString &propertyCategory, const IFMEServerString &propertyName)=0
virtual FME_Boolean	removePropertyCategory (const IFMEServerString &propertyCategory)=0
virtual void	setProperty (const IFMEServerString &propertyCategory, const IFMEServerString &propertyName, const IFMEServerString &propertyValue)=0
Protected Member Functions
	IFMEServerPropertyAccessor ()
virtual	~IFMEServerPropertyAccessor ()
Private Member Functions
	IFMEServerPropertyAccessor (const IFMEServerPropertyAccessor &)
IFMEServerPropertyAccessor &	operator= (const IFMEServerPropertyAccessor &)

---

Detailed Description

IFMEServerPropertyAccessor interface.

Package Overview:

This file defines the interface that subclasses of this class MUST follow.

Developers MUST NOT implement their own subclasses of this, instead, the FME will ALWAYS provide them with the subclass instance they should be using.

---

Constructor & Destructor Documentation

IFMEServerPropertyAccessor::IFMEServerPropertyAccessor

(

)

[inline, protected]

virtual IFMEServerPropertyAccessor::~IFMEServerPropertyAccessor

(

)

[inline, protected, virtual]

IFMEServerPropertyAccessor::IFMEServerPropertyAccessor

(

const IFMEServerPropertyAccessor &

)

[private]

---

Member Function Documentation

virtual void IFMEServerPropertyAccessor::getAllProperties	(	const IFMEServerString &	propertyCategory,
		IFMEServerStringArray &	properties
	)		[pure virtual]

Gets all properties as keyword / value pairs for a specific property category.

Parameters:

propertyCategory	the name of the property category.
properties	an IFMEServerStringArray to store the list of all properties as keyword / value pairs for the specified property category.

virtual void IFMEServerPropertyAccessor::getAllPropertyCategories

(

IFMEServerStringArray &

propertyCategories

)

[pure virtual]

Gets all the property categories.

Parameters:

propertyCategories

an IFMEServerStringArray to store the list of all property categories.

virtual void IFMEServerPropertyAccessor::getAllPropertyNames	(	const IFMEServerString &	propertyCategory,
		IFMEServerStringArray &	propertyNames
	)		[pure virtual]

Gets all property names for a specific property category.

Parameters:

propertyCategory	the name of the property category.
propertyNames	an IFMEServerStringArray to store the list of all property names for the specified property category.

virtual void IFMEServerPropertyAccessor::getAllPropertyObjects	(	const IFMEServerString &	propertyCategory,
		IFMEServerPropertyVector &	properties
	)		[pure virtual]

Gets all properties for a specific property category.

Parameters:

propertyCategory	the name of the property category.
properties	an IFMEServerPropertyVector to store the list of all properties for the specified property category.

virtual void IFMEServerPropertyAccessor::getProperty	(	const IFMEServerString &	propertyCategory,
		const IFMEServerString &	propertyName,
		IFMEServerString &	property
	)		[pure virtual]

Gets the property value for a property name in a specific property category.

Parameters:

propertyCategory	the name of the property category.
propName	the name of the property.
property	an IFMEServerString to store the property value for a property name in a specific property category, otherwise empty.

virtual IFMEServerProperty* IFMEServerPropertyAccessor::getPropertyObject	(	const IFMEServerString &	propertyCategory,
		const IFMEServerString &	propertyName
	)		[pure virtual]

Get the reference to the property object specified by category and name. Caller DOES NOT own the returned property object.

Parameters:

propertyCategory	the name of the property category.
propName	the name of the property.

Returns:

NULL if the property does not exist.

IFMEServerPropertyAccessor& IFMEServerPropertyAccessor::operator=

(

const IFMEServerPropertyAccessor &

)

[private]

virtual FME_Boolean IFMEServerPropertyAccessor::removeProperty	(	const IFMEServerString &	propertyCategory,
		const IFMEServerString &	propertyName
	)		[pure virtual]

Remove the property with the given property category and property name.

Parameters:

propertyCategory	the name of the property category.
propName	the name of the property.

Returns:

true if property existed, otherwise false.

virtual FME_Boolean IFMEServerPropertyAccessor::removePropertyCategory

(

const IFMEServerString &

propertyCategory

)

[pure virtual]

Remove the property category.

Parameters:

propertyCategory

the name of the property category.

Returns:

true if propertyCategory existed, otherwise false.

virtual void IFMEServerPropertyAccessor::setProperty	(	const IFMEServerString &	propertyCategory,
		const IFMEServerString &	propertyName,
		const IFMEServerString &	propertyValue
	)		[pure virtual]

Sets the property value for a property name in a specific property category.

Parameters:

propertyCategory	the name of the property category.
propName	the name of the property.
propValue	the value of the property.

---

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

• ifmeserverpropertyaccessor.h