This class provides the interface to construct and manage CIM Parameters.

Documentation

This class provides the interface to construct and manage CIM Parameters. CIM Parameters are the parameters attached to CIMMethods. A CIM Parameter consists of:

• qualifiers - zero or more qualifiers.
• name - The name of the parameter which must be a valid CIM name.
• type - The type for the parameter, one of the inherent CIM types
• value - Which is dependent on the type. The value can be
  • a reference type. In this class the value is a Class reference. This must be a single value
  • an array (fixed or variable number of elements) or a single value with any CIMType other than reference. The input parameters allow specifying these conditions.

ATTN: Define the form of this objec, the rep and what it means.

Inheritance:

Public Methods

	CIMParameter () Construct a NULL CIMParameter object
	CIMParameter (const CIMParameter& x) Construct a CIMParameter from another CIMParameter
	CIMParameter ( const CIMName& name, CIMType type, Boolean isArray = false, Uint32 arraySize = 0, const CIMName& referenceClassName = CIMName()) Constructs a CIMParameter object with properties.
	~CIMParameter () Destroys the object
CIMParameter&	operator= (const CIMParameter& x) Assignment operator.
const CIMName&	getName () const Get the name from the CIMParameter object.
void	setName (const CIMName& name) Set the name field in the object with a valid CIMName
Boolean	isArray () const Test for Array type for this parameter object.
Uint32	getArraySize () const Get the array size for the parameter.
const CIMName&	getReferenceClassName () const
CIMType	getType () const Get the type (CIMTYPE) defined for this parameter.
CIMParameter&	addQualifier (const CIMQualifier& x) Add a single qualifier object to the CIMParameter.
Uint32	findQualifier (const CIMName& name) const Find a qualifier by name.
CIMQualifier	getQualifier (Uint32 index) Get qualifier at index defined by input.
void	removeQualifier (Uint32 index) Removes the CIMQualifier defined by the input parameter.
CIMConstQualifier	getQualifier (Uint32 index) const Get qualifier at index defined by input.
Uint32	getQualifierCount () const Gets the count of qualifiers attached to this CIMParameter.
Boolean	isUninitialized () const Determines if the object has not been initialized.
Boolean	identical (const CIMConstParameter& x) const
CIMParameter	clone () const Creates a deep copy, ie.

CIMParameter()

Construct a NULL CIMParameter object

CIMParameter(const CIMParameter& x)

Construct a CIMParameter from another CIMParameter

Parameters:

- CIMParameter from which the new object is to be constructed

CIMParameter( const CIMName& name, CIMType type, Boolean isArray = false, Uint32 arraySize = 0, const CIMName& referenceClassName = CIMName())

Constructs a CIMParameter object with properties. The Properties Must include name and type and may include the indicator whether this is an array or not, the size of the array and a reference class name.

Throws:

TypeMismatchException Thrown if reference type and referenceClassname is Null.
TypeMismatchException Thrown if arraysize != zero and isArray true.

Parameters:

name - Name of the parameter, a legal CIMName.
type - CIMType defining the CIM Type for this parameter
- isArray Boolean indicating whether this parameter defines an array.
arraySize - Size of the array if this is to be a fixed size array parameter. The default is zero which indicates a variable size array.
referenceClassName - Optional property but required for reference type parameters. This defines the class for the reference.

~CIMParameter()

Destroys the object

CIMParameter& operator=(const CIMParameter& x)

Assignment operator. Assigns one CIMParameter to another CIMParameter

const CIMName& getName() const

Get the name from the CIMParameter object.

Returns:

CIMName containing the name from the object.

void setName(const CIMName& name)

Set the name field in the object with a valid CIMName

Parameters:

name - CIMName to set into the name field.

Boolean isArray() const

Test for Array type for this parameter object.

Returns:

true if the value for this parameter is defined as an array (is array = true).

Uint32 getArraySize() const

Get the array size for the parameter.

Returns:

Uint32 array size.

const CIMName& getReferenceClassName() const

CIMType getType() const

Get the type (CIMTYPE) defined for this parameter. If the parameter is not initialized the type returned is TBD.

Returns:

the type for this parameter defined as a CIMTYPE object.

CIMParameter& addQualifier(const CIMQualifier& x)

Add a single qualifier object to the CIMParameter.

Throws:

AlreadyExistsException if a qualifier with the same name already exists for this CIMParameter.

Parameters:

x - CIMQualifier object to be added.

Uint32 findQualifier(const CIMName& name) const

Find a qualifier by name. Finds a single qualifier based on the name input as parameter and returns an index to the name.

Parameters:

name - CIMName with the name of the qualifier to be found

Returns:

Uint32 with either the index (zero origin) of the parameter that was to be found or the value PEG_NOT_FOUND if no parameter is found with the defined name.

CIMQualifier getQualifier(Uint32 index)

Get qualifier at index defined by input. Gets the qualifier in the array of qualifiers for this parameter defined by the index provided on input.

Throws:

IndexOutOfBoundsException thrown if index outside the array of qualifiers.

Parameters:

index - Specifies the position in the qualifier array of the qualifier to be retrieved

Returns:

CIMQualifier object containing the qualifer defined by the index

void removeQualifier(Uint32 index)

Removes the CIMQualifier defined by the input parameter.

Throws:

IndexOutOfBoundsException if the index is outside the range of qualifiers available for the CIMParameter.
IndexOutOfBoundsException thrown if index outside the array of qualifiers.

Parameters:

index - Index of the qualifier to be removed.

CIMConstQualifier getQualifier(Uint32 index) const

Get qualifier at index defined by input. Gets the qualifier in the array of qualifiers for this parameter defined by the index provided on input.

Throws:

IndexOutOfBoundsException thrown if index outside the array of qualifiers.

Parameters:

index - Specifies the position in the qualifier array of the qualifier to be retrieved

Returns:

CIMQualifier object containing the qualifer defined by the index

Uint32 getQualifierCount() const

Gets the count of qualifiers attached to this CIMParameter.

Returns:

count of number of qualifiers that have been added to this CIMparameter.

loop to access all qualifiers in a CIMparameter
CIMParameter parm;
....                build the parameter
for (Uint32 i = 0 ; i < parm.getQualifierCount() ; i++
....

Boolean isUninitialized() const

Determines if the object has not been initialized. A CIM parameter is intialized only when the name and type fields have been set either on construction or through the set functions.

Returns:

true if the object has not been initialized, false otherwise.

Boolean identical(const CIMConstParameter& x) const

CIMParameter clone() const

Creates a deep copy, ie. a clone, of the associated object.

Returns:

The deep copy of the associated object.

This class has no child classes.

Friends:

class CIMConstParameter
class Resolver
class XmlWriter
class MofWriter
class BinaryStreamer

Alphabetic index HTML hierarchy of classes or Java