Return to CIMClassProvider.h CVS log

Up to [Pegasus] / pegasus / src / Pegasus / Provider

PEP 55 Update license on source files to current license text and date

//%2003////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2000, 2001, 2002  BMC Software, Hewlett-Packard Development
// Company, L. P., IBM Corp., The Open Group, Tivoli Systems.
// Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L. P.;
// IBM Corp.; EMC Corporation, The Open Group.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
//==============================================================================
//
// Author: Chip Vincent (cvincent@us.ibm.com)
//
// Modified By:
//
//%/////////////////////////////////////////////////////////////////////////////

#ifndef Pegasus_CIMClassProvider_h
#define Pegasus_CIMClassProvider_h

#include <Pegasus/Common/Config.h>
#include <Pegasus/Provider/CIMProvider.h>

#include <Pegasus/Common/Array.h>
#include <Pegasus/Common/CIMPropertyList.h>
#include <Pegasus/Common/CIMObjectPath.h>
#include <Pegasus/Common/CIMClass.h>
#include <Pegasus/Provider/Linkage.h>

PEGASUS_NAMESPACE_BEGIN

/**
This class defines the set of methods implemented by an class provider. A providers that derives
from this class must implement all methods. The minimal method implementation simply throw the
NotSupported exception.
*/
    class PEGASUS_PROVIDER_LINKAGE CIMClassProvider : public virtual CIMProvider
{
public:
    CIMClassProvider(void);
    virtual ~CIMClassProvider(void);

    /**

    @param contex contains security and locale information relevant for the lifetime
    of this operation.

    @param classReference
    @param localOnly
    @param includeQualifiers
    @param includeClassOrigin
    @param propertyList

    @param handler asynchronusly processes the results of this operation.

    @exception NotSupported
    @exception InvalidParameter
    */
    virtual void getClass(
        const OperationContext & context,
        const CIMObjectPath & classReference,
        const Boolean localOnly,
        const Boolean includeQualifiers,
        const Boolean includeClassOrigin,
        const CIMPropertyList & propertyList,
        ClassResponseHandler & handler) = 0;

    /**
    @param contex contains security and locale information relevant for the lifetime
    of this operation.

    @param classReference
    @param deepInheritance
    @param localOnly
    @param includeQualifiers
    @param includeClassOrigin

    @param handler asynchronusly processes the results of this operation.

    @exception NotSupported
    @exception InvalidParameter
    */
    virtual void enumerateClasses(
        const OperationContext & context,
        const CIMObjectPath & classReference,
        const Boolean deepInheritance,
        const Boolean localOnly,
        const Boolean includeQualifiers,
        const Boolean includeClassOrigin,
        ClassResponseHandler & handler) = 0;

    /**
    @param contex contains security and locale information relevant for the lifetime
    of this operation.

    @param classReference
    @param deepInheritance

    @param handler asynchronusly processes the results of this operation.

    @exception NotSupported
    @exception InvalidParameter
    */
    virtual void enumerateClassNames(
        const OperationContext & context,
        const CIMObjectPath & classReference,
        const Boolean deepInheritance,
        ObjectPathResponseHandler & handler) = 0;

    /**
    @param contex contains security and locale information relevant for the lifetime
    of this operation.

    @param classReference
    @param classObject

    @param handler asynchronusly processes the results of this operation.

    @exception NotSupported
    @exception InvalidParameter
    */
    virtual void modifyClass(
        const OperationContext & context,
        const CIMObjectPath & classReference,
        const CIMClass & classObject,
        ResponseHandler & handler) = 0;

    /**
    @param contex contains security and locale information relevant for the lifetime
    of this operation.

    @param classReference
    @param classObject

    @param handler asynchronusly processes the results of this operation.

    @exception NotSupported
    @exception InvalidParameter
    */
    virtual void createClass(
        const OperationContext & context,
        const CIMObjectPath & classReference,
        const CIMClass & classObject,
        ResponseHandler & handler) = 0;

    /**
    @param contex contains security and locale information relevant for the lifetime
    of this operation.

    @param classReference
    @param handler

    @exception NotSupported
    @exception InvalidParameter
    */
    virtual void deleteClass(
        const OperationContext & context,
        const CIMObjectPath & classReference,
        ResponseHandler & handler) = 0;
};

PEGASUS_NAMESPACE_END

#endif