OW_NAMESPACE::CIMOMHandleIFC

OW_NAMESPACE::CIMOMHandleIFC Class Reference

The CIMOMHandleIFC class is an abstract class used as an interface definition for classes that provide access to a CIMOM. More...

#include <OW_CIMOMHandleIFC.hpp>

Inheritance diagram for OW_NAMESPACE::CIMOMHandleIFC:

Inheritance graph
[legend]
Collaboration diagram for OW_NAMESPACE::CIMOMHandleIFC:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual ~CIMOMHandleIFC ()
 Destroy this CIMOMHandleIFC object.
virtual void close ()=0
 Close the connetion to the CIMOM.
virtual void enumClass (const String &ns, const String &className, CIMClassResultHandlerIFC &result, WBEMFlags::EDeepFlag deep=WBEMFlags::E_SHALLOW, WBEMFlags::ELocalOnlyFlag localOnly=WBEMFlags::E_NOT_LOCAL_ONLY, WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_INCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_INCLUDE_CLASS_ORIGIN)=0
 Enumerates the class specified by the CIMObjectPath.
virtual CIMClassEnumeration enumClassE (const String &ns, const String &className, WBEMFlags::EDeepFlag deep=WBEMFlags::E_SHALLOW, WBEMFlags::ELocalOnlyFlag localOnly=WBEMFlags::E_NOT_LOCAL_ONLY, WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_INCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_INCLUDE_CLASS_ORIGIN)
 Enumerates the class specified by the CIMObjectPath.
virtual CIMClassArray enumClassA (const String &ns, const String &className, WBEMFlags::EDeepFlag deep=WBEMFlags::E_SHALLOW, WBEMFlags::ELocalOnlyFlag localOnly=WBEMFlags::E_NOT_LOCAL_ONLY, WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_INCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_INCLUDE_CLASS_ORIGIN)
 Enumerates the class specified by the CIMObjectPath.
virtual void enumClassNames (const String &ns, const String &className, StringResultHandlerIFC &result, WBEMFlags::EDeepFlag deep=WBEMFlags::E_DEEP)=0
 Enumerates the child classes of className.
virtual StringEnumeration enumClassNamesE (const String &ns, const String &className, WBEMFlags::EDeepFlag deep=WBEMFlags::E_DEEP)
 Enumerates the child classes of className.
virtual StringArray enumClassNamesA (const String &ns, const String &className, WBEMFlags::EDeepFlag deep=WBEMFlags::E_DEEP)
 Enumerates the child classes of className.
virtual void enumInstances (const String &ns, const String &className, CIMInstanceResultHandlerIFC &result, WBEMFlags::EDeepFlag deep=WBEMFlags::E_DEEP, WBEMFlags::ELocalOnlyFlag localOnly=WBEMFlags::E_NOT_LOCAL_ONLY, WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_EXCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_EXCLUDE_CLASS_ORIGIN, const StringArray *propertyList=0)=0
 Gathers all instances (the whole instance and not just the names) belonging to the class specified in the path.
virtual CIMInstanceEnumeration enumInstancesE (const String &ns, const String &className, WBEMFlags::EDeepFlag deep=WBEMFlags::E_DEEP, WBEMFlags::ELocalOnlyFlag localOnly=WBEMFlags::E_NOT_LOCAL_ONLY, WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_EXCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_EXCLUDE_CLASS_ORIGIN, const StringArray *propertyList=0)
 Returns all instances (the whole instance and not just the names) belonging to the class specified in the path.
virtual CIMInstanceArray enumInstancesA (const String &ns, const String &className, WBEMFlags::EDeepFlag deep=WBEMFlags::E_DEEP, WBEMFlags::ELocalOnlyFlag localOnly=WBEMFlags::E_NOT_LOCAL_ONLY, WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_EXCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_EXCLUDE_CLASS_ORIGIN, const StringArray *propertyList=0)
 Returns all instances (the whole instance and not just the names) belonging to the class specified in the path.
virtual void enumInstanceNames (const String &ns, const String &className, CIMObjectPathResultHandlerIFC &result)=0
 Gathers all instance names belonging to the class specified in the path.
virtual CIMObjectPathEnumeration enumInstanceNamesE (const String &ns, const String &className)
 Returns all instance names belonging to the class specified in the path.
virtual CIMObjectPathArray enumInstanceNamesA (const String &ns, const String &className)
 Returns all instance names belonging to the class specified in the path.
