OW_NAMESPACE::CppSimpleInstanceProviderIFC Class Reference

A provider can derive from this class, and implement doSimpleEnumerateInstances(), and CppSimpleInstanceProviderIFC implements getInstance(), enumInstanceNames(), and enumInstances() This class can be part of a multiple-inerhitance diamond. More...

Inheritance diagram for OW_NAMESPACE::CppSimpleInstanceProviderIFC:

[legend]Collaboration diagram for OW_NAMESPACE::CppSimpleInstanceProviderIFC:


Public Types
enum	EPropertiesFlag { E_ALL_PROPERTIES, E_KEY_PROPERTIES_ONLY }
Public Member Functions
virtual CIMInstance	getInstance (const ProviderEnvironmentIFCRef &env, const String &ns, const CIMObjectPath &instanceName, WBEMFlags::ELocalOnlyFlag localOnly, WBEMFlags::EIncludeQualifiersFlag includeQualifiers, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin, const StringArray *propertyList, const CIMClass &cimClass)
	This method retrieves the instance specified in the object path.
virtual void	enumInstanceNames (const ProviderEnvironmentIFCRef &env, const String &ns, const String &className, CIMObjectPathResultHandlerIFC &result, const CIMClass &cimClass)
	This method enumerates all names of instances of the class which is specified in cop.
virtual void	enumInstances (const ProviderEnvironmentIFCRef &env, const String &ns, const String &className, CIMInstanceResultHandlerIFC &result, WBEMFlags::ELocalOnlyFlag localOnly, WBEMFlags::EDeepFlag deep, WBEMFlags::EIncludeQualifiersFlag includeQualifiers, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin, const StringArray *propertyList, const CIMClass &requestedClass, const CIMClass &cimClass)
	This method enumerates all instances of the class which is specified in className.
virtual void	doSimpleEnumInstances (const ProviderEnvironmentIFCRef &env, const String &ns, const CIMClass &cimClass, CIMInstanceResultHandlerIFC &result, EPropertiesFlag propertiesFlag)=0

Detailed Description

Thus the "public virtual" inheritance.

enum OW_NAMESPACE::CppSimpleInstanceProviderIFC::EPropertiesFlag

Enumerator:

E_ALL_PROPERTIES

E_KEY_PROPERTIES_ONLY

Definition at line 80 of file OW_CppSimpleInstanceProviderIFC.hpp.

virtual void OW_NAMESPACE::CppSimpleInstanceProviderIFC::doSimpleEnumInstances ( const ProviderEnvironmentIFCRef & env,

const String & ns,

const CIMClass & cimClass,

CIMInstanceResultHandlerIFC & result,

EPropertiesFlag propertiesFlag

) [pure virtual]

Referenced by enumInstanceNames(), enumInstances(), and getInstance().

void OW_NAMESPACE::CppSimpleInstanceProviderIFC::enumInstanceNames ( const ProviderEnvironmentIFCRef & env,

const String & ns,

const String & className,

CIMObjectPathResultHandlerIFC & result,

const CIMClass & cimClass

) [virtual]

This method enumerates all names of instances of the class which is specified in cop.

Parameters:

cop The object path specifies the class that must be enumerated.

cimClass The class reference

Returns:
An array of CIMObjectPath containing names of the enumerated instances.

Exceptions:

CIMException - throws if the CIMObjectPath is incorrect or does not exist.

Implements OW_NAMESPACE::CppInstanceProviderIFC.
Definition at line 120 of file OW_CppSimpleInstanceProviderIFC.cpp.
References cimClass, doSimpleEnumInstances(), E_KEY_PROPERTIES_ONLY, env, handler, ns, and result.

void OW_NAMESPACE::CppSimpleInstanceProviderIFC::enumInstances ( const ProviderEnvironmentIFCRef & env,

const String & ns,

const String & className,

CIMInstanceResultHandlerIFC & result,

WBEMFlags::ELocalOnlyFlag localOnly,

WBEMFlags::EDeepFlag deep,

WBEMFlags::EIncludeQualifiersFlag includeQualifiers,

WBEMFlags::EIncludeClassOriginFlag includeClassOrigin,

const StringArray * propertyList,

const CIMClass & requestedClass,

const CIMClass & cimClass

) [virtual]

This method enumerates all instances of the class which is specified in className.
The entire instances and not just the names are returned. If you don't override this method, the default implementation will be used which utilizes enumInstanceNames() and getInstance()

Parameters:

cop The object path specifies the class that must be enumerated.

cimClass The class reference.

localOnly If true, only the non-inherited properties are to be returned, otherwise all properties are required.

Returns:
An array of CIMInstance containing names of the enumerated instances.

Exceptions:

CIMException - thrown if cop is incorrect or does not exist.

Reimplemented from OW_NAMESPACE::CppInstanceProviderIFC.
Definition at line 172 of file OW_CppSimpleInstanceProviderIFC.cpp.
References cimClass, doSimpleEnumInstances(), E_ALL_PROPERTIES, env, handler, ns, propertyList, requestedClass, and result.

CIMInstance OW_NAMESPACE::CppSimpleInstanceProviderIFC::getInstance ( const ProviderEnvironmentIFCRef & env,

const String & ns,

const CIMObjectPath & instanceName,

WBEMFlags::ELocalOnlyFlag localOnly,

WBEMFlags::EIncludeQualifiersFlag includeQualifiers,

WBEMFlags::EIncludeClassOriginFlag includeClassOrigin,

const StringArray * propertyList,

const CIMClass & cimClass

) [virtual]

This method retrieves the instance specified in the object path.

Parameters:

cop The name of the instance to be retrieved.

cimClass The class to which the instance belongs. This is useful for providers which do not want to create instances from scratch. They can call the class newInstance() routine to create a template for the new instance.

localOnly If true, only the non-inherited properties are to be returned, otherwise all properties are required.

Returns:
The retrieved instance

Exceptions:

CIMException - thrown if cop is incorrect or does not exist

Implements OW_NAMESPACE::CppInstanceProviderIFC.
Definition at line 73 of file OW_CppSimpleInstanceProviderIFC.cpp.
References OW_NAMESPACE::String::c_str(), cimClass, OW_NAMESPACE::CIMNULL, OW_NAMESPACE::CIMInstance::clone(), doSimpleEnumInstances(), E_ALL_PROPERTIES, env, handler, OW_NAMESPACE::CIMException::NOT_FOUND, ns, OW_THROWCIMMSG, propertyList, and OW_NAMESPACE::CIMObjectPath::toString().

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

Generated on Thu Feb 9 09:16:02 2006 for openwbem by

1.4.6