pegasus/src/Pegasus/Common/CIMMethod.h - diff

Return to CIMMethod.h CVS log

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

Diff for /pegasus/src/Pegasus/Common/CIMMethod.h between version 1.35 and 1.37

version 1.35, 2002/08/27 23:38:44

version 1.37, 2003/10/22 14:26:02

Line 1

//%/////////////////////////////////////////////////////////////////////////////

//%2003////////////////////////////////////////////////////////////////////////

// The Open Group, Tivoli Systems

// Company, L. P., IBM Corp., The Open Group, Tivoli Systems.

// 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

Line 46

Line 48

class CIMConstMethod;

class CIMMethodRep;

// ATTN: remove the classOrigin and propagated parameters.

/** The CIMMethod class is used to represent CIM methods in Pegasus.

/** 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.

class PEGASUS_COMMON_LINKAGE CIMMethod

{

public:

/** Creates and instantiates a CIM method. */

/** Creates a new CIMMethod object. */

CIMMethod();

/** Creates and instantiates a CIM method from another method instance

/** Creates a new CIMMethod object from another method instance.

@return pointer to the new method instance

@param x - CIMMethod instance from which to create CIMMethod object.

CIMMethod(const CIMMethod& x);

/** Creates a CIM method with the specified name, type, and classOrigin

/** Creates a CIMMethod with the specified name, type, and classOrigin.

@param name for the method

@param name - CIMName representing the name for the method.

@param type CIM data type of method to create

@param type - CIMType representing data type of method to create.

@param classOrigin

@param classOrigin - CIMName representing the class origin.

@param propagated

@param propagated - Flag indicating whether the definition of the

CIM Method is local to the CIM Class (respectively, Instance) in which

it appears, or was propagated without modification from the underlying

Subclass (respectively, Class).

CIMMethod(

const CIMName& name,

Line 82

Line 83

/** Assignment operator */

CIMMethod& operator=(const CIMMethod& x);

/** getName - Gets the name of the method

/** Gets the name of the method.

@return CIMName with the name of the method

@return CIMName with the name of the method.

const CIMName& getName() const;

/** setName - Set the method name

/** Sets the method name.

@param name

@param name - CIMName with method name.

void setName(const CIMName& name);

/** getType - gets the method type

/** Gets the method type.

@return The CIM method type for this method.

@return The CIMType containing the method type for this method.

CIMType getType() const;

/** setType - Sets the method type to the specified CIM method

/** Sets the method type to the specified CIM method type

type as defined in CIMType /Ref{TYPE}

as defined in CIMType.

void setType(CIMType type);

/** getClassOrigin - Returns the class in which this method

/** Gets the class in which this method was defined.

was defined.

@return CIMName containing the classOrigin field.

const CIMName& getClassOrigin() const;

/** setClassOrigin - Set the ClassOrigin attribute with

/** Sets the ClassOrigin attribute with the classname defined on

the classname defined on input

the input parameter.

@param classOrigin - CIMName parameter defining the name

of the class origin

of the class origin.

void setClassOrigin(const CIMName& classOrigin);

/** getPropagated - Tests the propagated qualifier

/** Tests the propagated qualifier.

@return - returns True if method is propagated

@return true if method is propagated, false otherwise.

Boolean getPropagated() const;

/** setPropagated - Sets the Propagaged Qualifier */

