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

  1 karl  1.5 //%2006////////////////////////////////////////////////////////////////////////
  2 schuur 1.1 //
  3 karl   1.2 // 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 schuur 1.1 // IBM Corp.; EMC Corporation, The Open Group.
  7 karl   1.2 // Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
  8            // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
  9 karl   1.4 // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
 10            // EMC Corporation; VERITAS Software Corporation; The Open Group.
 11 karl   1.5 // Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
 12            // EMC Corporation; Symantec Corporation; The Open Group.
 13 schuur 1.1 //
 14            // Permission is hereby granted, free of charge, to any person obtaining a copy
 15            // of this software and associated documentation files (the "Software"), to
 16            // deal in the Software without restriction, including without limitation the
 17            // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 18            // sell copies of the Software, and to permit persons to whom the Software is
 19            // furnished to do so, subject to the following conditions:
 20 karl   1.2 // 
 21 schuur 1.1 // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
 22            // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
 23            // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
 24            // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 25            // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 26            // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 27            // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 28            // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 29            //
 30            //==============================================================================
 31            //
 32            //%/////////////////////////////////////////////////////////////////////////////
 33            
 34            #ifndef Pegasus_CIMInstanceQueryProvider_h
 35            #define Pegasus_CIMInstanceQueryProvider_h
 36            
 37            #include "CIMInstanceProvider.h"
 38 chuck  1.3 #include <Pegasus/Query/QueryExpression/QueryExpression.h>
 39 schuur 1.1 
 40            PEGASUS_NAMESPACE_BEGIN
 41            
 42 kumpf  1.6 /**
 43                This class extends then CIMInstanceProvider class enabling query support.
 44 schuur 1.1 
 45 kumpf  1.6     <p>In addition to
 46                functions inherited from the
 47                {@link CIMInstanceProvider CIMInstanceProvider} interface,
 48                the functions in the Instance Query Provider interface are:</p>
 49            
 50                <p><ul>
 51                <li>{@link execQuery execQuery}</li>
 52                </ul></p>
 53            
 54                <p>The Instance Query Provider receives operation requests from
 55                clients through calls to these functions by the CIM Server. Its
 56                purpose is to convert these to calls to system services,
 57                operations on system resources, or whatever platform-specific
 58                behavior is required to perform the operation modeled by
 59                the request. The specific requirements for each of the interface
 60                functions are discussed in their respective sections.</p>
 61 schuur 1.1 */
 62            
 63 kumpf  1.6 class PEGASUS_PROVIDER_LINKAGE CIMInstanceQueryProvider :
 64                public CIMInstanceProvider
 65 schuur 1.1 {
 66            public:
 67                /**
 68 kumpf  1.6         Constructor.
 69                    The constructor should not do anything.
 70 schuur 1.1     */
 71 kumpf  1.6     CIMInstanceQueryProvider();
 72 schuur 1.1 
 73                /**
 74 kumpf  1.6         Destructor.
 75                    The destructor should not do anything.
 76 schuur 1.1     */
 77 kumpf  1.6     virtual ~CIMInstanceQueryProvider();
 78 schuur 1.1 
 79                /**
 80 kumpf  1.6         \Label{execQuery}
 81                    Return all instances of the specified class filtered by the query.
 82 schuur 1.1 
 83 kumpf  1.6         @param context contains security and locale information relevant
 84                    for the lifetime of this operation.
 85                    @param objectPath contains namespace and classname for which the
 86                    query is to be performed.
 87                    @param query enables access to query details like query statement
 88                    and language.
 89                    @param handler asynchronusly processes the results of this operation.
 90            
 91                    @exception CIMNotSupportedException
 92                    @exception CIMAccessDeniedException
 93                    @exception CIMOperationFailedException
 94 schuur 1.1     */
 95                virtual void execQuery(
 96 kumpf  1.6        const OperationContext& context,
 97                   const CIMObjectPath& objectPath,
 98                   const QueryExpression& query,
 99                   InstanceResponseHandler& handler) = 0;
100 schuur 1.1 };
101            
102            PEGASUS_NAMESPACE_END
103            
104            #endif

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2