//%/////////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2000, 2001 The Open group, BMC Software, Tivoli Systems, IBM
//
// 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: Mike Brasher (mbrasher@bmc.com)
//
// Modified By: Roger Kumpf, Hewlett-Packard Company (roger_kumpf@hp.com)
//
//%/////////////////////////////////////////////////////////////////////////////

#ifndef Pegasus_Method_h
#define Pegasus_Method_h

#include <Pegasus/Common/Config.h>
#include <Pegasus/Common/String.h>
#include <Pegasus/Common/CIMParameter.h>
#include <Pegasus/Common/CIMQualifier.h>
#include <Pegasus/Common/CIMType.h>

PEGASUS_NAMESPACE_BEGIN

class DeclContext;
class CIMConstMethod;
class CIMMethodRep;

/** Class CIMMethod - This class defines the operations associated with
    manipulation of the Pegasus implementation of the CIM CIMMethod. Within
    this class, methods are provides for creation, deletion, and manipulation
    of method declarations.

    // ATTN: remove the classOrigin and propagated parameters.
*/
class PEGASUS_COMMON_LINKAGE CIMMethod
{
public:

    /** Creates and instantiates a CIM method. */
    CIMMethod();

    /** Creates and instantiates a CIM method from another method instance
	@return pointer to the new method instance
    */
    CIMMethod(const CIMMethod& x);

    /**	Creates a CIM method with the specified name, type, and classOrigin
	@param name for the method
	@param type ATTN
	@param classOrigin
	@param propagated
	@return  Throws IllegalName if name argument not legal CIM identifier.
    */
    CIMMethod(
	const String& name,
	CIMType type,
	const String& classOrigin = String::EMPTY,
	Boolean propagated = false);

    /** Desctructor. */
    ~CIMMethod();

    /** Assignment operator */
    CIMMethod& operator=(const CIMMethod& x);

    /** getName - Gets the name of the method
	@return String with the name of the method
    */
    const String& getName() const;

    /** setName - Set the method name
	@param name
	@exception IllegalName if name argument not legal CIM identifier.
    */
    void setName(const String& name);

    /** getType - gets the method type
	@return The CIM method type for this method.
    */
    CIMType getType() const;

    /** setType - Sets the method type to the specified CIM method
	type as defined in CIMType /Ref{TYPE}
    */
    void setType(CIMType type);

    /** getClassOrigin - Returns the class in which this method
	was defined.
	@return String containing the classOrigin field. 
    */
    const String& getClassOrigin() const;

    /** setClassOrigin - Set the ClassOrigin attribute with
	the classname defined on input
	@param classOrigin - String parameter defining the name
	of the class origin
    */
    void setClassOrigin(const String& classOrigin);

    /** getPropagated - Tests the propogated qualifier
        @return - returns True if method is propogated
    */
    Boolean getPropagated() const;

    /** setPropagated - Sets the Propagaged Qualifier */
    void setPropagated(Boolean propagated);

    /** addQualifier - Adds a Qualifier to the method object.
	@param CIMQualifier to be added
	@return Throws AlreadyExists excetpion if the qualifier already exists
	in the method
	@exception AlreadyExists exception
    */
    CIMMethod& addQualifier(const CIMQualifier& x);

    /** findQualifier - returns the position of the qualifier with
	the given name.
	@param name Name of qualifier to be found.
	@return index of the parameter if found; otherwise PEG_NOT_FOUND.
    */
    Uint32 findQualifier(const String& name) const;

    /** existsQualifier - returns the position of the qualifier with
	the given name.
	@param name Name of qualifier to be found.
	@return index of the parameter if found; otherwise PEG_NOT_FOUND.
    */
    Boolean existsQualifier(const String& name) const;

    /** getQualifier - Gets the CIMQualifier defined by the index
	input as a parameter.
	@param Index of the qualifier requested.
	@return CIMQualifier object or exception
	@exception OutOfBounds exception if the index is outside the range of
	parameters available from the CIMMethod.
    */
    CIMQualifier getQualifier(Uint32 pos);

    CIMConstQualifier getQualifier(Uint32 pos) const;

    /** removeQualifier - Removes the CIMQualifier defined by the
	position input as a parameter.
	@param Position of the qualifier requested.
	@return CIMQualifier object or exception
	@exception OutOfBounds exception if the index is outside the range of
	parameters available from the CIMMethod.
    */
    void removeQualifier(Uint32 pos);

