version 1.35, 2002/08/27 23:38:44
|
version 1.35.2.1, 2002/10/28 15:43:21
|
|
|
#define Pegasus_Method_h | #define Pegasus_Method_h |
| |
#include <Pegasus/Common/Config.h> | #include <Pegasus/Common/Config.h> |
#include <Pegasus/Common/Linkage.h> |
|
#include <Pegasus/Common/String.h> | #include <Pegasus/Common/String.h> |
#include <Pegasus/Common/CIMName.h> |
|
#include <Pegasus/Common/CIMParameter.h> | #include <Pegasus/Common/CIMParameter.h> |
#include <Pegasus/Common/CIMQualifier.h> | #include <Pegasus/Common/CIMQualifier.h> |
#include <Pegasus/Common/CIMType.h> | #include <Pegasus/Common/CIMType.h> |
|
#include <Pegasus/Common/Linkage.h> |
| |
PEGASUS_NAMESPACE_BEGIN | PEGASUS_NAMESPACE_BEGIN |
| |
|
|
@param type CIM data type of method to create | @param type CIM data type of method to create |
@param classOrigin | @param classOrigin |
@param propagated | @param propagated |
|
@return Throws IllegalName if name argument not legal CIM identifier. |
*/ | */ |
CIMMethod( | CIMMethod( |
const CIMName& name, |
const String& name, |
CIMType type, | CIMType type, |
const CIMName& classOrigin = CIMName(), |
const String& classOrigin = String::EMPTY, |
Boolean propagated = false); | Boolean propagated = false); |
| |
/** Desctructor. */ | /** Desctructor. */ |
|
|
CIMMethod& operator=(const CIMMethod& x); | CIMMethod& operator=(const CIMMethod& x); |
| |
/** getName - Gets the name of the method | /** getName - Gets the name of the method |
@return CIMName with the name of the method |
@return String with the name of the method |
*/ | */ |
const CIMName& getName() const; |
const String& getName() const; |
| |
/** setName - Set the method name | /** setName - Set the method name |
@param name | @param name |
|
@exception IllegalName if name argument not legal CIM identifier. |
*/ | */ |
void setName(const CIMName& name); |
void setName(const String& name); |
| |
/** getType - gets the method type | /** getType - gets the method type |
@return The CIM method type for this method. | @return The CIM method type for this method. |
|
|
| |
/** getClassOrigin - Returns the class in which this method | /** getClassOrigin - Returns the class in which this method |
was defined. | was defined. |
@return CIMName containing the classOrigin field. |
@return String containing the classOrigin field. |
*/ | */ |
const CIMName& getClassOrigin() const; |
const String& getClassOrigin() const; |
| |
/** setClassOrigin - Set the ClassOrigin attribute with | /** setClassOrigin - Set the ClassOrigin attribute with |
the classname defined on input | the classname defined on input |
@param classOrigin - CIMName parameter defining the name |
@param classOrigin - String parameter defining the name |
of the class origin | of the class origin |
*/ | */ |
void setClassOrigin(const CIMName& classOrigin); |
void setClassOrigin(const String& classOrigin); |
| |
/** getPropagated - Tests the propagated qualifier |
/** getPropagated - Tests the propogated qualifier |
@return - returns True if method is propagated |
@return - returns True if method is propogated |
*/ | */ |
Boolean getPropagated() const; | Boolean getPropagated() const; |
| |
|
|
| |
/** addQualifier - Adds a Qualifier to the method object. | /** addQualifier - Adds a Qualifier to the method object. |
@param CIMQualifier to be added | @param CIMQualifier to be added |
@return This CIMMethod object |
@return Throws AlreadyExists excetpion if the qualifier already exists |
@exception AlreadyExistsException |
in the method |
|
@exception AlreadyExists exception |
*/ | */ |
CIMMethod& addQualifier(const CIMQualifier& x); | CIMMethod& addQualifier(const CIMQualifier& x); |
| |
/** findQualifier - returns the index of the qualifier with |
/** findQualifier - returns the position of the qualifier with |
the given name. | the given name. |
@param name Name of qualifier to be found. | @param name Name of qualifier to be found. |
@return index of the parameter if found; otherwise PEG_NOT_FOUND. | @return index of the parameter if found; otherwise PEG_NOT_FOUND. |
*/ | */ |
Uint32 findQualifier(const CIMName& name) const; |
Uint32 findQualifier(const String& name) const; |
| |
/** getQualifier - Gets the CIMQualifier defined by the index | /** getQualifier - Gets the CIMQualifier defined by the index |
input as a parameter. | input as a parameter. |
@param index Index of the qualifier requested. |
@param Index of the qualifier requested. |
@return CIMQualifier object or exception | @return CIMQualifier object or exception |
@exception IndexOutOfBoundsException exception if the index is |
@exception OutOfBounds exception if the index is outside the range of |
outside the range of parameters available from the CIMMethod. |
parameters available from the CIMMethod. |
*/ | */ |
CIMQualifier getQualifier(Uint32 index); |
CIMQualifier getQualifier(Uint32 pos); |
| |
CIMConstQualifier getQualifier(Uint32 index) const; |
CIMConstQualifier getQualifier(Uint32 pos) const; |
| |
/** removeQualifier - Remove the specified CIMQualifier from this method |
/** removeQualifier - Removes the CIMQualifier defined by the |
@param index Index of the qualifier to remove |
position input as a parameter. |
|
@param Position of the qualifier requested. |
@return CIMQualifier object or exception | @return CIMQualifier object or exception |
@exception IndexOutOfBoundsException exception if the index is |
@exception OutOfBounds exception if the index is outside the range of |
outside the range of parameters available from the CIMMethod. |
parameters available from the CIMMethod. |
*/ | */ |
void removeQualifier(Uint32 index); |
void removeQualifier(Uint32 pos); |
| |
/** getQualifierCount - Returns the number of Qualifiers attached | /** getQualifierCount - Returns the number of Qualifiers attached |
to this CIMMethod object. | to this CIMMethod object. |
|
|
@param name Name of parameter to be found. | @param name Name of parameter to be found. |
@return index of the parameter if found; otherwise PEG_NOT_FOUND. | @return index of the parameter if found; otherwise PEG_NOT_FOUND. |
*/ | */ |
Uint32 findParameter(const CIMName& name) const; |
Uint32 findParameter(const String& name) const; |
| |
/** getParameter - Gets the parameter defined by the index | /** getParameter - Gets the parameter defined by the index |
input as a parameter. | input as a parameter. |
@param index for the parameter to be returned. | @param index for the parameter to be returned. |
@return CIMParameter requested. | @return CIMParameter requested. |
@exception IndexOutOfBoundsException exception is thrown if the |
@Exception OutOfBounds exception is thrown if the index is outside the |
index is outside the range of available parameters |
range of available parameters |
*/ | */ |
CIMParameter getParameter(Uint32 index); |
CIMParameter getParameter(Uint32 pos); |
| |
/** getParameter - const form */ | /** getParameter - const form */ |
CIMConstParameter getParameter(Uint32 index) const; |
CIMConstParameter getParameter(Uint32 pos) const; |
|
|
/** removeParameter - Removes the CIMParameter defined by the |
|
specified index |
|
|
|
@param index index of the parameter to be removed |
|
|
|
@exception IndexOutOfBoundsException if the index is outside the |
|
range of parameters available from the CIMMethod |
|
*/ |
|
void removeParameter (Uint32 index); |
|
| |
/** getParameterCount - Gets the count of the numbeer of | /** getParameterCount - Gets the count of the numbeer of |
Parameters attached to the CIMMethod. | Parameters attached to the CIMMethod. |
|
|
*/ | */ |
Uint32 getParameterCount() const; | Uint32 getParameterCount() const; |
| |
/** |
#ifdef PEGASUS_INTERNALONLY |
Determines if the object has not been initialized. |
/** Returns true if CIMMethod refers to a null pointer */ |
|
Boolean isNull() const; |
@return True if the object has not been initialized, |
#endif |
False otherwise |
|
*/ |
|
Boolean isUninitialized() const; |
|
| |
/** identical - Returns true if this method is identical to the | /** identical - Returns true if this method is identical to the |
one given by the argument x. | one given by the argument x. |
|
|
| |
CIMConstMethod(const CIMMethod& x); | CIMConstMethod(const CIMMethod& x); |
| |
|
// Throws IllegalName if name argument not legal CIM identifier. |
CIMConstMethod( | CIMConstMethod( |
const CIMName& name, |
const String& name, |
CIMType type, | CIMType type, |
const CIMName& classOrigin = CIMName(), |
const String& classOrigin = String::EMPTY, |
Boolean propagated = false); | Boolean propagated = false); |
| |
~CIMConstMethod(); | ~CIMConstMethod(); |
|
|
| |
CIMConstMethod& operator=(const CIMMethod& x); | CIMConstMethod& operator=(const CIMMethod& x); |
| |
const CIMName& getName() const; |
const String& getName() const; |
| |
CIMType getType() const; | CIMType getType() const; |
| |
const CIMName& getClassOrigin() const; |
const String& getClassOrigin() const; |
| |
Boolean getPropagated() const; | Boolean getPropagated() const; |
| |
Uint32 findQualifier(const CIMName& name) const; |
Uint32 findQualifier(const String& name) const; |
| |
CIMConstQualifier getQualifier(Uint32 index) const; |
CIMConstQualifier getQualifier(Uint32 pos) const; |
| |
Uint32 getQualifierCount() const; | Uint32 getQualifierCount() const; |
| |
Uint32 findParameter(const CIMName& name) const; |
Uint32 findParameter(const String& name) const; |
| |
CIMConstParameter getParameter(Uint32 index) const; |
CIMConstParameter getParameter(Uint32 pos) const; |
| |
Uint32 getParameterCount() const; | Uint32 getParameterCount() const; |
| |
Boolean isUninitialized() const; |
#ifdef PEGASUS_INTERNALONLY |
|
Boolean isNull() const; |
|
#endif |
| |
Boolean identical(const CIMConstMethod& x) const; | Boolean identical(const CIMConstMethod& x) const; |
| |