version 1.22, 2006/01/30 16:17:59
|
version 1.23, 2006/11/14 18:34:54
|
|
|
<LI> associatorNames | <LI> associatorNames |
<LI> associators | <LI> associators |
</UL> | </UL> |
Note that the major difference is that the attributes implemented are not exactly |
Note that the major difference is that the attributes implemented are |
the same as the attributes of the operations implemented for the client. |
not exactly the same as the attributes of the operations implemented |
|
for the client. |
*/ | */ |
class PEGASUS_PROVIDER_LINKAGE CIMAssociationProvider : public virtual CIMProvider |
class PEGASUS_PROVIDER_LINKAGE CIMAssociationProvider : |
|
public virtual CIMProvider |
{ | { |
public: | public: |
CIMAssociationProvider(void); |
CIMAssociationProvider(); |
virtual ~CIMAssociationProvider(void); |
virtual ~CIMAssociationProvider(); |
| |
/** Enumerates CIM Objects (Instances only) that are associated to a | /** Enumerates CIM Objects (Instances only) that are associated to a |
particular source CIM Object. Returns CIM Objects. NOTE: if the objects | particular source CIM Object. Returns CIM Objects. NOTE: if the objects |
do not include the host and namespace information this information will | 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 |
be inserted by the CIM Server based on the name of the host in which |
resides and the namespace in the request. |
the CIM Server is running and the namespace in the request. |
| |
@param context Contains security and locale information relevant for the |
@param context Contains security and locale information relevant for |
lifetime of this operation. |
the lifetime of this operation. |
| |
@param objectName The ObjectName input parameter defines the source CIM | @param objectName The ObjectName input parameter defines the source CIM |
Object whose associated Objects are to be returned. This may be either a |
Object whose associated Objects are to be returned. This may be either |
Class name or Instance name (CIMObjectpath). |
a Class name or Instance name (CIMObjectpath). |
| |
@param associationClass The AssocClass input parameter, if not NULL, MUST |
@param associationClass The AssocClass input parameter, if not NULL, |
be a valid CIM Association Class name. It acts as a filter on the |
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 | 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 | associated to the source Object via an Instance of this Class or one of |
its subclasses. | its subclasses. |
| |
@param resultClass If not NULL, this parameter MUST be a valid CIM class |
@param resultClass If not NULL, this parameter MUST be a valid CIM |
name. It act as a filter on the returned set of Objects by mandating that |
class name. It act as a filter on the returned set of Objects by |
each returned Object MUST be either an Instance of this Class (or one of |
mandating that each returned Object MUST be either an Instance of |
its subclasses). |
this Class (or one of its subclasses). |
|
|
@param role If not NULL, this parameter MUST be a valid Property name. It |
@param role If not NULL, this parameter MUST be a valid Property |
acts as a filter on the returned set of Objects by mandating that each |
name. It acts as a filter on the returned set of Objects by |
returned Object MUST be associated to the source Object via an Association |
mandating that each returned Object MUST be associated to the |
in which the source Object plays the specified role (i.e. the name of the |
source Object via an Association in which the source Object plays |
Property in the Association Class that refers to the source Object MUST |
the specified role (i.e. the name of the Property in the |
match the value of this parameter). |
Association Class that refers to the source Object MUST match the |
|
value of this parameter). |
| |
@param resultRole If not NULL, this parameter MUST be a valid Property | @param 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 | name. It acts as a filter on the returned set of Objects by mandating |
|
|
the name of the Property in the Association Class that refers to the | the name of the Property in the Association Class that refers to the |
returned Object MUST match the value of this parameter). | returned Object MUST match the value of this parameter). |
| |
@param includeQualifiers If true, this specifies that all Qualifiers for |
@param includeQualifiers If true, this specifies that all Qualifiers |
each Object (including Qualifiers on the Object and on any returned |
for each Object (including Qualifiers on the Object and on any returned |
Properties) MUST be included as <QUALIFIER> elements in the response. If |
Properties) MUST be included as <QUALIFIER> elements in the response. |
false no <QUALIFIER> elements are present in each returned Object. |
If false no <QUALIFIER> elements are present in each returned Object. |
| |
@param includeClassOrigin If true, this specifies that the CLASSORIGIN | @param includeClassOrigin If true, this specifies that the CLASSORIGIN |
attribute MUST be present on all appropriate elements in each returned | attribute MUST be present on all appropriate elements in each returned |
Object. If false, no CLASSORIGIN attributes are present in each returned |
Object. If false, no CLASSORIGIN attributes are present in each |
Object. |
returned Object. |
| |
@param propertyList If not NULL, the members of the array define one or | @param propertyList If not NULL, the members of the array define one or |
more roperty names. Each returned Object MUST NOT include elements for | more roperty names. Each returned Object MUST NOT include elements for |
any Properties missing from this list. If the PropertyList input | any Properties missing from this list. If the PropertyList input |
parameter is an empty array this signifies that no Properties are included |
parameter is an empty array this signifies that no Properties are |
in each returned Object. If the PropertyList input parameter is NULL this |
included in each returned Object. If the PropertyList input |
specifies that all Properties (subject to the conditions expressed by the |
parameter is NULL this specifies that all Properties (subject to |
other parameters) are included in each returned Object. |
the conditions expressed by the other parameters) are included in |
|
each returned Object. |
| |
@param handler Asynchronously processes the results of this operation. | @param handler Asynchronously processes the results of this operation. |
| |
@exception NotSupported Methods not all supported by the provider return this |
@exception NotSupported Methods not all supported by the provider |
exception. |
return this exception. |
@exception InvalidParameter If a parameter is not specified correctly. | @exception InvalidParameter If a parameter is not specified correctly. |
*/ | */ |
|
|
virtual void associators( | virtual void associators( |
const OperationContext & context, | const OperationContext & context, |
const CIMObjectPath & objectName, | const CIMObjectPath & objectName, |
|
|
supplied by the provider they will be inserted by the CIMOM based on | 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. | the host in which the CIMOM resides and the namespace in the request. |
| |
@param context Contains security and locale information relevant for the |
@param context Contains security and locale information relevant for |
lifetime of this operation. |
the lifetime of this operation. |
| |
@param objectName The ObjectName input parameter defines the source CIM | @param objectName The ObjectName input parameter defines the source CIM |
Object whose associated Objects are to be returned. This may be either a |
Object whose associated Objects are to be returned. This may be either |
Class name or Instance name (CIMObjectpath). |
a Class name or Instance name (CIMObjectpath). |
|
|
@param 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. |
|
| |
@param resultClass If not NULL, MUST be a valid CIM Class name. It acts |
@param associationClass The AssocClass input parameter, if not NULL, |
as a filter on the returned set of Objects by mandating that each returned |
MUST be a valid CIM Association Class name. It acts as a filter on |
Object MUST be either an Instance of this Class (or one of its |
the returned set of Objects by mandating that each returned Object |
subclasses). |
MUST be associated to the source Object via an Instance of this |
|
Class or one of its subclasses. |
@param 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 |
@param resultClass If not NULL, MUST be a valid CIM Class name. It |
returned Object MUST be associated to the source Object via an Association |
acts as a filter on the returned set of Objects by mandating that |
in which the source Object plays the specified role (i.e. the name of the |
each returned Object MUST be either an Instance of this Class (or |
Property in the Association Class that refers to the source Object MUST |
one of its subclasses). |
match the value of this parameter). |
|
|
@param 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). |
| |
@param resultRole If not NULL, this parameter MUST be a valid Property | @param 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 | name. It acts as a filter on the returned set of Objects by mandating |
|
|
| |
@param handler Asynchronously processes the results of this operation. | @param handler Asynchronously processes the results of this operation. |
| |
@exception NotSupported returned by methods that are not implemented by the provider.. |
@exception NotSupported returned by methods that are not implemented |
|
by the provider. |
@exception InvalidParameter If a parameter is not specified correctly. | @exception InvalidParameter If a parameter is not specified correctly. |
*/ | */ |
virtual void associatorNames( | virtual void associatorNames( |
|
|
const String & resultRole, | const String & resultRole, |
ObjectPathResponseHandler & handler) = 0; | ObjectPathResponseHandler & handler) = 0; |
| |
/** Enumerate the association objects that refer to a particular target CIM Object |
/** Enumerate the association objects that refer to a particular target |
(Instance). Returns multiple CIMObjectPath objects |
CIM Object (Instance). Returns multiple CIMObjectPath objects |
through the handler. The returned CIMObjectPaths are expected to be | through the handler. The returned CIMObjectPaths are expected to be |
absolute including host name and namespace. If these fields are not | absolute including host name and namespace. If these fields are not |
supplied by the provider they will be inserted by the CIMOM based on | 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. | the host in which the CIMOM resides and the namespace in the request. |
| |
@param context Contains security and locale information relevant for the lifetime |
@param context Contains security and locale information relevant for |
of this operation. |
the lifetime of this operation. |
|
|
@param 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. |
|
|
|
@param 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). |
|
|
|
@param 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. |
|
|
|
@param 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). |
|
| |
@param includeQualifiers If true, this specifies that all Qualifiers for each |
@param objectName The target CIM Object whose referring object |
Object (including Qualifiers on the Object and on any returned Properties) |
names are to be returned. Note that only instances will be |
MUST be included as <QUALIFIER> elements in the response. If false no |
forwarded to the provider. All class level requests are handled |
<QUALIFIER> elements are present in each returned Object. |
by the CIM Server internally. |
|
|
@param includeClassOrigin If true, this specifies that the CLASSORIGIN attribute |
@param resultClass If not NULL, MUST be a valid CIM Class name. It |
MUST be present on all appropriate elements in each returned Object. |
acts as a filter on the returned set of Object Names by mandating |
If false, no CLASSORIGIN attributes are present in each returned Object. |
that each returned Object Name MUST identify an Instance of this |
|
Class (or one of its subclasses). |
@param propertyList - If not NULL, the members of the array define one or more |
|
Property names. Each returned Object MUST NOT include elements for any |
@param role The Role input parameter, if not NULL, MUST be a |
Properties missing from this list. If the PropertyList input parameter |
valid Property name. It acts as a filter on the returned set of |
is an empty array this signifies that no Properties are included in each |
Objects by mandating that each returned Object MUST be associated |
returned Object. If the PropertyList input parameter is NULL this specifies |
to the source Object via an Association in which the source Object |
that all Properties (subject to the conditions expressed by the other |
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. |
|
|
|
@param 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). |
|
|
|
@param 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 <QUALIFIER> elements in |
|
the response. If false no <QUALIFIER> elements are present in each |
|
returned Object. |
|
|
|
@param 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. |
|
|
|
@param 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. | parameters) are included in each returned Object. |
| |
@param handler Asynchronously processes the results of this operation. | @param handler Asynchronously processes the results of this operation. |
| |
@exception NotSupported Returned for any methods not implemented by the provider. |
@exception NotSupported Returned for any methods not implemented by |
|
the provider. |
@exception InvalidParameter If a parameter is not specified correctly. | @exception InvalidParameter If a parameter is not specified correctly. |
*/ | */ |
virtual void references( | virtual void references( |
|
|
const CIMPropertyList & propertyList, | const CIMPropertyList & propertyList, |
ObjectResponseHandler & handler) = 0; | ObjectResponseHandler & handler) = 0; |
| |
/** Enumerate the association object names that refer to a particular target CIM Object |
/** Enumerate the association object names that refer to a particular |
(Instance). Returns CIMOobjectPath objects via the handler. |
target CIM Object (Instance). Returns CIMOobjectPath objects via the |
The returned CIMObjectPaths are expected to be |
handler. The returned CIMObjectPaths are expected to be |
absolute including host name and namespace. If these fields are not | absolute including host name and namespace. If these fields are not |
supplied by the provider they will be inserted by the CIMOM based on | 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. | the host in which the CIMOM resides and the namespace in the request. |
| |
@param context Contains security and locale information relevant for the lifetime |
@param context Contains security and locale information relevant for |
of this operation. |
the lifetime of this operation. |
| |
@param objectName The target CIM Object whose referring object names are to be returned. |
@param objectName The target CIM Object whose referring object names |
Note that only instances will be forwarded to the provider. All class level |
are to be returned. Note that only instances will be forwarded to |
requests are handled by the CIM Server internally. |
the provider. All class level requests are handled by the CIM Server |
|
internally. |
@param 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 |
@param resultClass If not NULL, MUST be a valid CIM Class name. It |
MUST identify an Instance of this Class (or one of its subclasses), or this Class |
acts as a filter on the returned set of Object Names by mandating |
(or one of its subclasses) |
that each returned Object Name MUST identify an Instance of this |
|
Class (or one of its subclasses), or this Class (or one of its |
@param role The Role input parameter, if not NULL, MUST be a valid Property name. |
subclasses) |
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 |
@param role The Role input parameter, if not NULL, MUST be a |
source Object plays the specified role (i.e. the name of the Property |
valid Property name. It acts as a filter on the returned set of |
in the Association Class that refers to the source Object MUST match the value |
Objects by mandating that each returned Object MUST be associated |
of this parameter. |
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. |
| |
@param handler Asynchronously processes the results of this operation. | @param handler Asynchronously processes the results of this operation. |
| |
@exception NotSupported xception returned for any method not implemented by the provider. |
@exception NotSupported xception returned for any method not |
|
implemented by the provider. |
@exception InvalidParameter If the parameter is not specified correctly. | @exception InvalidParameter If the parameter is not specified correctly. |
*/ | */ |
virtual void referenceNames( | virtual void referenceNames( |