virtual CIMClass getClass (const String &ns, const String &className, WBEMFlags::ELocalOnlyFlag localOnly=WBEMFlags::E_NOT_LOCAL_ONLY, WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_INCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_INCLUDE_CLASS_ORIGIN, const StringArray *propertyList=0)=0
 Gets the CIM class for the specified CIM object path.
virtual CIMInstance getInstance (const String &ns, const CIMObjectPath &instanceName, WBEMFlags::ELocalOnlyFlag localOnly=WBEMFlags::E_NOT_LOCAL_ONLY, WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_EXCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_EXCLUDE_CLASS_ORIGIN, const StringArray *propertyList=0)=0
 Gets the CIM instance for the specified CIM object path.
virtual CIMValue invokeMethod (const String &ns, const CIMObjectPath &path, const String &methodName, const CIMParamValueArray &inParams, CIMParamValueArray &outParams)=0
 Executes the specified method on the specified object.
virtual CIMQualifierType getQualifierType (const String &ns, const String &qualifierName)=0
 Gets the CIM qualifier type specified in the CIM object path.
virtual void setQualifierType (const String &ns, const CIMQualifierType &qualifierType)=0
 Updates the specified CIM qualifier type in the specified namespace if it exists.
virtual void deleteQualifierType (const String &ns, const String &qualName)=0
 Deletes a CIM qualfier type.
virtual void enumQualifierTypes (const String &ns, CIMQualifierTypeResultHandlerIFC &result)=0
 Enumerates the qualifiers defined in a namespace.
virtual CIMQualifierTypeEnumeration enumQualifierTypesE (const String &ns)
 Enumerates the qualifiers defined in a namespace.
virtual CIMQualifierTypeArray enumQualifierTypesA (const String &ns)
 Enumerates the qualifiers defined in a namespace.
virtual void modifyClass (const String &ns, const CIMClass &cimClass)=0
 Updates the CIM class within the specified namespace.
virtual void createClass (const String &ns, const CIMClass &cimClass)=0
 Adds the CIM class to the specified namespace.
virtual void deleteClass (const String &ns, const String &className)=0
 Deletes the CIM class specified by className from namespace ns.
virtual void modifyInstance (const String &ns, const CIMInstance &modifiedInstance, WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_INCLUDE_QUALIFIERS, const StringArray *propertyList=0)=0
 Update the specified CIM instance within the specified namespace.
virtual CIMObjectPath createInstance (const String &ns, const CIMInstance &instance)=0
 Add the specified CIM instance to the specified namespace.
virtual void deleteInstance (const String &ns, const CIMObjectPath &path)=0
 Deletes the CIM instance specified by path from namespace ns.
virtual void setProperty (const String &ns, const CIMObjectPath &instanceName, const String &propertyName, const CIMValue &newValue)=0
 Set the specified CIM instance property.
virtual CIMValue getProperty (const String &ns, const CIMObjectPath &instanceName, const String &propertyName)=0
 Get the specified CIM instance property.
virtual void associatorNames (const String &ns, const CIMObjectPath &objectName, CIMObjectPathResultHandlerIFC &result, const String &assocClass=String(), const String &resultClass=String(), const String &role=String(), const String &resultRole=String())=0
 This method is used to enumerate the names of CIM Objects (Classes or Instances) that are associated to a particular CIM Object.
