OWBI1::BI1SimpleInstanceProviderIFC

OWBI1::BI1SimpleInstanceProviderIFC Class Reference

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

#include <OWBI1_SimpleInstanceProviderIFC.hpp>

Inheritance diagram for OWBI1::BI1SimpleInstanceProviderIFC:

Inheritance graph
[legend]
Collaboration diagram for OWBI1::BI1SimpleInstanceProviderIFC:

Collaboration graph
[legend]
List of all members.

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, const CIMPropertyList &propertyList, const CIMClass &cimClass)
 This method retrieves the instance specified in the object path.
virtual void enumInstanceNames (const ProviderEnvironmentIFCRef &env, const String &ns, const CIMName &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 CIMName &className, CIMInstanceResultHandlerIFC &result, const CIMPropertyList &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

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

Thus the "public virtual" inheritance.

Definition at line 50 of file OWBI1_SimpleInstanceProviderIFC.hpp.

Member Enumeration Documentation

enum OWBI1::BI1SimpleInstanceProviderIFC::EPropertiesFlag
 

Enumerator:
E_ALL_PROPERTIES 
E_KEY_PROPERTIES_ONLY 

Definition at line 73 of file OWBI1_SimpleInstanceProviderIFC.hpp.

Member Function Documentation

virtual void OWBI1::BI1SimpleInstanceProviderIFC::doSimpleEnumInstances (  const ProviderEnvironmentIFCRef &  env,
const String &  ns,
const CIMClass &  cimClass,
CIMInstanceResultHandlerIFC &  result,
EPropertiesFlag  propertiesFlag
)  [pure virtual]
 

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

void OWBI1::BI1SimpleInstanceProviderIFC::enumInstanceNames (  const ProviderEnvironmentIFCRef &  env,
const String &  ns,
const CIMName &  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 OWBI1::BI1InstanceProviderIFC.

Definition at line 117 of file OWBI1_SimpleInstanceProviderIFC.cpp.

References cimClass, doSimpleEnumInstances(), E_KEY_PROPERTIES_ONLY, env, handler, ns, and result.

void OWBI1::BI1SimpleInstanceProviderIFC::enumInstances (  const ProviderEnvironmentIFCRef &  env,
const String &  ns,
const CIMName &  className,
CIMInstanceResultHandlerIFC &  result,
const CIMPropertyList &  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 OWBI1::BI1InstanceProviderIFC.

Definition at line 149 of file OWBI1_SimpleInstanceProviderIFC.cpp.

References cimClass, doSimpleEnumInstances(), E_ALL_PROPERTIES, env, handler, ns, propertyList, and result.

CIMInstance OWBI1::BI1SimpleInstanceProviderIFC::getInstance (  const ProviderEnvironmentIFCRef &  env,
const String &  ns,
const CIMObjectPath &  instanceName,
const CIMPropertyList &  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 OWBI1::BI1InstanceProviderIFC.

Definition at line 73 of file OWBI1_SimpleInstanceProviderIFC.cpp.

References OWBI1::String::c_str(), cimClass, OWBI1::CIMNULL, OWBI1::CIMInstance::clone(), doSimpleEnumInstances(), E_ALL_PROPERTIES, env, handler, OWBI1::CIMException::NOT_FOUND, ns, OWBI1_THROWCIMMSG, propertyList, and OWBI1::CIMObjectPath::toString().

The documentation for this class was generated from the following files:
Generated on Thu Feb 9 09:18:58 2006 for openwbem by  doxygen 1.4.6