src/Pegasus/Provider/CIMPropertyProvider.h

   1 //%2003////////////////////////////////////////////////////////////////////////
   2 //
   3 // Copyright (c) 2000, 2001, 2002  BMC Software, Hewlett-Packard Development
   4 // Company, L. P., IBM Corp., The Open Group, Tivoli Systems.
   5 // Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L. P.;
   6 // IBM Corp.; EMC Corporation, The Open Group.
   7 //
   8 // Permission is hereby granted, free of charge, to any person obtaining a copy
   9 // of this software and associated documentation files (the "Software"), to
  10 // deal in the Software without restriction, including without limitation the
  11 // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  12 // sell copies of the Software, and to permit persons to whom the Software is
  13 // furnished to do so, subject to the following conditions:
  14 //
  15 // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
  16 // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
  17 // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
  18 // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  19 // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  20 // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  21 // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  22 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23 //
  24 //==============================================================================
  25 //
  26 // Author: Chip Vincent (cvincent@us.ibm.com)
  27 //
  28 // Modified By:
  29 //
  30 //%/////////////////////////////////////////////////////////////////////////////
  31
  32 #ifndef Pegasus_CIMPropertyProvider_h
  33 #define Pegasus_CIMPropertyProvider_h
  34
  35 #include <Pegasus/Common/Config.h>
  36 #include <Pegasus/Provider/CIMProvider.h>
  37
  38 #include <Pegasus/Common/CIMName.h>
  39 #include <Pegasus/Common/CIMObjectPath.h>
  40 #include <Pegasus/Common/CIMValue.h>
  41 #include <Pegasus/Provider/Linkage.h>
  42
  43 PEGASUS_NAMESPACE_BEGIN
  44
  45 /**
  46 This class defines the set of methods implemented by an property provider. A providers that derives
  47 from this class must implement all methods. The minimal method implementation simply throw the
  48 NotSupported exception.
  49 */
  50 class PEGASUS_PROVIDER_LINKAGE CIMPropertyProvider : public virtual CIMProvider
  51 {
  52 public:
  53     CIMPropertyProvider(void);
  54     virtual ~CIMPropertyProvider(void);
  55
  56     /**
  57     Instructs the provider to get the value specified by the propertyName parameter of the
  58     instance specified by the instanceReference parameter.
  59
  60     @param contex contains security and locale information relevant for the lifetime
  61     of this operation.
  62
  63     @param instanceReference specifies the fully qualified object path of the instance of interest.
  64
  65     @param propertyName specifies the name of the property of interest.
  66
  67     @param handler asynchronusly processes the results of this operation.
  68
  69     @exception NotSupported
  70     @exception InvalidParameter
  71     @exception ObjectNotFound
  72     @exception AccessDenied
  73     @exception OperationFailed
  74     */
  75     virtual void getProperty(
  76         const OperationContext & context,
  77         const CIMObjectPath & instanceReference,
  78         const CIMName & propertyName,
  79         ValueResponseHandler & handler) = 0;
  80
  81     /**
  82     Instructs the provider to set the value specified by the propertyName parameter of the
  83     instance specified by the instanceReference parameter.
  84
  85     @param contex contains security and locale information relevant for the lifetime
  86     of this operation.
  87
  88     @param instanceReference specifies the fully qualified object path of the instance of interest.
  89
  90     @param propertyName specifies the name of the property of interest.
  91
  92     @param handler asynchronusly processes the results of this operation.
  93
  94     @exception NotSupported
  95     @exception InvalidParameter
  96     @exception ObjectNotFound
  97     @exception AccessDenied
  98     @exception OperationFailed
  99     */
 100     virtual void setProperty(
 101         const OperationContext & context,
 102         const CIMObjectPath & instanceReference,
 103         const CIMName & propertyName,
 104         const CIMValue & newValue,
 105         ResponseHandler & handler) = 0;
 106
 107 };
 108
 109 PEGASUS_NAMESPACE_END
 110
 111 #endif