version 1.49, 2005/12/01 18:35:07
|
version 1.53, 2007/05/29 17:21:06
|
|
|
//%2005//////////////////////////////////////////////////////////////////////// |
//%2006//////////////////////////////////////////////////////////////////////// |
// | // |
// Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development | // Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development |
// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems. | // Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems. |
|
|
// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group. | // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group. |
// Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.; | // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
// EMC Corporation; VERITAS Software Corporation; The Open Group. | // 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 |
|
|
class CIMConstMethod; | class CIMConstMethod; |
class CIMMethodRep; | class CIMMethodRep; |
| |
/** The CIMMethod class is used to represent CIM methods in Pegasus. |
/** |
A CIMMethod consists of the following entities: |
The CIMMethod class represents the DMTF standard CIM method definition. |
|
A CIMMethod is generally defined in the context of a CIMClass. |
|
A CIMMethod consists of: |
<ul> | <ul> |
<li>Name of the method, a CIMName. |
<li>A CIMName containing the name of the method |
|
<li>A CIMType defining the method return type |
<li>CIM type of the method return value, a CIMType. |
<li>Zero or more CIMQualifier objects |
|
<li>Zero or more CIMParameter objects defining the method parameters |
<li>Optional qualifiers (see CIMQualifier) for the method. |
|
A method can contain zero or more CIMQualifier objects. |
|
|
|
<li>Optional parameters (see CIMParameter) for the method. |
|
A CIMMethod may contain zero or more CIMParameter objects. |
|
</ul> | </ul> |
In addition, a CIMMethod contains the following internal attributes: |
In addition, a CIMMethod has these internal attributes: |
<ul> | <ul> |
<li><b>propagated</b> - An attribute defining whether this CIMMethod is |
<li><b>propagated</b> - An attribute defining whether this CIMMethod |
propagated from a superclass. Note that this is normally set as part |
is propagated from a superclass. Note that this is normally set |
of completing the definition of objects (resolving) when they are |
as part of completing the definition of objects (resolving) when |
created as part of a CIM schema and is NOT automatically set when |
they are created as part of a CIM schema and is NOT automatically |
creating a local object. It can only be logically set in context of |
set when creating a method object. It can only be logically set |
the schema in which the CIMMethod is defined. |
in context of the schema in which the CIMMethod is defined. |
<li><b>classOrigin</b> - An attribute defining the class in which | <li><b>classOrigin</b> - An attribute defining the class in which |
this CIMMethod was originally defined. This is normally set within the |
this CIMMethod was originally defined. This is normally set |
context of the schema in which the CIMMethod is defined. |
within the context of the schema in which the CIMMethod is |
This attribute is available from objects retrieved from the CIM |
defined. This attribute is available from objects retrieved |
Server, for example, and provides information on the defintion |
from the CIM Server, for example, and provides information on |
of this method in the class hierarchy. Together the |
the defintion of this method in the class hierarchy. The |
propagated and ClassOrigin attributes can be used to determine if |
propagated and ClassOrigin attributes can be used together to |
methods originated with the current object or were inherited from |
determine if methods originated with this object or were |
higher levels in the hiearchy. |
inherited from higher levels of the hiearchy. |
</ul> | </ul> |
A CIMMethod is generally defined in the context of a CIMClass. |
|
| |
CIMMethod uses shared representations, meaning that multiple |
<p>The CIMMethod class uses a shared representation model, such that |
CIMMethod objects may refer to the same copy of data. Assignment and copy |
multiple CIMMethod objects may refer to the same data copy. Assignment |
operators create new references to the same data, not distinct copies. |
and copy operators create new references to the same data, not distinct |
A distinct copy may be created using the clone method. |
copies. An update to a CIMMethod object affects all the CIMMethod |
{@link Shared Classes} |
objects that refer to the same data copy. The data remains valid until |
@see CIMConstMethod |
all the CIMMethod objects that refer to it are destructed. A separate |
@see CIMParameter |
copy of the data may be created using the clone method. |
@see CIMQualifier |
|
@see CIMType |
|
@see CIMClass |
|
*/ | */ |
class PEGASUS_COMMON_LINKAGE CIMMethod | class PEGASUS_COMMON_LINKAGE CIMMethod |
{ | { |
public: | public: |
| |
/** Creates a new uninitialized CIMMethod object. |
/** |
The only thing that can be done with this object is to copy another |
Constructs an uninitialized CIMMethod object. A method |
object into it. Other methods, such as setName, will fail with an |
invocation on an uninitialized object will result in the throwing |
UninitializedObjectException. The object has an uninitialized state, |
of an UninitializedObjectException. An uninitialized object may |
which can be tested with the isUninitialized method. |
be converted into an initialized object only by using the assignment |
@see isUninitialized() |
operator with an initialized object. |
@see UninitializedObjectException |
|
*/ | */ |
CIMMethod(); | CIMMethod(); |
| |
/** Creates a new CIMMethod object from another CIMMethod object. |
/** |
The new CIMMethod object references the same copy of data as the |
Constructs a CIMMethod object from the value of a specified |
specified object; no copy is made. |
CIMMethod object, so that both objects refer to the same data copy. |
@param x CIMMethod object from which to create the new CIMMethod object. |
|
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); | CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
const CIMMethod cm1(m1); | const CIMMethod cm1(m1); |
</pre> | </pre> |
{@link Shared Classes} |
|
|
@param x The CIMMethod object from which to construct a new |
|
CIMMethod object. |
*/ | */ |
CIMMethod(const CIMMethod& x); | CIMMethod(const CIMMethod& x); |
| |
/** Creates a CIMMethod object with the specified attributes. |
/** |
@param name CIMName defining the name for the method. |
Constructs a CIMMethod object with the specified attributes. |
|
|
@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. |
|
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); | CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
</pre> | </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); |
| |
/** Destructor for the CIMMethod. The shared data copy remains valid until |
/** |
all referring objects are destructed. |
Destructs the CIMMethod object. |
{@link Shared Classes} |
|
*/ | */ |
~CIMMethod(); | ~CIMMethod(); |
| |
/** The assignment operator assigns one CIMMethod to another. |
/** |
After the assignment, both CIMMethod objects refer to the same |
Assigns the value of the specified CIMMethod object to this object, |
data copy; a distinct copy is not created. |
so that both objects refer to the same data copy. |
@param x CIMMethod object from which to assign this CIMMethod object. |
|
| |
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
|
|
CIMMethod m2; | CIMMethod m2; |
m2 = m1; | m2 = m1; |
</pre> | </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); |
| |
/** Gets the name of the method. |
/** |
@return CIMName with the name of the method. |
Gets the name of the method. |
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); | CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
assert(m1.getName() == CIMName ("getHostName")); | assert(m1.getName() == CIMName ("getHostName")); |
</pre> | </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; |
| |
/** Sets the method name. |
/** |
@param name CIMName for the method name. Replaces any |
Sets the method name. |
previously defined name for this method object. |
|
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
CIMMethod m2(CIMName ("test"), CIMTYPE_STRING); | CIMMethod m2(CIMName ("test"), CIMTYPE_STRING); |
m2.setName(CIMName ("getVersion")); | m2.setName(CIMName ("getVersion")); |
</pre> | </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); |
| |
/** Gets the method return type. |
/** |
@return A CIMType containing the method return type. |
Gets the method return type. |
@exception UninitializedObjectException Thrown if the object is not |
|
initialized. |
|
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); | CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
assert(m1.getType() == CIMTYPE_STRING); | assert(m1.getType() == CIMTYPE_STRING); |
</pre> | </pre> |
|
@return A CIMType containing the method return type. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
*/ | */ |
CIMType getType() const; | CIMType getType() const; |
| |
/** Sets the method return type to the specified CIMType. |
/** |
|
Sets the method return type to the specified CIMType. |
This is the type of the CIMValue | This is the type of the CIMValue |
that is returned on a CIM method invocation. | that is returned on a CIM method invocation. |
@param type CIMType to be set into the CIMMethod object. |
|
@exception UninitializedObjectException Thrown if the object is not |
|
initialized. |
|
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); | CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
m1.setName(CIMName ("getVersion")); | m1.setName(CIMName ("getVersion")); |
assert(m1.getName() == CIMName ("getVersion")); | assert(m1.getName() == CIMName ("getVersion")); |
</pre> | </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); |
| |
/** Gets the class in which this method was defined. This information |
/** |
is normally available with methods that are part of a schema |
Gets the class in which this method is locally defined. This |
returned from a CIM Server. |
information is normally available with methods that are part of |
|
schema returned from a CIM Server. |
@return CIMName containing the classOrigin attribute. | @return CIMName containing the classOrigin attribute. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
*/ | */ |
const CIMName& getClassOrigin() const; | const CIMName& getClassOrigin() const; |
| |
/** Sets the classOrigin attribute with the specified class name. |
/** |
|
Sets the classOrigin attribute with the specified class name. |
Normally this method is used internally by a CIM Server when | Normally this method is used internally by a CIM Server when |
defining methods in the context of a schema. | defining methods in the context of a schema. |
@param classOrigin CIMName parameter defining the name |
@param classOrigin A CIMName specifying the name of the class of |
of the origin class. |
origin for the method. |
@exception UninitializedObjectException Thrown if the object is not |
@exception UninitializedObjectException If the object is not |
initialized. | initialized. |
*/ | */ |
void setClassOrigin(const CIMName& classOrigin); | void setClassOrigin(const CIMName& classOrigin); |
| |
/** Tests the propagated attribute of the object. The propagated |
/** |
|
Tests the propagated attribute of the object. The propagated |
attribute indicates whether this method was propagated from a | attribute indicates whether this method was propagated from a |
higher-level class. Normally this attribute is set as part of | higher-level class. Normally this attribute is set as part of |
defining a method in the context of a schema. It is set in | defining a method in the context of a schema. It is set in |
methods retrieved from a CIM Server. | methods retrieved from a CIM Server. |
@return True if method is propagated; otherwise, false. | @return True if method is propagated; otherwise, false. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
*/ | */ |
Boolean getPropagated() const; | Boolean getPropagated() const; |
| |
/** Sets the propagated attribute. Normally this is used by a CIM Server |
/** |
|
Sets the propagated attribute. Normally this is used by a CIM Server |
when defining a method in the context of a schema. | when defining a method in the context of a schema. |
@param propagated Flag indicating whether the method is propagated |
@param propagated A Boolean indicating whether the method is |
from a superclass. |
propagated from a superclass. |
@exception UninitializedObjectException Thrown if the object is not |
@exception UninitializedObjectException If the object is not |
initialized. | initialized. |
*/ | */ |
void setPropagated(Boolean propagated); | void setPropagated(Boolean propagated); |
| |
/** Adds the specified qualifier to the CIMMethod object. |
/** |
@param x CIMQualifier object representing the qualifier |
Adds a qualifier to the method. |
to be added. |
|
@return The CIMMethod object after adding the specified qualifier. |
|
@exception AlreadyExistsException Thrown if the qualifier already |
|
exists in this CIMMethod. |
|
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); | CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
m1.addQualifier(CIMQualifier(CIMName ("stuff"), true)); | m1.addQualifier(CIMQualifier(CIMName ("stuff"), true)); |
</pre> | </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); |
| |
/** Searches for a qualifier with the specified input name. |
/** |
@param name CIMName of the qualifier to be found. |
Finds a qualifier by name. |
@return Zero origin index of the qualifier found or PEG_NOT_FOUND |
|
if not found. |
|
@exception UninitializedObjectException Thrown if the object is not |
|
initialized. |
|
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); | CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
m1.addQualifier(CIMQualifier(CIMName ("stuff"), true)); | m1.addQualifier(CIMQualifier(CIMName ("stuff"), true)); |
assert(m1.findQualifier(CIMName ("stuff")) != PEG_NOT_FOUND); | assert(m1.findQualifier(CIMName ("stuff")) != PEG_NOT_FOUND); |
</pre> | </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; |
| |
/** Gets the CIMQualifier defined by the input parameter. |
/** |
@param index Zero origin index of the qualifier requested. |
Gets the qualifier at the specified index. |
@return CIMQualifier object representing the qualifier found. |
|
@exception IndexOutOfBoundsException Thrown if the index is |
|
outside the range of parameters available from the CIMMethod. |
|
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); | CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
|
CIMQualifier q = m1.getQualifier(posQualifier); | CIMQualifier q = m1.getQualifier(posQualifier); |
} | } |
</pre> | </pre> |
|
@param index The index of the qualifier to be retrieved. |
|
@return The CIMQualifier 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. |
*/ | */ |
CIMQualifier getQualifier(Uint32 index); | CIMQualifier getQualifier(Uint32 index); |
| |
/** Gets the CIMQualifier defined by the input parameter. |
/** |
@param index Zero origin index of the qualifier requested. |
Gets the qualifier at the specified index. |
@return CIMQualifier object representing the qualifier found. |
|
@exception IndexOutOfBoundsException Thrown if the index is |
|
outside the range of parameters available from the CIMMethod. |
|
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); | CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
|
CIMConstQualifier q = m2.getQualifier(posQualifier); | CIMConstQualifier q = m2.getQualifier(posQualifier); |
} | } |
</pre> | </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; | CIMConstQualifier getQualifier(Uint32 index) const; |
| |
/** Removes the specified qualifier from this method. |
/** |
@param index Index of the qualifier to remove. |
Removes a qualifier from the method. |
@exception IndexOutOfBoundsException Thrown if the index is |
|
outside the range of parameters available from the CIMMethod. |
|
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
// remove all qualifiers from a class | // remove all qualifiers from a class |
|
|
while((count = cimClass.getQualifierCount()) > 0) | while((count = cimClass.getQualifierCount()) > 0) |
cimClass.removeQualifier(count - 1); | cimClass.removeQualifier(count - 1); |
</pre> | </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); | void removeQualifier(Uint32 index); |
| |
/** Returns the number of Qualifiers attached to this CIMMethod object. |
/** |
@return The number of qualifiers attached to the CIM Method. |
Gets the number of qualifiers in the method. |
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); | CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
|
m1.addQualifier(CIMQualifier(CIMName ("stuff2"), true)); | m1.addQualifier(CIMQualifier(CIMName ("stuff2"), true)); |
assert(m1.getQualifierCount() == 2); | assert(m1.getQualifierCount() == 2); |
</pre> | </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; |
| |
/** Adds the parameter defined by the input to the CIMMethod. |
/** |
@param x CIMParameter to be added to the CIM Method. |
Adds a parameter to the method. |
@return CIMMethod object after the specified parameter is added. |
|
<p><b>Example:</b> | <p><b>Example:</b> |
@exception UninitializedObjectException Thrown if the object is not |
|
initialized. |
|
@exception AlreadyExistsException Thrown if the parameter already |
|
exists in this CIMMethod. |
|
<pre> | <pre> |
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); | CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
m1.addParameter(CIMParameter(CIMName ("ipaddress"), CIMTYPE_STRING)); | m1.addParameter(CIMParameter(CIMName ("ipaddress"), CIMTYPE_STRING)); |
</pre> | </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); |
| |
/** Finds the parameter with the specified name. |
/** |
@param name CIMName of parameter to be found. |
Finds a parameter by name. |
@return Index of the parameter object found or PEG_NOT_FOUND |
|
if the property is not found. |
|
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
Uint32 posParameter; | Uint32 posParameter; |
|
|
if (posParameter != PEG_NOT_FOUND) | if (posParameter != PEG_NOT_FOUND) |
... | ... |
</pre> | </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; |
| |
/** Gets the parameter defined by the specified index. |
/** |
@param index Index for the parameter to be returned. |
Gets the parameter at the specified index. |
@return CIMParameter object requested. |
|
@exception IndexOutOfBoundsException Thrown if the index is outside |
|
the range of available parameters. |
|
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
CIMParameter cp; | CIMParameter cp; |
|
|
cp = m1.getParameter(parameterIndex); | cp = m1.getParameter(parameterIndex); |
} | } |
</pre> | </pre> |
|
@param index The index of the parameter to be retrieved. |
|
@return The CIMParameter 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. |
*/ | */ |
CIMParameter getParameter(Uint32 index); | CIMParameter getParameter(Uint32 index); |
| |
/** Gets the parameter defined by the specified index. |
/** |
@param index Index for the parameter to be returned. |
Gets the parameter at the specified index. |
@return CIMParameter object requested. |
|
@exception IndexOutOfBoundsException Thrown if the index is outside |
|
the range of available parameters. |
|
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
CIMConstParameter cp; | CIMConstParameter cp; |
|
|
cp = m1.getParameter(parameterIndex); | cp = m1.getParameter(parameterIndex); |
} | } |
</pre> | </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; | CIMConstParameter getParameter(Uint32 index) const; |
| |
/** Removes the parameter defined by the specified index. |
/** |
|
Removes a parameter from the method. |
@param index Index of the parameter to be removed. | @param index Index of the parameter to be removed. |
@exception IndexOutOfBoundsException Thrown if the index is outside the |
@exception IndexOutOfBoundsException If the index is outside the |
range of parameters available from the CIMMethod. | range of parameters available from the CIMMethod. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
*/ | */ |
void removeParameter (Uint32 index); | void removeParameter (Uint32 index); |
| |
/** Gets the count of Parameters defined in the CIMMethod. |
/** |
@return Count of the number of parameters attached to the CIMMethod. |
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; |
| |
/** Determines if the object has not been initialized. |
/** |
@return True if the object has not been initialized; |
Determines whether the object has been initialized. |
otherwise, false. |
|
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
CIMMethod m1; | CIMMethod m1; |
assert(m1.isUninitialized()); | assert(m1.isUninitialized()); |
</pre> | </pre> |
|
@return True if the object has not been initialized, false otherwise. |
*/ | */ |
Boolean isUninitialized() const; | Boolean isUninitialized() const; |
| |
/** Compares with a CIMConstMethod. |
/** |
@param x CIMConstMethod object for the method to be compared. |
Compares the method with another method. |
@return True if this method is identical to the one specified; |
|
otherwise, false. |
|
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); | CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
CIMConstMethod m2(CIMName ("test"), CIMTYPE_STRING); | CIMConstMethod m2(CIMName ("test"), CIMTYPE_STRING); |
assert(!m1.identical(m2)); | assert(!m1.identical(m2)); |
</pre> | </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 clone (deep copy) of this method. This creates |
/** |
a new copy of all of the components of the method including |
Makes a deep copy of the method. This creates a new copy |
parameters and qualifiers. |
of all the method attributes including parameters and qualifiers. |
@return Independent copy of the CIMMethod object. |
@return A new copy of the CIMMethod object. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
*/ | */ |
CIMMethod clone() const; | CIMMethod clone() const; |
| |
|
|
| |
CIMMethod(CIMMethodRep* rep); | CIMMethod(CIMMethodRep* rep); |
| |
/** This method is not implemented. It is defined to explicitly disallow |
/** |
|
This method is not implemented. It is defined to explicitly disallow |
construction of a CIMMethod from a CIMConstMethod. Because the | construction of a CIMMethod from a CIMConstMethod. Because the |
CIMMethod class uses a shared representation model, allowing this | CIMMethod class uses a shared representation model, allowing this |
construction would effectively allow modification of CIMConstMethod | construction would effectively allow modification of CIMConstMethod |
objects. | objects. |
*/ | */ |
PEGASUS_EXPLICIT CIMMethod(const CIMConstMethod& x); |
explicit CIMMethod(const CIMConstMethod& x); |
| |
void _checkRep() const; | void _checkRep() const; |
| |
|
|
friend class BinaryStreamer; | friend class BinaryStreamer; |
}; | }; |
| |
/** The CIMConstMethod class is used to represent CIM methods in the |
/** |
same manner as the CIMMethod class except that the const attribute |
The CIMConstMethod class provides a const interface to a CIMMethod |
is applied to the objects created. This class includes equivalents |
object. This class is needed because the shared representation model |
to the methods from CIMMethod that are available in a const object, |
used by CIMMethod does not prevent modification to a const CIMMethod |
including constructors, accessor methods, and the destructor. |
object. Note that the value of a CIMConstMethod object could still be |
|
modified by a CIMMethod object that refers to the same data copy. |
Because the CIMMethod class uses a shared representation model, allowing |
|
the construction of a 'CIMMethod' from a 'const CIMMethod' would |
|
effectively allow modification of a 'const CIMMethod'. The CIMConstMethod |
|
class is used to represent constant CIMMethod objects. Since a |
|
CIMConstMethod cannot be converted to a CIMMethod, its value remains |
|
constant. |
|
|
|
@see CIMMethod() |
|
*/ | */ |
class PEGASUS_COMMON_LINKAGE CIMConstMethod | class PEGASUS_COMMON_LINKAGE CIMConstMethod |
{ | { |
public: | public: |
| |
/** Creates a new uninitialized CIMConstMethod object. |
/** |
The only thing that can be done with this object is to copy another |
Constructs an uninitialized CIMConstMethod object. A method |
object into it. Other methods, such as getName, will fail with an |
invocation on an uninitialized object will result in the throwing |
UninitializedObjectException. The object has an uninitialized state, |
of an UninitializedObjectException. An uninitialized object may |
which can be tested with the isUninitialized method. |
be converted into an initialized object only by using the assignment |
@see isUninitialized() |
operator with an initialized object. |
@see UninitializedObjectException |
|
*/ | */ |
CIMConstMethod(); | CIMConstMethod(); |
| |
/** Creates a new CIMConstMethod object from another CIMConstMethod object. |
/** |
The new CIMConstMethod object references the same copy of data as the |
Constructs a CIMConstMethod object from the value of a specified |
specified object; no copy is made. |
CIMConstMethod object, so that both objects refer to the same data |
@param x CIMConstMethod object from which to create the new |
copy. |
CIMConstMethod object. |
|
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
CIMConstMethod cm1(CIMName ("getHostName"), CIMTYPE_STRING); | CIMConstMethod cm1(CIMName ("getHostName"), CIMTYPE_STRING); |
CIMConstMethod cm2(m1); | CIMConstMethod cm2(m1); |
</pre> | </pre> |
{@link Shared Classes} |
|
|
@param x The CIMConstMethod object from which to construct a new |
|
CIMConstMethod object. |
*/ | */ |
CIMConstMethod(const CIMConstMethod& x); | CIMConstMethod(const CIMConstMethod& x); |
| |
/** Creates a new CIMConstMethod object from a CIMMethod object. |
/** |
The new CIMConstMethod object references the same copy of data as the |
Constructs a CIMConstMethod object from the value of a specified |
specified object; no copy is made. |
CIMMethod object, so that both objects refer to the same data |
@param x CIMMethod object from which to create the new |
copy. |
CIMConstMethod object. |
|
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); | CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
CIMConstMethod cm1(m1); | CIMConstMethod cm1(m1); |
</pre> | </pre> |
{@link Shared Classes} |
|
|
@param x The CIMMethod object from which to construct a new |
|
CIMConstMethod object. |
*/ | */ |
CIMConstMethod(const CIMMethod& x); | CIMConstMethod(const CIMMethod& x); |
| |
/** Creates a CIMConstMethod object with the specified attributes. |
/** |
@param name CIMName defining the name for the method. |
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 type CIMType defining the method return type. |
|
|
@param classOrigin (optional) CIMName representing the class origin. | @param classOrigin (optional) CIMName representing the class origin. |
Note that this should normally not be used. If not provided set to | Note that this should normally not be used. If not provided set to |
CIMName() (Null name). | CIMName() (Null name). |
|
|
a superclass. Default is false. Note that this attribute is | a superclass. Default is false. Note that this attribute is |
normally not set by CIM Clients but is used internally within the | normally not set by CIM Clients but is used internally within the |
CIM Server. | CIM Server. |
<p><b>Example:</b> |
@exception UninitializedObjectException If the method name is null. |
<pre> |
|
CIMConstMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
</pre> |
|
*/ | */ |
CIMConstMethod( | CIMConstMethod( |
const CIMName& name, | const CIMName& name, |
|
|
const CIMName& classOrigin = CIMName(), | const CIMName& classOrigin = CIMName(), |
Boolean propagated = false); | Boolean propagated = false); |
| |
/** Destructor for the CIMConstMethod. The shared data copy remains valid |
/** |
until all referring objects are destructed. |
Destructs the CIMConstMethod object. |
{@link Shared Classes} |
|
*/ | */ |
~CIMConstMethod(); | ~CIMConstMethod(); |
| |
/** The assignment operator assigns one CIMConstMethod to another. |
/** |
After the assignment, both CIMConstMethod objects refer to the same |
Assigns the value of the specified CIMConstMethod object to this |
data copy; a distinct copy is not created. |
object, so that both objects refer to the same data copy. |
@param x CIMConstMethod object from which to assign this |
|
CIMConstMethod object. |
|
| |
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
|
|
CIMConstMethod m2; | CIMConstMethod m2; |
m2 = m1; | m2 = m1; |
</pre> | </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); |
| |
/** The assignment operator assigns a CIMMethod object to a |
/** |
CIMConstMethod. |
Assigns the value of the specified CIMMethod object to this |
After the assignment, both objects refer to the same |
object, so that both objects refer to the same data copy. |
data copy; a distinct copy is not created. |
|
@param x CIMConstMethod object from which to assign this |
|
CIMConstMethod object. |
|
| |
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
|
|
CIMConstMethod m2; | CIMConstMethod m2; |
m2 = m1; | m2 = m1; |
</pre> | </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. |
/** |
@return CIMName with the name of the method. |
Gets the name of the method. |
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
CIMConstMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); | CIMConstMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
assert(m1.getName() == CIMName ("getHostName")); | assert(m1.getName() == CIMName ("getHostName")); |
</pre> | </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. |
/** |
@return A CIMType containing the method return type. |
Gets the method return type. |
@exception UninitializedObjectException Thrown if the object is not |
|
initialized. |
|
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
CIMConstMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); | CIMConstMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
assert(m1.getType() == CIMTYPE_STRING); | assert(m1.getType() == CIMTYPE_STRING); |
</pre> | </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 |
/** |
|
Gets the class in which this method was defined. This information |
is normally available with methods that are part of a schema | is normally available with methods that are part of a schema |
returned from a CIM Server. | returned from a CIM Server. |
@return CIMName containing the classOrigin attribute. | @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 |
/** |
|
Tests the propagated attribute of the object. The propagated |
attribute indicates whether this method was propagated from a | attribute indicates whether this method was propagated from a |
higher-level class. Normally this attribute is set as part of | higher-level class. Normally this attribute is set as part of |
defining a method in the context of a schema. It is set in | defining a method in the context of a schema. It is set in |
methods retrieved from a CIM Server. | methods retrieved from a CIM Server. |
@return True if method is propagated; otherwise, false. | @return True if method is propagated; otherwise, false. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
*/ | */ |
Boolean getPropagated() const; | Boolean getPropagated() const; |
| |
/** Searches for a qualifier with the specified input name. |
/** |
@param name CIMName of the qualifier to be found. |
Finds a qualifier by name. |
@return Zero origin index of the qualifier found or PEG_NOT_FOUND |
|
if not found. |
|
@exception UninitializedObjectException Thrown if the object is not |
|
initialized. |
|
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); | CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
|
CIMConstMethod m2(m1); | CIMConstMethod m2(m1); |
assert(m2.findQualifier(CIMName ("stuff")) != PEG_NOT_FOUND); | assert(m2.findQualifier(CIMName ("stuff")) != PEG_NOT_FOUND); |
</pre> | </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; |
| |
/** Gets the CIMQualifier defined by the input parameter. |
/** |
@param index Zero origin index of the qualifier requested. |
Gets the qualifier at the specified index. |
@return CIMQualifier object representing the qualifier found. |
|
@exception IndexOutOfBoundsException Thrown if the index is |
|
outside the range of parameters available from the CIMMethod. |
|
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); | CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
|
CIMQualifier q = m2.getQualifier(posQualifier); | CIMQualifier q = m2.getQualifier(posQualifier); |
} | } |
</pre> | </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; | CIMConstQualifier getQualifier(Uint32 index) const; |
| |
/** Returns the number of Qualifiers attached to this CIMConstMethod |
/** |
object. |
Gets the number of qualifiers in the method. |
@return The number of qualifiers attached to the CIM method. |
|
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); | CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
|
|
CIMConstMethod m2(m1); | CIMConstMethod m2(m1); |
assert(m2.getQualifierCount() == 2); | assert(m2.getQualifierCount() == 2); |
</pre> | </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 the parameter with the specified name. |
/** |
@param name CIMName of parameter to be found. |
Finds a parameter by name. |
@return Index of the parameter object found or PEG_NOT_FOUND |
|
if the property is not found. |
|
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
Uint32 posParameter; | Uint32 posParameter; |
|
|
if (posParameter != PEG_NOT_FOUND) | if (posParameter != PEG_NOT_FOUND) |
... | ... |
</pre> | </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; |
| |
/** Gets the parameter defined by the specified index. |
/** |
@param index Index for the parameter to be returned. |
Gets the parameter at the specified index. |
@return CIMConstParameter object requested. |
|
@exception IndexOutOfBoundsException Thrown if the index is outside |
|
the range of available parameters. |
|
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
CIMConstParameter cp; | CIMConstParameter cp; |
|
|
cp = m1.getParameter(parameterIndex); | cp = m1.getParameter(parameterIndex); |
} | } |
</pre> | </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; | CIMConstParameter getParameter(Uint32 index) const; |
| |
/** Gets the count of Parameters defined in the CIMMethod. |
/** |
@return Count of the number of parameters attached to the CIMMethod. |
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; |
| |
/** Determines if the object has not been initialized. |
/** |
@return True if the object has not been initialized; |
Determines whether the object has been initialized. |
otherwise, false. |
|
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
CIMConstMethod m1; | CIMConstMethod m1; |
assert(m1.isUninitialized()); | assert(m1.isUninitialized()); |
</pre> | </pre> |
|
@return True if the object has not been initialized, false otherwise. |
*/ | */ |
Boolean isUninitialized() const; | Boolean isUninitialized() const; |
| |
/** Compares with a CIMConstMethod. |
/** |
@param x CIMConstMethod object for the method to be compared. |
Compares the method with another method. |
@return True if this method is identical to the one specified; |
|
otherwise, false. |
|
<p><b>Example:</b> | <p><b>Example:</b> |
<pre> | <pre> |
CIMConstMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); | CIMConstMethod m1(CIMName ("getHostName"), CIMTYPE_STRING); |
CIMConstMethod m2(CIMName ("test"), CIMTYPE_STRING); | CIMConstMethod m2(CIMName ("test"), CIMTYPE_STRING); |
assert(!m1.identical(m2)); | assert(!m1.identical(m2)); |
</pre> | </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 clone (deep copy) of this CIMConstMethod. This creates |
/** |
a new copy of all of the components of the method including |
Makes a deep copy of the method. This creates a new copy |
parameters and qualifiers. |
of all the method attributes including parameters and qualifiers. |
@return Independent copy of the CIMConstMethod object. Note that |
@return A CIMMethod object with a separate copy of the |
the copy is a non-constant CIMMethod. |
CIMConstMethod object. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
*/ | */ |
CIMMethod clone() const; | CIMMethod clone() const; |
| |