(file) Return to CIMAssociationProvider.h CVS log (file) (dir) Up to [Pegasus] / pegasus / src / Pegasus / Provider

Diff for /pegasus/src/Pegasus/Provider/CIMAssociationProvider.h between version 1.17 and 1.18

version 1.17, 2003/10/22 14:26:11 version 1.18, 2003/11/10 15:51:06
Line 46 
Line 46 
 PEGASUS_NAMESPACE_BEGIN PEGASUS_NAMESPACE_BEGIN
  
 /** /**
 This class defines the set of methods implemented by an association provider. A providers that derives  This class defines the set of methods implemented by an association
 from this class must implement all methods. The minimal method implementation simply throw the  provider.  A providers that derives from this class must implement all of
 NotSupported exception.  the methods.  The minimal method implementation simply throws the
   NotSupported exception. The methods implemented match the association
   operations defined for the client:
       <UL>
       <LI> referenceNames
       <LI> references
       <LI> associatorNames
       <LI> associators
       </UL>
   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.
   
 */ */
 class PEGASUS_PROVIDER_LINKAGE CIMAssociationProvider : public virtual CIMProvider class PEGASUS_PROVIDER_LINKAGE CIMAssociationProvider : public virtual CIMProvider
 { {
Line 57 
Line 68 
     virtual ~CIMAssociationProvider(void);     virtual ~CIMAssociationProvider(void);
  
     /** 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 CIMOM based on the name of the host in which the cimom
          *  resides and the namespace in the request.          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 the
         of this operation.          lifetime of this operation.
   
     @param objectName -  The ObjectName input parameter defines the source CIM Object          @param objectName The ObjectName input parameter defines the source CIM
      *  whose associated Objects are to be returned. This may be either a Class name          Object whose associated Objects are to be returned.  This may be either a
      *  or Instance name (CIMObjectpath).          Class name or Instance name (CIMObjectpath).
   
      @param associationClass - The AssocClass input parameter, if not NULL, MUST be a          @param associationClass The AssocClass input parameter, if not NULL, MUST
      *  valid CIM Association Class name. It acts as a filter on the returned set of          be a valid CIM Association Class name.  It acts as a filter on the
      *  Objects by mandating that each returned Object MUST be associated to the source          returned set of Objects by mandating that each returned Object MUST be
      *  Object via an Instance of this Class or one of its subclasses.          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 as a filter  
      *  on the returned set of Objects by mandating that each returned Object MUST be          @param resultClass If not NULL, this parameter MUST be a valid CIM class
      *  either an Instance of this Class (or one of its subclasses).          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
      @param role - , if not NULL, MUST be a valid Property name. It acts as a filter on          its subclasses).
      *  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          @param role If not NULL, this parameter MUST be a valid Property name.  It
      *  plays the specified role (i.e. the name of the Property in the Association Class          acts as a filter on the returned set of Objects by mandating that each
      *  that refers to the source Object MUST match the value of this parameter).          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
      @param resultRole -  If not NULL, MUST be a valid Property name. It acts as a          Property in the Association Class that refers to the source Object MUST
      *  filter on the returned set of Objects by mandating that each returned Object          match the value of this parameter).
      *  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          @param resultRole If not NULL, this parameter MUST be a valid Property
      *  the Association Class that refers to the returned Object MUST match the          name.  It acts as a filter on the returned set of Objects by mandating
      *  value of this parameter).          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.
      @param includeQualifiers - If true, this specifies that all Qualifiers for each          the name of the Property in the Association Class that refers to the
      *  Object (including Qualifiers on the Object and on any returned Properties)          returned Object MUST match the value of this parameter).
      *  MUST be included as <QUALIFIER> elements in the response. If false no  
      *  <QUALIFIER> elements are present in each returned Object.          @param includeQualifiers If true, this specifies that all Qualifiers for
           each Object (including Qualifiers on the Object and on any returned
      @param includeClassOrigin - If true, this specifies that the CLASSORIGIN attribute          Properties) MUST be included as <QUALIFIER> elements in the response.  If
      *  MUST be present on all appropriate elements in each returned Object.          false no <QUALIFIER> elements are present in each returned Object.
      *  If false, no CLASSORIGIN attributes are present in each returned Object.  
           @param includeClassOrigin If true, this specifies that the CLASSORIGIN
      @param propertyList - If not NULL, the members of the array define one or more          attribute MUST be present on all appropriate elements in each returned
      *  Property names. Each returned Object MUST NOT include elements for any          Object.  If false, no CLASSORIGIN attributes are present in each returned
      *  Properties missing from this list. If the PropertyList input parameter          Object.
      *  is an empty array this signifies that no Properties are included in each  
      *  returned Object. If the PropertyList input parameter is NULL this specifies          @param propertyList If not NULL, the members of the array define one or
      *  that all Properties (subject to the conditions expressed by the other          more roperty names.  Each returned Object MUST NOT include elements for
      *  parameters) are included in each returned Object.          any Properties missing from this list.  If the PropertyList input
           parameter is an empty array this signifies that no Properties are included
     @param handler asynchronously processes the results of this operation.          in each returned Object.  If the PropertyList input parameter is NULL this
           specifies that all Properties (subject to the conditions expressed by the
     @exception NotSupported          other parameters) are included in each returned Object.
     @exception InvalidParameter  
       @param handler Asynchronously processes the results of this operation.
   
       @exception NotSupported Methods not all supported by the provider return this
       exception.
       @exception InvalidParameter If a parameter is not specified correctly.
     */     */
  
     virtual void associators(     virtual void associators(
Line 126 
Line 142 
         const CIMPropertyList & propertyList,         const CIMPropertyList & propertyList,
         ObjectResponseHandler & handler) = 0;         ObjectResponseHandler & handler) = 0;
  
     /**  enumerate the names of CIM Objects (Instances) associated to a      /**  Enumerate the names of CIM Objects (Instances) associated to a
      *   particular source CIM Object. Returns multiple CIMObjectPath objects          particular source CIM Object. 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 the
         of this operation.          lifetime of this operation.
   
     @param objectName -  The ObjectName input parameter defines the source CIM Object          @param objectName The ObjectName input parameter defines the source CIM
      *  whose associated Objects are to be returned. This may be either a Class name          Object whose associated Objects are to be returned.  This may be either a
      *  or Instance name (CIMObjectpath).          Class name or Instance name (CIMObjectpath).
   
      @param associationClass - The AssocClass input parameter, if not NULL, MUST be a          @param associationClass The AssocClass input parameter, if not NULL, MUST
      *  valid CIM Association Class name. It acts as a filter on the returned set of          be a valid CIM Association Class name.  It acts as a filter on the
      *  Objects by mandating that each returned Object MUST be associated to the source          returned set of Objects by mandating that each returned Object MUST be
      *  Object via an Instance of this Class or one of its subclasses.          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 as a filter  
      *  on the returned set of Objects by mandating that each returned Object MUST be          @param resultClass If not NULL, MUST be a valid CIM Class name.  It acts
      *  either an Instance of this Class (or one of its subclasses).          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
      @param role - , if not NULL, MUST be a valid Property name. It acts as a filter on          subclasses).
      *  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          @param role If not NULL, this parameter MUST be a valid Property name.  It
      *  plays the specified role (i.e. the name of the Property in the Association Class          acts as a filter on the returned set of Objects by mandating that each
      *  that refers to the source Object MUST match the value of this parameter).          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
      @param resultRole -  If not NULL, MUST be a valid Property name. It acts as a          Property in the Association Class that refers to the source Object MUST
      *  filter on the returned set of Objects by mandating that each returned Object          match the value of this parameter).
      *  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          @param resultRole If not NULL, this parameter MUST be a valid Property
      *  the Association Class that refers to the returned Object MUST match the          name.  It acts as a filter on the returned set of Objects by mandating
      *  value of this parameter).          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 handler asynchronously processes the results of this operation.          @param handler Asynchronously processes the results of this operation.
  
     @exception NotSupported          @exception NotSupported returned by methods that are not implemented by the provider..
     @exception InvalidParameter          @exception InvalidParameter If a parameter is not specified correctly.
     */     */
     virtual void associatorNames(     virtual void associatorNames(
         const OperationContext & context,         const OperationContext & context,
Line 177 
Line 196 
         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 CIM Object
      * (Instance).  Returns multiple CIMObjectPath objects          (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 the lifetime
         of this operation.         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 are to be returned.
      * Note that only instances will be forwarded to the provider. All class level           Note that only instances will be forwarded to the provider. All class level
      * requests are handled by the CIM Server internally.           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          @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           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).           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.     @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           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           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           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           in the Association Class that refers to the source Object MUST match the value
      * of this parameter.           of this parameter.
   
     @param resultRole -  If not NULL, MUST be a valid Property name. It acts as a          @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           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           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           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           the Association Class that refers to the returned Object MUST match the
      *  value of this parameter).           value of this parameter).
   
      @param includeQualifiers - If true, this specifies that all Qualifiers for each           @param includeQualifiers If true, this specifies that all Qualifiers for each
      *  Object (including Qualifiers on the Object and on any returned Properties)           Object (including Qualifiers on the Object and on any returned Properties)
      *  MUST be included as <QUALIFIER> elements in the response. If false no           MUST be included as <QUALIFIER> elements in the response. If false no
      *  <QUALIFIER> elements are present in each returned Object.           <QUALIFIER> elements are present in each returned Object.
   
      @param includeClassOrigin - If true, this specifies that the CLASSORIGIN attribute           @param includeClassOrigin If true, this specifies that the CLASSORIGIN attribute
      *  MUST be present on all appropriate elements in each returned Object.           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 returned Object.
          *  
      @param propertyList - If not NULL, the members of the array define one or more      @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           Property names. Each returned Object MUST NOT include elements for any
      *  Properties missing from this list. If the PropertyList input parameter           Properties missing from this list. If the PropertyList input parameter
      *  is an empty array this signifies that no Properties are included in each           is an empty array this signifies that no Properties are included in each
      *  returned Object. If the PropertyList input parameter is NULL this specifies           returned Object. If the PropertyList input parameter is NULL this specifies
      *  that all Properties (subject to the conditions expressed by the other           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          @exception NotSupported Returned for any methods not implemented by the provider.
     @exception InvalidParameter          @exception InvalidParameter If a parameter is not specified correctly.
     */     */
     virtual void references(     virtual void references(
         const OperationContext & context,         const OperationContext & context,
Line 241 
Line 260 
         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 target CIM Object
      * (Instance). Returns CIMOobjectPath objects via the handler.          (Instance). Returns CIMOobjectPath objects via the handler.
          * The returned CIMObjectPaths are expected to be          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 the lifetime
     of this operation.     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 are to be returned.
      * Note that only instances will be forwarded to the provider. All class level           Note that only instances will be forwarded to the provider. All class level
      * requests are handled by the CIM Server internally.           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          @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           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           MUST identify an Instance of this Class (or one of its subclasses), or this Class
      *  (or one of its subclasses)           (or one of its subclasses)
      *  
     @param role  The Role input parameter, if not NULL, MUST be a valid Property name.     @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           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           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           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           in the Association Class that refers to the source Object MUST match the value
      * of this parameter.           of this parameter.
  
     @param handler asynchronously processes the results of this operation.          @param handler Asynchronously processes the results of this operation.
  
     @exception NotSupported          @exception NotSupported xception returned for any method not implemented by the provider.
     @exception InvalidParameter          @exception InvalidParameter If the parameter is not specified correctly.
     */     */
     virtual void referenceNames(     virtual void referenceNames(
         const OperationContext & context,         const OperationContext & context,

Legend:
Removed from v.1.17  
changed lines
  Added in v.1.18
No CVS admin address has been configured
 Powered by
ViewCVS 0.9.2