virtual CIMObjectPathEnumeration associatorNamesE (const String &ns, const CIMObjectPath &objectName, const String &assocClass=String(), const String &resultClass=String(), const String &role=String(), const String &resultRole=String())
 This method is used to enumerate the names of CIM Objects (Classes or Instances that are associated to a particular CIM Object.
virtual CIMObjectPathArray associatorNamesA (const String &ns, const CIMObjectPath &objectName, const String &assocClass=String(), const String &resultClass=String(), const String &role=String(), const String &resultRole=String())
 This method is used to enumerate the names of CIM Objects (Classes or Instances that are associated to a particular CIM Object.
virtual void associators (const String &ns, const CIMObjectPath &path, CIMInstanceResultHandlerIFC &result, const String &assocClass=String(), const String &resultClass=String(), const String &role=String(), const String &resultRole=String(), WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_EXCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_EXCLUDE_CLASS_ORIGIN, const StringArray *propertyList=0)=0
 This operation is used to enumerate CIM Objects (Classes or Instances) that are associated to a particular source CIM Object.
virtual CIMInstanceEnumeration associatorsE (const String &ns, const CIMObjectPath &path, const String &assocClass=String(), const String &resultClass=String(), const String &role=String(), const String &resultRole=String(), WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_EXCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_EXCLUDE_CLASS_ORIGIN, const StringArray *propertyList=0)
 This operation is used to enumerate CIM Objects (Classes or Instances) that are associated to a particular source CIM Object.
virtual CIMInstanceArray associatorsA (const String &ns, const CIMObjectPath &path, const String &assocClass=String(), const String &resultClass=String(), const String &role=String(), const String &resultRole=String(), WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_EXCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_EXCLUDE_CLASS_ORIGIN, const StringArray *propertyList=0)
 This operation is used to enumerate CIM Objects (Classes or Instances) that are associated to a particular source CIM Object.
virtual void associatorsClasses (const String &ns, const CIMObjectPath &path, CIMClassResultHandlerIFC &result, const String &assocClass=String(), const String &resultClass=String(), const String &role=String(), const String &resultRole=String(), WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_EXCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_EXCLUDE_CLASS_ORIGIN, const StringArray *propertyList=0)=0
 This operation is used to enumerate CIMClasses that are associated to a particular source CIM Object.
virtual CIMClassEnumeration associatorsClassesE (const String &ns, const CIMObjectPath &path, const String &assocClass=String(), const String &resultClass=String(), const String &role=String(), const String &resultRole=String(), WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_EXCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_EXCLUDE_CLASS_ORIGIN, const StringArray *propertyList=0)
 This operation is used to enumerate CIM Classes that are associated to a particular source CIM Object.
virtual CIMClassArray associatorsClassesA (const String &ns, const CIMObjectPath &path, const String &assocClass=String(), const String &resultClass=String(), const String &role=String(), const String &resultRole=String(), WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_EXCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_EXCLUDE_CLASS_ORIGIN, const StringArray *propertyList=0)
 This operation is used to enumerate CIM Classes that are associated to a particular source CIM Object.
virtual void referenceNames (const String &ns, const CIMObjectPath &path, CIMObjectPathResultHandlerIFC &result, const String &resultClass=String(), const String &role=String())=0
 This operation is used to enumerate the association objects that refer to a particular target CIM Object (Class or Instance).
virtual CIMObjectPathEnumeration referenceNamesE (const String &ns, const CIMObjectPath &path, const String &resultClass=String(), const String &role=String())
 This operation is used to enumerate the association objects that refer to a particular target CIM Object (Class or Instance).
virtual CIMObjectPathArray referenceNamesA (const String &ns, const CIMObjectPath &path, const String &resultClass=String(), const String &role=String())
 This operation is used to enumerate the association objects that refer to a particular target CIM Object (Class or Instance).
virtual void references (const String &ns, const CIMObjectPath &path, CIMInstanceResultHandlerIFC &result, const String &resultClass=String(), const String &role=String(), WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_EXCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_EXCLUDE_CLASS_ORIGIN, const StringArray *propertyList=0)=0
 This operation is used to enumerate the association objects that refer to a particular target CIM Object (Class or Instance).
virtual CIMInstanceEnumeration referencesE (const String &ns, const CIMObjectPath &path, const String &resultClass=String(), const String &role=String(), WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_EXCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_EXCLUDE_CLASS_ORIGIN, const StringArray *propertyList=0)
 This operation is used to enumerate the association objects that refer to a particular target CIM Object (Class or Instance).
virtual CIMInstanceArray referencesA (const String &ns, const CIMObjectPath &path, const String &resultClass=String(), const String &role=String(), WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_EXCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_EXCLUDE_CLASS_ORIGIN, const StringArray *propertyList=0)
 This operation is used to enumerate the association objects that refer to a particular target CIM Object (Class or Instance).
virtual void referencesClasses (const String &ns, const CIMObjectPath &path, CIMClassResultHandlerIFC &result, const String &resultClass=String(), const String &role=String(), WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_EXCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_EXCLUDE_CLASS_ORIGIN, const StringArray *propertyList=0)=0
 This operation is used to enumerate the association objects that refer to a particular target CIM Class.
virtual CIMClassEnumeration referencesClassesE (const String &ns, const CIMObjectPath &path, const String &resultClass=String(), const String &role=String(), WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_EXCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_EXCLUDE_CLASS_ORIGIN, const StringArray *propertyList=0)
 This operation is used to enumerate the association objects that refer to a particular target CIM Class.
virtual CIMClassArray referencesClassesA (const String &ns, const CIMObjectPath &path, const String &resultClass=String(), const String &role=String(), WBEMFlags::EIncludeQualifiersFlag includeQualifiers=WBEMFlags::E_EXCLUDE_QUALIFIERS, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin=WBEMFlags::E_EXCLUDE_CLASS_ORIGIN, const StringArray *propertyList=0)
 This operation is used to enumerate the association objects that refer to a particular target CIM Class.
virtual void execQuery (const String &ns, CIMInstanceResultHandlerIFC &result, const String &query, const String &queryLanguage)=0
 Executes a query to retrieve or modify objects.
virtual CIMInstanceEnumeration execQueryE (const String &ns, const String &query, const String &queryLanguage)
 Executes a query to retrieve or modify objects.
virtual CIMInstanceArray execQueryA (const String &ns, const String &query, const String &queryLanguage)
 Executes a query to retrieve or modify objects.
virtual CIMFeatures getServerFeatures ()
 Get the features of the CIMOM server.
virtual void exportIndication (const CIMInstance &instance, const String &instNS)
 Export a given instance of an indication.

Detailed Description

The CIMOMHandleIFC class is an abstract class used as an interface definition for classes that provide access to a CIMOM.

Definition at line 51 of file OW_CIMOMHandleIFC.hpp.

Constructor & Destructor Documentation

OW_NAMESPACE::CIMOMHandleIFC::~CIMOMHandleIFC (   )  [virtual]
 

Destroy this CIMOMHandleIFC object.

Definition at line 54 of file OW_CIMOMHandleIFC.cpp.

Member Function Documentation

virtual void OW_NAMESPACE::CIMOMHandleIFC::associatorNames (  const String &  ns,
const CIMObjectPath &  objectName,
CIMObjectPathResultHandlerIFC &  result,
const String &  assocClass = String(),
const String &  resultClass = String(),
const String &  role = String(),
const String &  resultRole = String()
)  [pure virtual]
 

This method is used to enumerate the names of CIM Objects (Classes or Instances) that are associated to a particular CIM Object.

Parameters:
ns The namespace containing the CIM Objects to be enumerated.
objectName Defines the source CIM Object whose associated Objects are to be returned. This may be either a Class name or Instance name (modelpath).
result A callback object that will handle the CIMObjectPaths as they are received.
assocClass The AssocClass input parameter, if not empty (""), MUST be a valid CIM Association Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Instance of this Class or one of its subclasses.
resultClass The ResultClass input parameter, if not empty (""), MUST be valid CIM Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be either an Instance of this Class (or one of its subclasses) or be this Class (or one of its subclasses).
role The Role input parameter, if not empty (""), MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the source Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the source Object MUST match the value of this parameter).
resultRole The ResultRole input parameter, if not empty (""), MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the returned Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the returned Object MUST match the value of this parameter).
Exceptions:
CIMException - as defined in the associator method

