src/Pegasus/Provider/CIMClassProvider.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_CIMClassProvider_h
  33 #define Pegasus_CIMClassProvider_h
  34
  35 #include <Pegasus/Common/Config.h>
  36 #include <Pegasus/Provider/CIMProvider.h>
  37
  38 #include <Pegasus/Common/Array.h>
  39 #include <Pegasus/Common/CIMPropertyList.h>
  40 #include <Pegasus/Common/CIMObjectPath.h>
  41 #include <Pegasus/Common/CIMClass.h>
  42 #include <Pegasus/Provider/Linkage.h>
  43
  44 PEGASUS_NAMESPACE_BEGIN
  45
  46 /**
  47 This class defines the set of methods implemented by an class provider. A providers that derives
  48 from this class must implement all methods. The minimal method implementation simply throw the
  49 NotSupported exception.
  50 */
  51     class PEGASUS_PROVIDER_LINKAGE CIMClassProvider : public virtual CIMProvider
  52 {
  53 public:
  54     CIMClassProvider(void);
  55     virtual ~CIMClassProvider(void);
  56
  57     /**
  58
  59     @param contex contains security and locale information relevant for the lifetime
  60     of this operation.
  61
  62     @param classReference
  63     @param localOnly
  64     @param includeQualifiers
  65     @param includeClassOrigin
  66     @param propertyList
  67
  68     @param handler asynchronusly processes the results of this operation.
  69
  70     @exception NotSupported
  71     @exception InvalidParameter
  72     */
  73     virtual void getClass(
  74         const OperationContext & context,
  75         const CIMObjectPath & classReference,
  76         const Boolean localOnly,
  77         const Boolean includeQualifiers,
  78         const Boolean includeClassOrigin,
  79         const CIMPropertyList & propertyList,
  80         ClassResponseHandler & handler) = 0;
  81
  82     /**
  83     @param contex contains security and locale information relevant for the lifetime
  84     of this operation.
  85
  86     @param classReference
  87     @param deepInheritance
  88     @param localOnly
  89     @param includeQualifiers
  90     @param includeClassOrigin
  91
  92     @param handler asynchronusly processes the results of this operation.
  93
  94     @exception NotSupported
  95     @exception InvalidParameter
  96     */
  97     virtual void enumerateClasses(
  98         const OperationContext & context,
  99         const CIMObjectPath & classReference,
 100         const Boolean deepInheritance,
 101         const Boolean localOnly,
 102         const Boolean includeQualifiers,
 103         const Boolean includeClassOrigin,
 104         ClassResponseHandler & handler) = 0;
 105
 106     /**
 107     @param contex contains security and locale information relevant for the lifetime
 108     of this operation.
 109
 110     @param classReference
 111     @param deepInheritance
 112
 113     @param handler asynchronusly processes the results of this operation.
 114
 115     @exception NotSupported
 116     @exception InvalidParameter
 117     */
 118     virtual void enumerateClassNames(
 119         const OperationContext & context,
 120         const CIMObjectPath & classReference,
 121         const Boolean deepInheritance,
 122         ObjectPathResponseHandler & handler) = 0;
 123
 124     /**
 125     @param contex contains security and locale information relevant for the lifetime
 126     of this operation.
 127
 128     @param classReference
 129     @param classObject
 130
 131     @param handler asynchronusly processes the results of this operation.
 132
 133     @exception NotSupported
 134     @exception InvalidParameter
 135     */
 136     virtual void modifyClass(
 137         const OperationContext & context,
 138         const CIMObjectPath & classReference,
 139         const CIMClass & classObject,
 140         ResponseHandler & handler) = 0;
 141
 142     /**
 143     @param contex contains security and locale information relevant for the lifetime
 144     of this operation.
 145
 146     @param classReference
 147     @param classObject
 148
 149     @param handler asynchronusly processes the results of this operation.
 150
 151     @exception NotSupported
 152     @exception InvalidParameter
 153     */
 154     virtual void createClass(
 155         const OperationContext & context,
 156         const CIMObjectPath & classReference,
 157         const CIMClass & classObject,
 158         ResponseHandler & handler) = 0;
 159
 160     /**
 161     @param contex contains security and locale information relevant for the lifetime
 162     of this operation.
 163
 164     @param classReference
 165     @param handler
 166
 167     @exception NotSupported
 168     @exception InvalidParameter
 169     */
 170     virtual void deleteClass(
 171         const OperationContext & context,
 172         const CIMObjectPath & classReference,
 173         ResponseHandler & handler) = 0;
 174 };
 175
 176 PEGASUS_NAMESPACE_END
 177
 178 #endif
 179