This class defines the set of methods implemented by an association provider.

Documentation

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. The minimal method implementation simply throws the NotSupported exception. The methods implemented match the association operations defined for the client:

• referenceNames
• references
• associatorNames
• associators

Note that the major difference is that the attributes implemented are not exactly the same as the attributes of the operations implemented for the client.

Inheritance:

Public Methods

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) Enumerates CIM Objects (Instances only) that are associated to a particular source CIM Object.
virtual void	associatorNames ( const OperationContext & context, const CIMObjectPath & objectName, const CIMName & associationClass, const CIMName & resultClass, const String & role, const String & resultRole, ObjectPathResponseHandler & handler) Enumerate the names of CIM Objects (Instances) associated to a particular source CIM Object.
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) Enumerate the association objects that refer to a particular target CIM Object (Instance).
virtual void	referenceNames ( const OperationContext & context, const CIMObjectPath & objectName, const CIMName & resultClass, const String & role, ObjectPathResponseHandler & handler) Enumerate the association object names that refer to a particular target CIM Object (Instance).

Inherited from CIMProvider:

Public Methods

virtual void initialize(CIMOMHandle & cimom)

virtual void terminate(void)

virtual Boolean tryTerminate(void)

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

Enumerates CIM Objects (Instances only) that are associated to a particular source CIM Object. Returns CIM Objects. NOTE: if the objects do not include the host and namespace information this information will be inserted by the CIMOM based on the name of the host in which the cimom resides and the namespace in the request.

Throws:

NotSupported Methods not all supported by the provider return this exception.
InvalidParameter If a parameter is not specified correctly.

Parameters:

context - Contains security and locale information relevant for the lifetime of this operation.
objectName - The ObjectName input parameter defines the source CIM Object whose associated Objects are to be returned. This may be either a Class name or Instance name (CIMObjectpath).
associationClass - The AssocClass input parameter, if not NULL, 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 - If not NULL, this parameter MUST be a valid CIM class name. It act 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).
role - If not NULL, this parameter 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 - If not NULL, this parameter 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 true, this specifies that all Qualifiers for each Object (including Qualifiers on the Object and on any returned Properties) MUST be included as elements in the response. If false no elements are present in each returned Object.
includeClassOrigin - If true, this specifies that the CLASSORIGIN attribute MUST be present on all appropriate elements in each returned Object. If false, no CLASSORIGIN attributes are present in each returned Object.
propertyList - If not NULL, the members of the array define one or more roperty 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.
handler - Asynchronously processes the results of this operation.

virtual void associatorNames( const OperationContext & context, const CIMObjectPath & objectName, const CIMName & associationClass, const CIMName & resultClass, const String & role, const String & resultRole, ObjectPathResponseHandler & handler) = 0

Enumerate the names of CIM Objects (Instances) associated to a particular source CIM Object. Returns multiple CIMObjectPath objects through the handler. The returned CIMObjectPaths are expected to be absolute including host name and namespace. If these fields are not supplied by the provider they will be inserted by the CIMOM based on the host in which the CIMOM resides and the namespace in the request.

Throws:

NotSupported returned by methods that are not implemented by the provider..
InvalidParameter If a parameter is not specified correctly.

Parameters:

context - Contains security and locale information relevant for the lifetime of this operation.
objectName - The ObjectName input parameter defines the source CIM Object whose associated Objects are to be returned. This may be either a Class name or Instance name (CIMObjectpath).
associationClass - The AssocClass input parameter, if not NULL, 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 - If not NULL, 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).
role - If not NULL, this parameter 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 - If not NULL, this parameter 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).
handler - Asynchronously processes the results of this operation.

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

Enumerate the association objects that refer to a particular target CIM Object (Instance). Returns multiple CIMObjectPath objects through the handler. The returned CIMObjectPaths are expected to be absolute including host name and namespace. If these fields are not supplied by the provider they will be inserted by the CIMOM based on the host in which the CIMOM resides and the namespace in the request.

Throws:

NotSupported Returned for any methods not implemented by the provider.
InvalidParameter If a parameter is not specified correctly.

Parameters:

context - Contains security and locale information relevant for the lifetime of this operation.
objectName - The target CIM Object whose referring object names are to be returned. Note that only instances will be forwarded to the provider. All class level requests are handled by the CIM Server internally.
resultClass - If not NULL, MUST be a valid CIM Class name. It acts as a filter on the returned set of Object Names by mandating that each returned Object Name MUST identify an Instance of this Class (or one of its subclasses).
role - The Role input parameter, if not NULL, 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 - If not NULL, 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 true, this specifies that all Qualifiers for each Object (including Qualifiers on the Object and on any returned Properties) MUST be included as elements in the response. If false no elements are present in each returned Object.
includeClassOrigin - If true, this specifies that the CLASSORIGIN attribute MUST be present on all appropriate elements in each returned Object. If false, no CLASSORIGIN attributes are present in each returned Object.
propertyList - - If 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.
handler - Asynchronously processes the results of this operation.

virtual void referenceNames( const OperationContext & context, const CIMObjectPath & objectName, const CIMName & resultClass, const String & role, ObjectPathResponseHandler & handler) = 0

Enumerate the association object names that refer to a particular target CIM Object (Instance). Returns CIMOobjectPath objects via the handler. The returned CIMObjectPaths are expected to be absolute including host name and namespace. If these fields are not supplied by the provider they will be inserted by the CIMOM based on the host in which the CIMOM resides and the namespace in the request.

Throws:

NotSupported xception returned for any method not implemented by the provider.
InvalidParameter If the parameter is not specified correctly.

Parameters:

context - Contains security and locale information relevant for the lifetime of this operation.
objectName - The target CIM Object whose referring object names are to be returned. Note that only instances will be forwarded to the provider. All class level requests are handled by the CIM Server internally.
resultClass - If not NULL, MUST be a valid CIM Class name. It acts as a filter on the returned set of Object Names by mandating that each returned Object Name MUST identify an Instance of this Class (or one of its subclasses), or this Class (or one of its subclasses)
role - The Role input parameter, if not NULL, 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.
handler - Asynchronously processes the results of this operation.

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java