Implemented in OW_NAMESPACE::BinaryCIMOMHandle, OW_NAMESPACE::CIMXMLCIMOMHandle, OW_NAMESPACE::RepositoryCIMOMHandle, OW_NAMESPACE::MOF::StoreLocalDataHandle, and OW_NAMESPACE::ProviderAgentCIMOMHandle.

Referenced by associatorNamesA(), and associatorNamesE().

CIMObjectPathArray OW_NAMESPACE::CIMOMHandleIFC::associatorNamesA (  const String &  ns,
const CIMObjectPath &  objectName,
const String &  assocClass = String(),
const String &  resultClass = String(),
const String &  role = String(),
const String &  resultRole = String()
)  [virtual]
 

This method is used to enumerate the names of CIM Objects (Classes or Instances that are associated to a particular CIM Object.

See also:
associatorNames
Returns:
If successful, this method returns an array of zero or more full CIM Class paths or Instance paths of Objects meeting the requested criteria.

Definition at line 216 of file OW_CIMOMHandleIFC.cpp.

References associatorNames(), handler, and ns.

CIMObjectPathEnumeration OW_NAMESPACE::CIMOMHandleIFC::associatorNamesE (  const String &  ns,
const CIMObjectPath &  objectName,
const String &  assocClass = String(),
const String &  resultClass = String(),
const String &  role = String(),
const String &  resultRole = String()
)  [virtual]
 

This method is used to enumerate the names of CIM Objects (Classes or Instances that are associated to a particular CIM Object.

See also:
associatorNames
Returns:
If successful, this method returns an enumeration of zero or more full CIM Class paths or Instance paths of Objects meeting the requested criteria.

Definition at line 201 of file OW_CIMOMHandleIFC.cpp.

References associatorNames(), handler, and ns.

virtual void OW_NAMESPACE::CIMOMHandleIFC::associators (  const String &  ns,
const CIMObjectPath &  path,
CIMInstanceResultHandlerIFC &  result,
const String &  assocClass = String(),
const String &  resultClass = String(),
const String &  role = String(),
const String &  resultRole = String(),
WBEMFlags::EIncludeQualifiersFlag  includeQualifiers = WBEMFlags::E_EXCLUDE_QUALIFIERS,
WBEMFlags::EIncludeClassOriginFlag  includeClassOrigin = WBEMFlags::E_EXCLUDE_CLASS_ORIGIN,
const StringArray *  propertyList = 0
)  [pure virtual]
 

This operation is used to enumerate CIM Objects (Classes or Instances) that are associated to a particular source CIM Object.

Parameters:
ns The namspace.
path Defines the path of the source CIM Object whose associated Objects are to be returned. This may be a path to either a Class name or Instance name (model path).
result A callback object that will handle the CIMInstances as they are received.
assocClass The AssocClass input parameter, if not empty (""), MUST be a valid CIM Association Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Instance of this Class or one of its subclasses.
resultClass The ResultClass input parameter, if not empty (""), MUST be a valid CIM Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be either an Instance of this Class (or one of its subclasses) or be this Class (or one of its subclasses).
role The Role input parameter, if not empty (""), MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the source Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the source Object MUST match the value of this parameter).
resultRole The ResultRole input parameter, if not empty (""), MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the returned Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the returned Object MUST match the value of this parameter).
includeQualifiers If set to E_INCLUDE_QUALIFIERS then all Qualifiers for each Object (including Qualifiers on the Object and on any returned Properties) MUST be included as QUALIFIER elements in the response. If set to E_EXCLUDE_QUALIFIERS, then no qualifier elements will be present in the returned object(s).
includeClassOrigin If set to E_INCLUDE_CLASS_ORIGIN, then the CLASSORIGIN attribute MUST be present on all appropriate elements in each returned Object. If set to E_EXCLUDE_CLASS_ORIGIN, no CLASSORIGIN attributes are present in each returned Object.
propertyList If the PropertyList input parameter is not NULL, the members of the array define one or more Property names. Each returned Object MUST NOT include elements for any Properties missing from this list. If the PropertyList input parameter is an empty array this signifies that no Properties are included in each returned Object. If the PropertyList input parameter is NULL this specifies that all Properties (subject to the conditions expressed by the other parameters) are included in each returned Object.
If the PropertyList contains duplicate elements, the Server MUST ignore the duplicates but otherwise process the request normally. If the PropertyList contains elements which are invalid Property names for any target Object, the Server MUST ignore such entries but otherwise process the request normally.

