version 1.30, 2002/07/30 16:14:53
|
version 1.52, 2006/11/10 18:14:57
|
|
|
//%///////////////////////////////////////////////////////////////////////////// |
//%2006//////////////////////////////////////////////////////////////////////// |
// | // |
// Copyright (c) 2000, 2001, 2002 BMC Software, Hewlett-Packard Company, IBM, |
// Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development |
// The Open Group, Tivoli Systems |
// 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. |
|
// Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.; |
|
// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group. |
|
// Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
|
// EMC Corporation; VERITAS Software Corporation; The Open Group. |
|
// Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
|
// EMC Corporation; Symantec Corporation; The Open Group. |
// | // |
// Permission is hereby granted, free of charge, to any person obtaining a copy | // Permission is hereby granted, free of charge, to any person obtaining a copy |
// of this software and associated documentation files (the "Software"), to | // of this software and associated documentation files (the "Software"), to |
|
|
// | // |
//============================================================================== | //============================================================================== |
// | // |
// Author: Mike Brasher (mbrasher@bmc.com) |
|
// |
|
// Modified By: Roger Kumpf, Hewlett-Packard Company (roger_kumpf@hp.com) |
|
// Carol Ann Krug Graves, Hewlett-Packard Company |
|
// (carolann_graves@hp.com) |
|
// |
|
//%///////////////////////////////////////////////////////////////////////////// | //%///////////////////////////////////////////////////////////////////////////// |
| |
#ifndef Pegasus_Method_h | #ifndef Pegasus_Method_h |
|
|
class CIMConstMethod; | class CIMConstMethod; |
class CIMMethodRep; | class CIMMethodRep; |
| |
// ATTN: remove the classOrigin and propagated parameters. |
/** |
/** Class CIMMethod - This class defines the operations associated with |
The CIMMethod class represents the DMTF standard CIM method definition. |
manipulation of the Pegasus implementation of the CIM CIMMethod. Within |
A CIMMethod is generally defined in the context of a CIMClass. |
this class, methods are provides for creation, deletion, and manipulation |
A CIMMethod consists of: |
of method declarations. |
<ul> |
|
<li>A CIMName containing the name of the method |
|
<li>A CIMType defining the method return type |
|
<li>Zero or more CIMQualifier objects |
|
<li>Zero or more CIMParameter objects defining the method parameters |
|
</ul> |
|
In addition, a CIMMethod has these internal attributes: |
|
<ul> |
|
<li><b>propagated</b> - An attribute defining whether this CIMMethod |
|
is propagated from a superclass. Note that this is normally set |
|
as part of completing the definition of objects (resolving) when |
|
they are created as part of a CIM schema and is NOT automatically |
|
set when creating a method object. It can only be logically set |
|
in context of the schema in which the CIMMethod is defined. |
|
<li><b>classOrigin</b> - An attribute defining the class in which |
|
this CIMMethod was originally defined. This is normally set |
|
within the context of the schema in which the CIMMethod is |
|
defined. This attribute is available from objects retrieved |
|
from the CIM Server, for example, and provides information on |
|
the defintion of this method in the class hierarchy. The |
|
propagated and ClassOrigin attributes can be used together to |
|
determine if methods originated with this object or were |
|
inherited from higher levels of the hiearchy. |
|
</ul> |
|
|
|
<p>The CIMMethod class uses a shared representation model, such that |
|
multiple CIMMethod objects may refer to the same data copy. Assignment |
|
and copy operators create new references to the same data, not distinct |
|
copies. An update to a CIMMethod object affects all the CIMMethod |
|
objects that refer to the same data copy. The data remains valid until |
|
all the CIMMethod objects that refer to it are destructed. A separate |
|
copy of the data may be created using the clone method. |
*/ | */ |
class PEGASUS_COMMON_LINKAGE CIMMethod | class PEGASUS_COMMON_LINKAGE CIMMethod |
{ | { |
public: | public: |
| |
/** Creates and instantiates a CIM method. */ |
/** |
|
Constructs an uninitialized CIMMethod object. A method |
|
invocation on an uninitialized object will result in the throwing |
|
of an UninitializedObjectException. An uninitialized object may |
|
be converted into an initialized object only by using the assignment |
|
operator with an initialized object. |
|
*/ |
CIMMethod(); | CIMMethod(); |
| |
/** Creates and instantiates a CIM method from another method instance |
/** |
@return pointer to the new method instance |
Constructs a CIMMethod object from the value of a specified |
|
CIMMethod object, so that both objects refer to the same data copy. |
|
|
|
<p><b>Example:</b> |
|
<pre> |
|
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
const CIMMethod cm1(m1); |
|
</pre> |
|
|
|
@param x The CIMMethod object from which to construct a new |
|
CIMMethod object. |
*/ | */ |
CIMMethod(const CIMMethod& x); | CIMMethod(const CIMMethod& x); |
| |
/** Creates a CIM method with the specified name, type, and classOrigin |
/** |
@param name for the method |
Constructs a CIMMethod object with the specified attributes. |
@param type CIM data type of method to create |
<p><b>Example:</b> |
@param classOrigin |
<pre> |
@param propagated |
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
@return Throws IllegalName if name argument not legal CIM identifier. |
</pre> |
|
|
|
@param name A CIMName specifying the name of the method. |
|
@param type A CIMType defining the method return type. |
|
@param classOrigin A CIMName indicating the class in which the |
|
method is locally defined (optional). |
|
@param propagated A Boolean indicating whether the method definition |
|
is local to the CIMClass in which it appears or was propagated |
|
(without modification) from a superclass. |
|
@exception UninitializedObjectException If the method name is null. |
*/ | */ |
CIMMethod( | CIMMethod( |
const CIMName& name, | const CIMName& name, |
|
|
const CIMName& classOrigin = CIMName(), | const CIMName& classOrigin = CIMName(), |
Boolean propagated = false); | Boolean propagated = false); |
| |
/** Desctructor. */ |
/** |
|
Destructs the CIMMethod object. |
|
*/ |
~CIMMethod(); | ~CIMMethod(); |
| |
/** Assignment operator */ |
/** |
|
Assigns the value of the specified CIMMethod object to this object, |
|
so that both objects refer to the same data copy. |
|
|
|
<p><b>Example:</b> |
|
<pre> |
|
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
CIMMethod m2; |
|
m2 = m1; |
|
</pre> |
|
|
|
@param x The CIMMethod object from which to assign this CIMMethod |
|
object. |
|
@return A reference to this CIMMethod object. |
|
*/ |
CIMMethod& operator=(const CIMMethod& x); | CIMMethod& operator=(const CIMMethod& x); |
| |
/** getName - Gets the name of the method |
/** |
@return CIMName with the name of the method |
Gets the name of the method. |
|
<p><b>Example:</b> |
|
<pre> |
|
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
assert(m1.getName() == CIMName ("getHostName")); |
|
</pre> |
|
@return A CIMName containing the name of the method. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
*/ | */ |
const CIMName& getName() const; | const CIMName& getName() const; |
| |
/** setName - Set the method name |
/** |
@param name |
Sets the method name. |
@exception IllegalName if name argument not legal CIM identifier. |
<p><b>Example:</b> |
|
<pre> |
|
CIMMethod m2(CIMName ("test"), CIMTYPE_STRING); |
|
m2.setName(CIMName ("getVersion")); |
|
</pre> |
|
@return A CIMName containing the new name of the method. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
*/ | */ |
void setName(const CIMName& name); | void setName(const CIMName& name); |
| |
/** getType - gets the method type |
/** |
@return The CIM method type for this method. |
Gets the method return type. |
|
<p><b>Example:</b> |
|
<pre> |
|
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
assert(m1.getType() == CIMTYPE_STRING); |
|
</pre> |
|
@return A CIMType containing the method return type. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
*/ | */ |
CIMType getType() const; | CIMType getType() const; |
| |
/** setType - Sets the method type to the specified CIM method |
/** |
type as defined in CIMType /Ref{TYPE} |
Sets the method return type to the specified CIMType. |
|
This is the type of the CIMValue |
|
that is returned on a CIM method invocation. |
|
<p><b>Example:</b> |
|
<pre> |
|
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
m1.setName(CIMName ("getVersion")); |
|
assert(m1.getName() == CIMName ("getVersion")); |
|
</pre> |
|
@param type CIMType to be set into the CIMMethod object. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
*/ | */ |
void setType(CIMType type); | void setType(CIMType type); |
| |
/** getClassOrigin - Returns the class in which this method |
/** |
was defined. |
Gets the class in which this method is locally defined. This |
@return CIMName containing the classOrigin field. |
information is normally available with methods that are part of |
|
schema returned from a CIM Server. |
|
@return CIMName containing the classOrigin attribute. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
*/ | */ |
const CIMName& getClassOrigin() const; | const CIMName& getClassOrigin() const; |
| |
/** setClassOrigin - Set the ClassOrigin attribute with |
/** |
the classname defined on input |
Sets the classOrigin attribute with the specified class name. |
@param classOrigin - CIMName parameter defining the name |
Normally this method is used internally by a CIM Server when |
of the class origin |
defining methods in the context of a schema. |
|
@param classOrigin A CIMName specifying the name of the class of |
|
origin for the method. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
*/ | */ |
void setClassOrigin(const CIMName& classOrigin); | void setClassOrigin(const CIMName& classOrigin); |
| |
/** getPropagated - Tests the propogated qualifier |
/** |
@return - returns True if method is propogated |
Tests the propagated attribute of the object. The propagated |
|
attribute indicates whether this method was propagated from a |
|
higher-level class. Normally this attribute is set as part of |
|
defining a method in the context of a schema. It is set in |
|
methods retrieved from a CIM Server. |
|
@return True if method is propagated; otherwise, false. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
*/ | */ |
Boolean getPropagated() const; | Boolean getPropagated() const; |
| |
/** setPropagated - Sets the Propagaged Qualifier */ |
/** |
|
Sets the propagated attribute. Normally this is used by a CIM Server |
|
when defining a method in the context of a schema. |
|
@param propagated A Boolean indicating whether the method is |
|
propagated from a superclass. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
void setPropagated(Boolean propagated); | void setPropagated(Boolean propagated); |
| |
/** addQualifier - Adds a Qualifier to the method object. |
/** |
@param CIMQualifier to be added |
Adds a qualifier to the method. |
@return Throws AlreadyExists excetpion if the qualifier already exists |
<p><b>Example:</b> |
in the method |
<pre> |
@exception AlreadyExists exception |
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
m1.addQualifier(CIMQualifier(CIMName ("stuff"), true)); |
|
</pre> |
|
@param x The CIMQualifier to be added. |
|
@return A reference to this CIMMethod object. |
|
@exception AlreadyExistsException If a qualifier with the |
|
same name already exists in the CIMMethod. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
*/ | */ |
CIMMethod& addQualifier(const CIMQualifier& x); | CIMMethod& addQualifier(const CIMQualifier& x); |
| |
/** findQualifier - returns the position of the qualifier with |
/** |
the given name. |
Finds a qualifier by name. |
@param name Name of qualifier to be found. |
<p><b>Example:</b> |
@return index of the parameter if found; otherwise PEG_NOT_FOUND. |
<pre> |
|
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
m1.addQualifier(CIMQualifier(CIMName ("stuff"), true)); |
|
assert(m1.findQualifier(CIMName ("stuff")) != PEG_NOT_FOUND); |
|
</pre> |
|
@param name A CIMName specifying the name of the qualifier to be found. |
|
@return Index of the qualifier if found or PEG_NOT_FOUND if not found. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
*/ | */ |
Uint32 findQualifier(const CIMName& name) const; | Uint32 findQualifier(const CIMName& name) const; |
| |
/** getQualifier - Gets the CIMQualifier defined by the index |
/** |
input as a parameter. |
Gets the qualifier at the specified index. |
@param Index of the qualifier requested. |
<p><b>Example:</b> |
@return CIMQualifier object or exception |
<pre> |
@exception OutOfBounds exception if the index is outside the range of |
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
parameters available from the CIMMethod. |
m1.addQualifier(CIMQualifier(CIMName ("stuff"), true)); |
*/ |
Uint32 posQualifier = m1.findQualifier(CIMName ("stuff")); |
CIMQualifier getQualifier(Uint32 pos); |
if (posQualifier != PEG_NOT_FOUND) |
|
{ |
CIMConstQualifier getQualifier(Uint32 pos) const; |
CIMQualifier q = m1.getQualifier(posQualifier); |
|
} |
/** removeQualifier - Removes the CIMQualifier defined by the |
</pre> |
position input as a parameter. |
@param index The index of the qualifier to be retrieved. |
@param Position of the qualifier requested. |
@return The CIMQualifier object at the specified index. |
@return CIMQualifier object or exception |
@exception IndexOutOfBoundsException If the index is |
@exception OutOfBounds exception if the index is outside the range of |
outside the range of qualifiers available for the CIMMethod. |
parameters available from the CIMMethod. |
@exception UninitializedObjectException If the object is not |
*/ |
initialized. |
void removeQualifier(Uint32 pos); |
*/ |
|
CIMQualifier getQualifier(Uint32 index); |
/** getQualifierCount - Returns the number of Qualifiers attached |
|
to this CIMMethod object. |
/** |
@return integer representing number of Qualifiers. |
Gets the qualifier at the specified index. |
|
<p><b>Example:</b> |
|
<pre> |
|
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
m1.addQualifier(CIMQualifier(CIMName ("stuff"), true)); |
|
const CIMMethod m2 = m1; |
|
Uint32 posQualifier = m2.findQualifier(CIMName ("stuff")); |
|
if (posQualifier != PEG_NOT_FOUND) |
|
{ |
|
CIMConstQualifier q = m2.getQualifier(posQualifier); |
|
} |
|
</pre> |
|
@param index The index of the qualifier to be retrieved. |
|
@return The CIMConstQualifier object at the specified index. |
|
@exception IndexOutOfBoundsException If the index is |
|
outside the range of qualifiers available for the CIMMethod. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
|
CIMConstQualifier getQualifier(Uint32 index) const; |
|
|
|
/** |
|
Removes a qualifier from the method. |
|
<p><b>Example:</b> |
|
<pre> |
|
// remove all qualifiers from a class |
|
Uint32 count = 0; |
|
while ((count = cimClass.getQualifierCount()) > 0) |
|
cimClass.removeQualifier(count - 1); |
|
</pre> |
|
@param index The index of the qualifier to remove. |
|
@exception IndexOutOfBoundsException If the index is |
|
outside the range of qualifiers available for the CIMMethod. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
|
void removeQualifier(Uint32 index); |
|
|
|
/** |
|
Gets the number of qualifiers in the method. |
|
<p><b>Example:</b> |
|
<pre> |
|
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
m1.addQualifier(CIMQualifier(CIMName ("stuff"), true)); |
|
m1.addQualifier(CIMQualifier(CIMName ("stuff2"), true)); |
|
assert(m1.getQualifierCount() == 2); |
|
</pre> |
|
@return An integer count of the qualifiers in the CIMMethod. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
*/ | */ |
Uint32 getQualifierCount() const; | Uint32 getQualifierCount() const; |
| |
/** addParameter - Adds the parameter defined by the input |
/** |
to the CIMMethod |
Adds a parameter to the method. |
|
<p><b>Example:</b> |
|
<pre> |
|
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
m1.addParameter(CIMParameter(CIMName("ipaddress"), CIMTYPE_STRING)); |
|
</pre> |
|
@param x The CIMParameter to be added. |
|
@return A reference to this CIMMethod object. |
|
@exception AlreadyExistsException If a parameter with the |
|
same name already exists in the CIMMethod. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
*/ | */ |
CIMMethod& addParameter(const CIMParameter& x); | CIMMethod& addParameter(const CIMParameter& x); |
| |
/** findParameter - Finds the parameter whose name is given |
/** |
by the name parameter. |
Finds a parameter by name. |
@param name Name of parameter to be found. |
<p><b>Example:</b> |
@return index of the parameter if found; otherwise PEG_NOT_FOUND. |
<pre> |
|
Uint32 posParameter; |
|
posParameter = m1.findParameter(CIMName ("ipaddress")); |
|
if (posParameter != PEG_NOT_FOUND) |
|
... |
|
</pre> |
|
@param name A CIMName specifying the name of the parameter to be found. |
|
@return Index of the parameter if found or PEG_NOT_FOUND if not found. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
*/ | */ |
Uint32 findParameter(const CIMName& name) const; | Uint32 findParameter(const CIMName& name) const; |
| |
/** getParameter - Gets the parameter defined by the index |
/** |
input as a parameter. |
Gets the parameter at the specified index. |
@param index for the parameter to be returned. |
<p><b>Example:</b> |
@return CIMParameter requested. |
<pre> |
@Exception OutOfBounds exception is thrown if the index is outside the |
CIMParameter cp; |
range of available parameters |
Uint32 parameterIndex = m1.findParameter(CIMName ("ipaddress")); |
*/ |
if (parameterIndex != PEG_NOT_FOUND) |
CIMParameter getParameter(Uint32 pos); |
{ |
|
cp = m1.getParameter(parameterIndex); |
/** getParameter - const form */ |
} |
CIMConstParameter getParameter(Uint32 pos) const; |
</pre> |
|
@param index The index of the parameter to be retrieved. |
/** getParameterCount - Gets the count of the numbeer of |
@return The CIMParameter at the specified index. |
Parameters attached to the CIMMethod. |
@exception IndexOutOfBoundsException If the index is outside |
@retrun - count of the number of parameters attached to the CIMMethod. |
the range of parameters available for the CIMMethod. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
|
CIMParameter getParameter(Uint32 index); |
|
|
|
/** |
|
Gets the parameter at the specified index. |
|
<p><b>Example:</b> |
|
<pre> |
|
CIMConstParameter cp; |
|
Uint32 parameterIndex = m1.findParameter(CIMName ("ipaddress")); |
|
if (parameterIndex != PEG_NOT_FOUND) |
|
{ |
|
cp = m1.getParameter(parameterIndex); |
|
} |
|
</pre> |
|
@param index The index of the parameter to be retrieved. |
|
@return The CIMConstParameter at the specified index. |
|
@exception IndexOutOfBoundsException If the index is outside |
|
the range of parameters available for the CIMMethod. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
|
CIMConstParameter getParameter(Uint32 index) const; |
|
|
|
/** |
|
Removes a parameter from the method. |
|
@param index Index of the parameter to be removed. |
|
@exception IndexOutOfBoundsException If the index is outside the |
|
range of parameters available from the CIMMethod. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
|
void removeParameter (Uint32 index); |
|
|
|
/** |
|
Gets the number of parameters in the method. |
|
@return An integer count of the CIMParameters in the CIMMethod. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
*/ | */ |
Uint32 getParameterCount() const; | Uint32 getParameterCount() const; |
| |
#ifdef PEGASUS_INTERNALONLY |
/** |
/** Returns true if CIMMethod refers to a null pointer */ |
Determines whether the object has been initialized. |
Boolean isNull() const; |
<p><b>Example:</b> |
#endif |
<pre> |
|
CIMMethod m1; |
/** identical - Returns true if this method is identical to the |
assert(m1.isUninitialized()); |
one given by the argument x. |
</pre> |
|
@return True if the object has not been initialized, false otherwise. |
|
*/ |
|
Boolean isUninitialized() const; |
|
|
|
/** |
|
Compares the method with another method. |
|
<p><b>Example:</b> |
|
<pre> |
|
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
CIMConstMethod m2(CIMName ("test"), CIMTYPE_STRING); |
|
assert(!m1.identical(m2)); |
|
</pre> |
|
@param x The CIMConstMethod to be compared. |
|
@return True if this method is identical to the one specified, |
|
false otherwise. |
|
@exception UninitializedObjectException If either of the objects |
|
is not initialized. |
*/ | */ |
Boolean identical(const CIMConstMethod& x) const; | Boolean identical(const CIMConstMethod& x) const; |
| |
/** CIMMethod clone - makes a distinct replica of this method */ |
/** |
|
Makes a deep copy of the method. This creates a new copy |
|
of all the method attributes including parameters and qualifiers. |
|
@return A new copy of the CIMMethod object. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
CIMMethod clone() const; | CIMMethod clone() const; |
| |
private: | private: |
| |
CIMMethod(CIMMethodRep* rep); | CIMMethod(CIMMethodRep* rep); |
| |
|
/** |
|
This method is not implemented. It is defined to explicitly disallow |
|
construction of a CIMMethod from a CIMConstMethod. Because the |
|
CIMMethod class uses a shared representation model, allowing this |
|
construction would effectively allow modification of CIMConstMethod |
|
objects. |
|
*/ |
PEGASUS_EXPLICIT CIMMethod(const CIMConstMethod& x); | PEGASUS_EXPLICIT CIMMethod(const CIMConstMethod& x); |
| |
void _checkRep() const; | void _checkRep() const; |
|
|
friend class Resolver; | friend class Resolver; |
friend class XmlWriter; | friend class XmlWriter; |
friend class MofWriter; | friend class MofWriter; |
|
friend class BinaryStreamer; |
}; | }; |
| |
|
/** |
|
The CIMConstMethod class provides a const interface to a CIMMethod |
|
object. This class is needed because the shared representation model |
|
used by CIMMethod does not prevent modification to a const CIMMethod |
|
object. Note that the value of a CIMConstMethod object could still be |
|
modified by a CIMMethod object that refers to the same data copy. |
|
*/ |
class PEGASUS_COMMON_LINKAGE CIMConstMethod | class PEGASUS_COMMON_LINKAGE CIMConstMethod |
{ | { |
public: | public: |
| |
|
/** |
|
Constructs an uninitialized CIMConstMethod object. A method |
|
invocation on an uninitialized object will result in the throwing |
|
of an UninitializedObjectException. An uninitialized object may |
|
be converted into an initialized object only by using the assignment |
|
operator with an initialized object. |
|
*/ |
CIMConstMethod(); | CIMConstMethod(); |
| |
|
/** |
|
Constructs a CIMConstMethod object from the value of a specified |
|
CIMConstMethod object, so that both objects refer to the same data |
|
copy. |
|
|
|
<p><b>Example:</b> |
|
<pre> |
|
CIMConstMethod cm1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
CIMConstMethod cm2(m1); |
|
</pre> |
|
|
|
@param x The CIMConstMethod object from which to construct a new |
|
CIMConstMethod object. |
|
*/ |
CIMConstMethod(const CIMConstMethod& x); | CIMConstMethod(const CIMConstMethod& x); |
| |
|
/** |
|
Constructs a CIMConstMethod object from the value of a specified |
|
CIMMethod object, so that both objects refer to the same data |
|
copy. |
|
|
|
<p><b>Example:</b> |
|
<pre> |
|
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
CIMConstMethod cm1(m1); |
|
</pre> |
|
|
|
@param x The CIMMethod object from which to construct a new |
|
CIMConstMethod object. |
|
*/ |
CIMConstMethod(const CIMMethod& x); | CIMConstMethod(const CIMMethod& x); |
| |
// Throws IllegalName if name argument not legal CIM identifier. |
/** |
|
Constructs a CIMConstMethod object with the specified attributes. |
|
<p><b>Example:</b> |
|
<pre> |
|
CIMConstMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
</pre> |
|
|
|
@param name CIMName defining the name for the method. |
|
@param type CIMType defining the method return type. |
|
@param classOrigin (optional) CIMName representing the class origin. |
|
Note that this should normally not be used. If not provided set to |
|
CIMName() (Null name). |
|
@param propagated Optional 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 |
|
a superclass. Default is false. Note that this attribute is |
|
normally not set by CIM Clients but is used internally within the |
|
CIM Server. |
|
@exception UninitializedObjectException If the method name is null. |
|
*/ |
CIMConstMethod( | CIMConstMethod( |
const CIMName& name, | const CIMName& name, |
CIMType type, | CIMType type, |
const CIMName& classOrigin = CIMName(), | const CIMName& classOrigin = CIMName(), |
Boolean propagated = false); | Boolean propagated = false); |
| |
|
/** |
|
Destructs the CIMConstMethod object. |
|
*/ |
~CIMConstMethod(); | ~CIMConstMethod(); |
| |
|
/** |
|
Assigns the value of the specified CIMConstMethod object to this |
|
object, so that both objects refer to the same data copy. |
|
|
|
<p><b>Example:</b> |
|
<pre> |
|
CIMConstMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
CIMConstMethod m2; |
|
m2 = m1; |
|
</pre> |
|
|
|
@param x The CIMConstMethod object from which to assign this |
|
CIMConstMethod object. |
|
@return A reference to this CIMConstMethod object. |
|
*/ |
CIMConstMethod& operator=(const CIMConstMethod& x); | CIMConstMethod& operator=(const CIMConstMethod& x); |
| |
|
/** |
|
Assigns the value of the specified CIMMethod object to this |
|
object, so that both objects refer to the same data copy. |
|
|
|
<p><b>Example:</b> |
|
<pre> |
|
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
CIMConstMethod m2; |
|
m2 = m1; |
|
</pre> |
|
|
|
@param x The CIMMethod object from which to assign this |
|
CIMConstMethod object. |
|
@return A reference to this CIMConstMethod object. |
|
*/ |
CIMConstMethod& operator=(const CIMMethod& x); | CIMConstMethod& operator=(const CIMMethod& x); |
| |
|
/** |
|
Gets the name of the method. |
|
<p><b>Example:</b> |
|
<pre> |
|
CIMConstMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
assert(m1.getName() == CIMName ("getHostName")); |
|
</pre> |
|
@return CIMName with the name of the method. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
const CIMName& getName() const; | const CIMName& getName() const; |
| |
|
/** |
|
Gets the method return type. |
|
<p><b>Example:</b> |
|
<pre> |
|
CIMConstMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
assert(m1.getType() == CIMTYPE_STRING); |
|
</pre> |
|
@return A CIMType containing the method return type. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
CIMType getType() const; | CIMType getType() const; |
| |
|
/** |
|
Gets the class in which this method was defined. This information |
|
is normally available with methods that are part of a schema |
|
returned from a CIM Server. |
|
@return CIMName containing the classOrigin attribute. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
const CIMName& getClassOrigin() const; | const CIMName& getClassOrigin() const; |
| |
|
/** |
|
Tests the propagated attribute of the object. The propagated |
|
attribute indicates whether this method was propagated from a |
|
higher-level class. Normally this attribute is set as part of |
|
defining a method in the context of a schema. It is set in |
|
methods retrieved from a CIM Server. |
|
@return True if method is propagated; otherwise, false. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
Boolean getPropagated() const; | Boolean getPropagated() const; |
| |
|
/** |
|
Finds a qualifier by name. |
|
<p><b>Example:</b> |
|
<pre> |
|
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
m1.addQualifier(CIMQualifier(CIMName ("stuff"), true)); |
|
CIMConstMethod m2(m1); |
|
assert(m2.findQualifier(CIMName ("stuff")) != PEG_NOT_FOUND); |
|
</pre> |
|
@param name A CIMName specifying the name of the qualifier to be found. |
|
@return Index of the qualifier if found or PEG_NOT_FOUND if not found. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
Uint32 findQualifier(const CIMName& name) const; | Uint32 findQualifier(const CIMName& name) const; |
| |
CIMConstQualifier getQualifier(Uint32 pos) const; |
/** |
|
Gets the qualifier at the specified index. |
|
<p><b>Example:</b> |
|
<pre> |
|
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
m1.addQualifier(CIMQualifier(CIMName ("stuff"), true)); |
|
CIMConstMethod m2(m1); |
|
Uint32 posQualifier = m2.findQualifier(CIMName ("stuff")); |
|
if (posQualifier != PEG_NOT_FOUND) |
|
{ |
|
CIMQualifier q = m2.getQualifier(posQualifier); |
|
} |
|
</pre> |
|
@param index The index of the qualifier to be retrieved. |
|
@return The CIMConstQualifier at the specified index. |
|
@exception IndexOutOfBoundsException If the index is |
|
outside the range of qualifiers available for the CIMMethod. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
|
CIMConstQualifier getQualifier(Uint32 index) const; |
|
|
|
/** |
|
Gets the number of qualifiers in the method. |
|
<p><b>Example:</b> |
|
<pre> |
|
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
m1.addQualifier(CIMQualifier(CIMName ("stuff"), true)); |
|
m1.addQualifier(CIMQualifier(CIMName ("stuff2"), true)); |
|
CIMConstMethod m2(m1); |
|
assert(m2.getQualifierCount() == 2); |
|
</pre> |
|
@return An integer count of the CIMQualifiers in the CIMMethod. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
Uint32 getQualifierCount() const; | Uint32 getQualifierCount() const; |
| |
|
/** |
|
Finds a parameter by name. |
|
<p><b>Example:</b> |
|
<pre> |
|
Uint32 posParameter; |
|
posParameter = m1.findParameter(CIMName ("ipaddress")); |
|
if (posParameter != PEG_NOT_FOUND) |
|
... |
|
</pre> |
|
@param name A CIMName specifying the name of the parameter to be found. |
|
@return Index of the parameter if found or PEG_NOT_FOUND if not found. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
Uint32 findParameter(const CIMName& name) const; | Uint32 findParameter(const CIMName& name) const; |
| |
CIMConstParameter getParameter(Uint32 pos) const; |
/** |
|
Gets the parameter at the specified index. |
|
<p><b>Example:</b> |
|
<pre> |
|
CIMConstParameter cp; |
|
Uint32 parameterIndex = m1.findParameter(CIMName ("ipaddress")); |
|
if (parameterIndex != PEG_NOT_FOUND) |
|
{ |
|
cp = m1.getParameter(parameterIndex); |
|
} |
|
</pre> |
|
@param index The index of the parameter to be retrieved. |
|
@return The CIMConstParameter at the specified index. |
|
@exception IndexOutOfBoundsException If the index is |
|
outside the range of parameters available for the CIMMethod. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
|
CIMConstParameter getParameter(Uint32 index) const; |
|
|
|
/** |
|
Gets the number of parameters in the method. |
|
@return An integer count of the CIMParameters in the CIMMethod. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
Uint32 getParameterCount() const; | Uint32 getParameterCount() const; |
| |
#ifdef PEGASUS_INTERNALONLY |
/** |
Boolean isNull() const; |
Determines whether the object has been initialized. |
#endif |
<p><b>Example:</b> |
|
<pre> |
|
CIMConstMethod m1; |
|
assert(m1.isUninitialized()); |
|
</pre> |
|
@return True if the object has not been initialized, false otherwise. |
|
*/ |
|
Boolean isUninitialized() const; |
|
|
|
/** |
|
Compares the method with another method. |
|
<p><b>Example:</b> |
|
<pre> |
|
CIMConstMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
CIMConstMethod m2(CIMName ("test"), CIMTYPE_STRING); |
|
assert(!m1.identical(m2)); |
|
</pre> |
|
@param x The CIMConstMethod to be compared. |
|
@return True if this method is identical to the one specified, |
|
false otherwise. |
|
@exception UninitializedObjectException If either of the objects |
|
is not initialized. |
|
*/ |
Boolean identical(const CIMConstMethod& x) const; | Boolean identical(const CIMConstMethod& x) const; |
| |
|
/** |
|
Makes a deep copy of the method. This creates a new copy |
|
of all the method attributes including parameters and qualifiers. |
|
@return A CIMMethod object with a separate copy of the |
|
CIMConstMethod object. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
CIMMethod clone() const; | CIMMethod clone() const; |
| |
private: | private: |