    /** getQualifierCount - Returns the number of Qualifiers attached
	to this CIMMethod object.
	@return integer representing number of Qualifiers.
    */
    Uint32 getQualifierCount() const;

    /** addParameter - Adds the parameter defined by the input
	to the CIMMethod
    */
    CIMMethod& addParameter(const CIMParameter& x);

    /** findParameter - Finds the parameter whose name is given
	by the name parameter.
	@param name Name of parameter to be found.
	@return index of the parameter if found; otherwise PEG_NOT_FOUND.
    */
    Uint32 findParameter(const String& name) const;

    /** getParameter - ATTN: */
    CIMParameter getParameter(Uint32 pos);

    /** getParameter - Gets the parameter defined by the index
	input as a parameter.
	@param index for the parameter to be returned.
	@return CIMParameter requested.
	@Exception OutOfBounds exception is thrown if the index is outside the
	range of available parameters
    */
    CIMConstParameter getParameter(Uint32 pos) const;

    /** getParameterCount - Gets the count of the numbeer of
	Parameters attached to the CIMMethod.
	@retrun - count of the number of parameters attached to the CIMMethod.
    */
    Uint32 getParameterCount() const;

#ifdef PEGASUS_INTERNALONLY
    /** resolve - resolves and completes the CIMMethod */
    void resolve(
	DeclContext* declContext,
	const String& nameSpace,
	const CIMConstMethod& method);

    /** resolve - Resolves and completes the CIMMethod */
    void resolve(
	DeclContext* declContext,
	const String& nameSpace);

    /** Returns zero if CIMMethod refers to a null pointer */
    operator int() const;
#endif

    /** toXML - puts XML encoding of this CIMMethod object into out 
	argument. 
    */
    void toXml(Array<Sint8>& out) const;

    /** print - formats and prints this CIMmethod (in CIM XML encoded form). 
    */
    void print(PEGASUS_STD(ostream)& o=PEGASUS_STD(cout)) const;

    /** toMof - puts MOF encoding of this object into out arguemnt. 
    */ 
    void toMof(Array<Sint8>& out) const;

    /** identical - Returns true if this method is identical to the
	one given by the argument x.
    */
    Boolean identical(const CIMConstMethod& x) const;

    /** CIMMethod clone - makes a distinct replica of this method */
    CIMMethod clone() const;

private:

    CIMMethod(CIMMethodRep* rep);

    PEGASUS_EXPLICIT CIMMethod(const CIMConstMethod& x);

    void _checkRep() const;

    CIMMethodRep* _rep;
    friend class CIMConstMethod;
};

class PEGASUS_COMMON_LINKAGE CIMConstMethod
{
public:

    CIMConstMethod();

    CIMConstMethod(const CIMConstMethod& x);

    CIMConstMethod(const CIMMethod& x);

    // Throws IllegalName if name argument not legal CIM identifier.
    CIMConstMethod(
	const String& name,
	CIMType type,
	const String& classOrigin = String::EMPTY,
	Boolean propagated = false);

    ~CIMConstMethod();

    CIMConstMethod& operator=(const CIMConstMethod& x);

    CIMConstMethod& operator=(const CIMMethod& x);

    const String& getName() const;

    CIMType getType() const;

    const String& getClassOrigin() const;

    Boolean getPropagated() const;

    Uint32 findQualifier(const String& name) const;

    Uint32 getQualifier(Uint32 pos) const;

    Uint32 getQualifierCount() const;

    Uint32 findParameter(const String& name) const;

    CIMConstParameter getParameter(Uint32 pos) const;

    Uint32 getParameterCount() const;

#ifdef PEGASUS_INTERNALONLY
    operator int() const;

    void toXml(Array<Sint8>& out) const;

    void print(PEGASUS_STD(ostream)& o=PEGASUS_STD(cout)) const;
#endif

    Boolean identical(const CIMConstMethod& x) const;

    CIMMethod clone() const;

private:

    void _checkRep() const;

    CIMMethodRep* _rep;

    friend class CIMMethod;
    friend class CIMMethodRep;
};

#define PEGASUS_ARRAY_T CIMMethod
# include "ArrayInter.h"
#undef PEGASUS_ARRAY_T

PEGASUS_NAMESPACE_END

#endif /* Pegasus_Method_h */