Clients SHOULD NOT explicitly specify properties in the PropertyList parameter unless they have specified a non-empty ("") value for the ResultClass parameter.

Exceptions:
CIMException. The following IDs can be expected: CIM_ERR_ACCESS_DENIED, CIM_ERR_NOT_SUPPORTED, CIM_ERR_INVALID_NAMESPACE, CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or otherwise incorrect parameters), CIM_ERR_FAILED (some other unspecified error occurred).

Implemented in OW_NAMESPACE::BinaryCIMOMHandle, OW_NAMESPACE::CIMXMLCIMOMHandle, OW_NAMESPACE::RepositoryCIMOMHandle, OW_NAMESPACE::MOF::StoreLocalDataHandle, and OW_NAMESPACE::ProviderAgentCIMOMHandle.

Referenced by associatorsA(), and associatorsE().

CIMInstanceArray OW_NAMESPACE::CIMOMHandleIFC::associatorsA (  const String &  ns,
const CIMObjectPath &  path,
const String &  assocClass = String(),
const String &  resultClass = String(),
const String &  role = String(),
const String &  resultRole = String(),
WBEMFlags::EIncludeQualifiersFlag  includeQualifiers = WBEMFlags::E_EXCLUDE_QUALIFIERS,
WBEMFlags::EIncludeClassOriginFlag  includeClassOrigin = WBEMFlags::E_EXCLUDE_CLASS_ORIGIN,
const StringArray *  propertyList = 0
)  [virtual]
 

This operation is used to enumerate CIM Objects (Classes or Instances) that are associated to a particular source CIM Object.

