Pegasus CIM Object Broker Documentation

Contents

Introduction
Objectives
Overview
Credits
Pegasus Architecture
Design Goals
The Broker
Pegasus Providers.
Extension Services
Pegasus Clients.
Functional Flow
Pegasus Components
Component Descriptions
Pegasus Directory Structure
Pegasus Utilization
Pegasus Availability
Pegasus Installation
Pegasus Operation
Pegasus CIM Clients
Pegasus Providers
Pegasus MOF Compiler
Programming Pegasus
CIM Objects in Pegasus
CIM Object Table
Class Definitions
Pegasus Interfaces
CIM Operations over HTTP
Pegasus Client Interfaces
Pegasus Provider Interfaces
Pegasus Service Extension Interfaces
Repository Interfaces
Writing Providers.
Glossary
Pegasus Code Examples
Client Examples
Client Coding Examples
Provider Coding Examples
Document References
Pegausus FAQ

• Alphabetic index
• Hierarchy of classes

A CIMQualifierDecl represents a DMTF standard CIM qualifier declaration.

Documentation

A CIMQualifierDecl represents a DMTF standard CIM qualifier declaration. A CIMQualifierDecl differs from a CIMQualifier in that it has a scope attribute. A CIMQualifierDecl defines a qualifier, whereas a CIMQualifier applies the qualifier.

The CIMQualifierDecl class uses a shared representation model, such that multiple CIMQualifierDecl 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 CIMQualifierDecl object affects all the CIMQualifierDecl objects that refer to the same data copy. The data remains valid until all the CIMQualifierDecl objects that refer to it are destructed. A separate copy of the data may be created using the clone method.

Inheritance:

Public Methods

	CIMQualifierDecl () Constructs an uninitialized CIMQualifierDecl object.
	CIMQualifierDecl (const CIMQualifierDecl& x) Constructs a CIMQualifierDecl object from the value of a specified CIMQualifierDecl object, so that both objects refer to the same data copy.
	CIMQualifierDecl ( const CIMName& name, const CIMValue& value, const CIMScope & scope, const CIMFlavor & flavor = CIMFlavor (CIMFlavor::DEFAULTS), Uint32 arraySize = 0) Constructs a CIMQualifierDecl object with the specified attributes.
	~CIMQualifierDecl () Destructs the CIMQualifierDecl object
CIMQualifierDecl&	operator= (const CIMQualifierDecl& x) Assigns the value of the specified CIMQualifierDecl object to this object, so that both objects refer to the same data copy.
const CIMName&	getName () const Gets the name of the qualifier.
void	setName (const CIMName& name) Sets the qualifier name.
CIMType	getType () const Gets the qualifier type.
Boolean	isArray () const Checks whether the qualifier is an Array qualifier.
const CIMValue&	getValue () const Gets the qualifier default value.
void	setValue (const CIMValue& value) Sets the qualifier default value.
const CIMScope&	getScope () const Gets the qualifier scope.
const CIMFlavor&	getFlavor () const Gets the qualifier flavors.
Uint32	getArraySize () const Gets the array size for the qualifier.
Boolean	isUninitialized () const Determines whether the object has been initialized.
Boolean	identical (const CIMConstQualifierDecl& x) const Compares the qualifier declaration with another qualifier declaration.
CIMQualifierDecl	clone () const Makes a deep copy of the qualifier declaration.

CIMQualifierDecl()

Constructs an uninitialized CIMQualifierDecl 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.

CIMQualifierDecl(const CIMQualifierDecl& x)

Constructs a CIMQualifierDecl object from the value of a specified CIMQualifierDecl object, so that both objects refer to the same data copy.

Parameters:

x - The CIMQualifierDecl object from which to construct a new CIMQualifierDecl object.

CIMQualifierDecl( const CIMName& name, const CIMValue& value, const CIMScope & scope, const CIMFlavor & flavor = CIMFlavor (CIMFlavor::DEFAULTS), Uint32 arraySize = 0)

Constructs a CIMQualifierDecl object with the specified attributes.

Throws:

UninitializedObjectException If the qualifier name is null.

Parameters:

name - A CIMName specifying the name of the qualifier.
value - A CIMValue specifying the default qualifier value, and implicitly defining the qualifier type and whether the qualifier is an Array qualifier.
scope - A CIMScope indicating the qualifier scope.
flavor - A CIMFlavor indicating the qualifier flavors.
arraySize - A Uint32 indicating the size of the Array, if the qualifier is an Array qualifier. The default value of zero indicates a variable size array.

~CIMQualifierDecl()

Destructs the CIMQualifierDecl object

CIMQualifierDecl& operator=(const CIMQualifierDecl& x)

Assigns the value of the specified CIMQualifierDecl object to this object, so that both objects refer to the same data copy.

Parameters:

x - The CIMQualifierDecl object from which to assign this CIMQualifierDecl object.

Returns:

A reference to this CIMQualifierDecl object.

const CIMName& getName() const

Gets the name of the qualifier.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

A CIMName containing the name of the qualifier.

void setName(const CIMName& name)

Sets the qualifier name.

Throws:

UninitializedObjectException If the object is not initialized.

Parameters:

name - A CIMName containing the new name of the qualifier.

CIMType getType() const

Gets the qualifier type.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

A CIMType containing the qualifier type.

Boolean isArray() const

Checks whether the qualifier is an Array qualifier.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

True if the qualifier is an Array qualifier, false otherwise.

const CIMValue& getValue() const

Gets the qualifier default value.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

A CIMValue containing the qualifier default value.

void setValue(const CIMValue& value)

Sets the qualifier default value.

Throws:

UninitializedObjectException If the object is not initialized.

Parameters:

value - A CIMValue containing the new default value of the qualifier.

const CIMScope& getScope() const

Gets the qualifier scope.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

A CIMScope containing the qualifier scope.

const CIMFlavor& getFlavor() const

Gets the qualifier flavors.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

A CIMFlavor containing the qualifier flavor settings.

Uint32 getArraySize() const

Gets the array size for the qualifier.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

Uint32 array size.

Boolean isUninitialized() const

Determines whether the object has been initialized.

Returns:

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

Boolean identical(const CIMConstQualifierDecl& x) const

Compares the qualifier declaration with another qualifier declaration.

Throws:

UninitializedObjectException If either of the objects is not initialized.

Parameters:

x - The CIMConstQualifierDecl to be compared.

Returns:

True if this qualifier declaration is identical to the one specified, false otherwise.

CIMQualifierDecl clone() const

Makes a deep copy of the qualifier declaration. This creates a new copy of all the qualifier declaration attributes.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

A new copy of the CIMQualifierDecl object.

This class has no child classes.

Friends:

class CIMConstQualifierDecl
class CIMClassRep
class XmlWriter
class MofWriter

Alphabetic index HTML hierarchy of classes or Java