CIMAssociationProvider Class Reference

#include <CIMAssociationProvider.h>

Inheritance diagram for CIMAssociationProvider:
CIMProvider

List of all members.

Public Member Functions

 CIMAssociationProvider ()
virtual ~CIMAssociationProvider ()
virtual void associators (const OperationContext &context, const CIMObjectPath &objectName, const CIMName &associationClass, const CIMName &resultClass, const String &role, const String &resultRole, const Boolean includeQualifiers, const Boolean includeClassOrigin, const CIMPropertyList &propertyList, ObjectResponseHandler &handler)=0
virtual void associatorNames (const OperationContext &context, const CIMObjectPath &objectName, const CIMName &associationClass, const CIMName &resultClass, const String &role, const String &resultRole, ObjectPathResponseHandler &handler)=0
virtual void references (const OperationContext &context, const CIMObjectPath &objectName, const CIMName &resultClass, const String &role, const Boolean includeQualifiers, const Boolean includeClassOrigin, const CIMPropertyList &propertyList, ObjectResponseHandler &handler)=0
virtual void referenceNames (const OperationContext &context, const CIMObjectPath &objectName, const CIMName &resultClass, const String &role, ObjectPathResponseHandler &handler)=0

Detailed Description

This class defines the set of methods implemented by an association provider. A providers that derives from this class must implement all of the methods. A minimal method implementation simply throws a CIMNotSupportedException. The methods match the association operations defined for the client:

  • referenceNames
  • references
  • associatorNames
  • associators

Provider instrumentation differs semantically from a client request in that a provider implementation is specific to one association class while a client request may span many association classes. Also, an assocation provider deals only with instance data, while a client may also issue class level association requests.


Constructor & Destructor Documentation


Member Function Documentation

virtual void CIMAssociationProvider::associatorNames ( const OperationContext context,
const CIMObjectPath objectName,
const CIMName associationClass,
const CIMName resultClass,
const String role,
const String resultRole,
ObjectPathResponseHandler handler 
) [pure virtual]

Enumerates CIM instance names that are associated to a specified instance via a specified association class.

Parameters:
contextAn OperationContext object containing the context for the processing of the operation. The context includes the name of the requesting user, language information, and other data.
objectNameA fully qualified CIMObjectPath specifying the "source" instance for which to enumerate associated instance names.
associationClassThe name of the association class through which the returned instance names are associated with the source instance. Names of instances associated through another class must not be returned.
resultClassThe name of the class to which the returned instance names must belong. Names of instances of this class and its subclasses may be returned, but not instances of another class. If null, the set of returned instance names is not constrained by their class.
roleThe role of the source instance in the association instance. If the role is not an empty string, the returned instance names must be associated with the source instance such that the name of the assocation property referring to the source instance matches the role value.
resultRoleThe role of the returned instance names in the association instance. If the role is not an empty string, the returned instance names must be associated with the source instance such that the name of the assocation property referring to the returned instance names matches the role value.
handlerResponseHandler object for delivery of results. Note: The delivered instance names are expected to contain host and namespace information. If not included, they are added by the CIM Server.
Exceptions:
CIMNotSupportedException
CIMInvalidParameterException
CIMAccessDeniedException
CIMOperationFailedException
virtual void CIMAssociationProvider::associators ( const OperationContext context,
const CIMObjectPath objectName,
const CIMName associationClass,
const CIMName resultClass,
const String role,
const String resultRole,
const Boolean  includeQualifiers,
const Boolean  includeClassOrigin,
const CIMPropertyList propertyList,
ObjectResponseHandler handler 
) [pure virtual]

Enumerates CIM instances that are associated to a specified instance via a specified association class.