See also:
associators
Returns:
If successful, the method returns an array of zero or more CIM Instances meeting the requested criteria. Since it is possible for CIM Objects from different hosts or namespaces to be associated, each returned Object includes location information.

Definition at line 250 of file OW_CIMOMHandleIFC.cpp.

References associators(), handler, ns, and propertyList.

virtual void OW_NAMESPACE::CIMOMHandleIFC::associatorsClasses (  const String &  ns,
const CIMObjectPath &  path,
CIMClassResultHandlerIFC &  result,
const String &  assocClass = String(),
const String &  resultClass = String(),
const String &  role = String(),
const String &  resultRole = String(),
WBEMFlags::EIncludeQualifiersFlag  includeQualifiers = WBEMFlags::E_EXCLUDE_QUALIFIERS,
WBEMFlags::EIncludeClassOriginFlag  includeClassOrigin = WBEMFlags::E_EXCLUDE_CLASS_ORIGIN,
const StringArray *  propertyList = 0
)  [pure virtual]
 

This operation is used to enumerate CIMClasses that are associated to a particular source CIM Object.

Parameters:
ns The namspace.
path Defines the path of the source CIM Object whose associated Objects are to be returned. This may be a path to either a Class name or Instance name (model path).
result A callback object that will handle the CIMClasses as they are received.
assocClass The AssocClass input parameter, if not empty (""), MUST be a valid CIM Association Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Instance of this Class or one of its subclasses.
resultClass The ResultClass input parameter, if not empty (""), MUST be a valid CIM Class name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be either an Instance of this Class (or one of its subclasses) or be this Class (or one of its subclasses).
role The Role input parameter, if not empty (""), MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the source Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the source Object MUST match the value of this parameter).
resultRole The ResultRole input parameter, if not empty (""), MUST be a valid Property name. It acts as a filter on the returned set of Objects by mandating that each returned Object MUST be associated to the source Object via an Association in which the returned Object plays the specified role (i.e. the name of the Property in the Association Class that refers to the returned Object MUST match the value of this parameter).
includeQualifiers If set to E_INCLUDE_QUALIFIERS then all Qualifiers for each Object (including Qualifiers on the Object and on any returned Properties) MUST be included as elements in the response.If set to E_EXCLUDE_QUALIFIERS, then no qualifiers will be present in the returned object(s).
includeClassOrigin If the IncludeClassOrigin input parameter is set to E_INCLUDE_ORIGIN, then the CLASSORIGIN attribute MUST be present on all appropriate elements in each returned Object. If set to E_EXCLUDE_ORIGIN, no CLASSORIGIN attributes are present in each returned Object.
propertyList If the PropertyList input parameter is not NULL, the members of the array define one or more Property names. Each returned Object MUST NOT include elements for any Properties missing from this list. If the PropertyList input parameter is an empty array this signifies that no Properties are included in each returned Object. If the PropertyList input parameter is NULL this specifies that all Properties (subject to the conditions expressed by the other parameters) are included in each returned Object.
If the PropertyList contains duplicate elements, the Server MUST ignore the duplicates but otherwise process the request normally. If the PropertyList contains elements which are invalid Property names for any target Object, the Server MUST ignore such entries but otherwise process the request normally.

Clients SHOULD NOT explicitly specify properties in the PropertyList parameter unless they have specified a non-empty ("") value for the ResultClass parameter.

Exceptions:
CIMException. The following IDs can be expected: CIM_ERR_ACCESS_DENIED, CIM_ERR_NOT_SUPPORTED, CIM_ERR_INVALID_NAMESPACE, CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or otherwise incorrect parameters), CIM_ERR_FAILED (some other unspecified error occurred)

Implemented in OW_NAMESPACE::BinaryCIMOMHandle, OW_NAMESPACE::CIMXMLCIMOMHandle, OW_NAMESPACE::RepositoryCIMOMHandle, OW_NAMESPACE::MOF::StoreLocalDataHandle, and OW_NAMESPACE::ProviderAgentCIMOMHandle.

Referenced by associatorsClassesA(), and associatorsClassesE().

CIMClassArray OW_NAMESPACE::CIMOMHandleIFC::associatorsClassesA (  const String &  ns,
const CIMObjectPath &  path,
const String &  assocClass = String(),
const String &  resultClass = String(),
const String &  role = String(),
const String &  resultRole = String(),
WBEMFlags::EIncludeQualifiersFlag  includeQualifiers = WBEMFlags::E_EXCLUDE_QUALIFIERS,
W