/** Sets the Propagaged Qualifier

@param propagated - Flag indicating propagation.

void setPropagated(Boolean propagated);

/** addQualifier - Adds a Qualifier to the method object.

/** Adds the specified qualifier to the method and increments the

@param CIMQualifier to be added

qualifier count.

@return This CIMMethod object

@param x - CIMQualifier object representing the qualifier

@exception AlreadyExistsException

to be added.

@return the CIMMethod object after adding the specified qualifier.

@exception AlreadyExistsException if the qualifier already exists.

CIMMethod& addQualifier(const CIMQualifier& x);

/** findQualifier - returns the index of the qualifier with

/** Searches for a qualifier with the specified input name.

the given name.

@param name - CIMName of the qualifier to be found.

@param name Name of qualifier to be found.

@return Index of the qualifier found or PEG_NOT_FOUND

@return index of the parameter if found; otherwise PEG_NOT_FOUND.

if not found.

Uint32 findQualifier(const CIMName& name) const;

/** getQualifier - Gets the CIMQualifier defined by the index

/** Gets the CIMQualifier defined by the input parameter.

input as a parameter.

@param index - Index of the qualifier requested.

@param index Index of the qualifier requested.

@return CIMQualifier object representing the qualifier found.

@return CIMQualifier object or exception

@exception IndexOutOfBoundsException exception if the index is

outside the range of parameters available from the CIMMethod.

CIMQualifier getQualifier(Uint32 index);

/** Gets the CIMQualifier defined by the input parameter.

@param index - Index of the qualifier requested.

@return CIMConstQualifier object representing the qualifier found.

@exception IndexOutOfBoundsException exception if the index is

outside the range of parameters available from the CIMMethod.

CIMConstQualifier getQualifier(Uint32 index) const;

/** removeQualifier - Remove the specified CIMQualifier from this method

/** Removes the specified CIMQualifier from this method.

@param index Index of the qualifier to remove

@param index - Index of the qualifier to remove.

@return CIMQualifier object or exception

@exception IndexOutOfBoundsException exception if the index is

outside the range of parameters available from the CIMMethod.

void removeQualifier(Uint32 index);

/** getQualifierCount - Returns the number of Qualifiers attached

/** Returns the number of Qualifiers attached to this CIMMethod object.

to this CIMMethod object.

@return the number of qualifiers in the CIM Method.

@return integer representing number of Qualifiers.

Uint32 getQualifierCount() const;

/** addParameter - Adds the parameter defined by the input

/** Adds the parameter defined by the input to the CIMMethod.

to the CIMMethod

@param x - CIMParameter to be added to the CIM Method.

@return CIMMethod object after the specified parameter is added.

CIMMethod& addParameter(const CIMParameter& x);

/** findParameter - Finds the parameter whose name is given

/** Finds the parameter with the specified name.

by the name parameter.

@param name - Name of parameter to be found.

@param name Name of parameter to be found.

@return Index of the parameter object found or PEG_NOT_FOUND

@return index of the parameter if found; otherwise PEG_NOT_FOUND.

if the property is not found.

Uint32 findParameter(const CIMName& name) const;

/** getParameter - Gets the parameter defined by the index

/** Gets the parameter defined by the specified index.

input as a parameter.

@param index - Index for the parameter to be returned.

@param index for the parameter to be returned.

@return CIMParameter object requested.

@return CIMParameter requested.

@exception IndexOutOfBoundsException if the index is outside

@exception IndexOutOfBoundsException exception is thrown if the

the range of available parameters

index is outside the range of available parameters

CIMParameter getParameter(Uint32 index);

/** getParameter - const form */

/** Gets the parameter defined for the specified index.

@param index - Index for the parameter to be returned.

@return CIMConstParameter object requested.

@exception IndexOutOfBoundsException if the index is outside

the range of available parameters

CIMConstParameter getParameter(Uint32 index) const;

/** removeParameter - Removes the CIMParameter defined by the

/** Removes the CIMParameter defined by the specified index.

specified index

@param index - Index of the parameter to be removed.

@param index index of the parameter to be removed

@exception IndexOutOfBoundsException if the index is outside the

range of parameters available from the CIMMethod

range of parameters available from the CIMMethod.

void removeParameter (Uint32 index);

/** getParameterCount - Gets the count of the numbeer of

/** Gets the count of Parameters defined in the CIMMethod.

Parameters attached to the CIMMethod.

@return - count of the number of parameters attached to the CIMMethod.

@retrun - count of the number of parameters attached to the CIMMethod.

Uint32 getParameterCount() const;

/**

/** Determines if the object has not been initialized.

Determines if the object has not been initialized.

@return true if the object has not been initialized,

false otherwise

@return True if the object has not been initialized,

False otherwise

Boolean isUninitialized() const;

/** identical - Returns true if this method is identical to the

/** Compares with another CIMConstMethod.

one given by the argument x.

@param x - CIMConstMethod object for the method to be compared.

@return true if this method is identical to the one specified.

Boolean identical(const CIMConstMethod& x) const;

/** CIMMethod clone - makes a distinct replica of this method */

/** Makes a deep copy (clone) of this method.

@return copy of the CIMMethod object.

CIMMethod clone() const;

private:

Line 233

Line 242

friend class MofWriter;

};

///

class PEGASUS_COMMON_LINKAGE CIMConstMethod

{

public:

///

CIMConstMethod();

///

CIMConstMethod(const CIMConstMethod& x);

///

CIMConstMethod(const CIMMethod& x);

///

CIMConstMethod(

const CIMName& name,

CIMType type,

const CIMName& classOrigin = CIMName(),

Boolean propagated = false);

///

~CIMConstMethod();

///

CIMConstMethod& operator=(const CIMConstMethod& x);

///

CIMConstMethod& operator=(const CIMMethod& x);

///

const CIMName& getName() const;

///

CIMType getType() const;

///

const CIMName& getClassOrigin() const;

///

Boolean getPropagated() const;

///

Uint32 findQualifier(const CIMName& name) const;

///

CIMConstQualifier getQualifier(Uint32 index) const;

///

Uint32 getQualifierCount() const;

///

Uint32 findParameter(const CIMName& name) const;

///

CIMConstParameter getParameter(Uint32 index) const;

///

Uint32 getParameterCount() const;

///

Boolean isUninitialized() const;

///

Boolean identical(const CIMConstMethod& x) const;

///

CIMMethod clone() const;

private:

Legend:

Removed from v.1.35
changed lines
	Added in v.1.37

No CVS admin address has been configured