Parameters:
contextAn OperationContext object containing the context for the processing of the operation. The context includes the name of the requesting user, language information, and other data.
objectNameA fully qualified CIMObjectPath specifying the "source" instance for which to enumerate associated instances.
associationClassThe name of the association class through which the returned instances are associated with the source instance. Instances associated through another class must not be returned.
resultClassThe name of the class to which the returned instances must belong. Instances of this class and its subclasses may be returned, but not instances of another class. If null, the set of returned instances is not constrained by their class.
roleThe role of the source instance in the association instance. If the role is not an empty string, the returned instances must be associated with the source instance such that the name of the assocation property referring to the source instance matches the role value.
resultRoleThe role of the returned instances in the association instance. If the role is not an empty string, the returned instances must be associated with the source instance such that the name of the assocation property referring to the returned instances matches the role value.
includeQualifiersA Boolean indicating whether the returned instances must include the qualifiers for the instance and its properties. Qualifiers may be included even if this flag is false.
includeClassOriginA Boolean indicating whether the returned instances must include the class origin for each of the instance elements.
propertyListA CIMPropertyList specifying the minimum set of properties required in the returned instances. Support for this parameter is optional, so the returned instance may contain properties not specified in the list. A null propertyList indicates that all properties must be included. A non-null, but empty, propertyList indicates that no properites are required.
handlerResponseHandler object for delivery of results. Note: The delivered instances are expected to contain the instance path. If the host and namespace are not included in the path, they are added by the CIM Server.
Exceptions:
CIMNotSupportedException
CIMInvalidParameterException
CIMAccessDeniedException
CIMOperationFailedException
virtual void CIMAssociationProvider::referenceNames ( const OperationContext context,
const CIMObjectPath objectName,
const CIMName resultClass,
const String role,
ObjectPathResponseHandler handler 
) [pure virtual]

Enumerates the names of CIM association instances that refer to a specified instance.

Parameters:
contextAn OperationContext object containing the context for the processing of the operation. The context includes the name of the requesting user, language information, and other data.
objectNameA fully qualified CIMObjectPath specifying the "source" instance for which to enumerate referring instance names.
resultClassThe class name of the association instance names to be returned. Names of instances of other classes must not be returned.
roleThe role of the source instance in the association instance. If the role is not an empty string, the returned association instance names must refer to the source instance via a property whose name matches the role value.
handlerResponseHandler object for delivery of results. Note: The delivered instance names are expected to contain host and namespace information. If not included, they are added by the CIM Server.
Exceptions:
CIMNotSupportedException
CIMInvalidParameterException
CIMAccessDeniedException
CIMOperationFailedException
virtual void CIMAssociationProvider::references ( const OperationContext context,
const CIMObjectPath objectName,
const CIMName resultClass,
const String role,
const Boolean  includeQualifiers,
const Boolean  includeClassOrigin,
const CIMPropertyList propertyList,
ObjectResponseHandler handler 
) [pure virtual]

Enumerates CIM association instances that refer to a specified instance.

Parameters:
contextAn OperationContext object containing the context for the processing of the operation. The context includes the name of the requesting user, language information, and other data.
objectNameA fully qualified CIMObjectPath specifying the "source" instance for which to enumerate referring instances.
resultClassThe class name of the association instances to be returned. Instances of other classes must not be returned.
roleThe role of the source instance in the association instance. If the role is not an empty string, the returned association instances must refer to the source instance via a property whose name matches the role value.
includeQualifiersA Boolean indicating whether the returned instances must include the qualifiers for the instance and its properties. Qualifiers may be included even if this flag is false.
includeClassOriginA Boolean indicating whether the returned instances must include the class origin for each of the instance elements.
propertyListA CIMPropertyList specifying the minimum set of properties required in the returned instances. Support for this parameter is optional, so the returned instance may contain properties not specified in the list. A null propertyList indicates that all properties must be included. A non-null, but empty, propertyList indicates that no properites are required.
handlerResponseHandler object for delivery of results. Note: The delivered instances are expected to contain the instance path. If the host and namespace are not included in the path, they are added by the CIM Server.
Exceptions:
CIMNotSupportedException
CIMInvalidParameterException
CIMAccessDeniedException
CIMOperationFailedException

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