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

The CIMKeyBinding class associates a key name, value, and type.

Documentation

The CIMKeyBinding class associates a key name, value, and type. It is used to represent a key binding in a CIMObjectPath.

Inheritance:

Public Methods

	CIMKeyBinding () Constructs a CIMKeyBinding object with null values
	CIMKeyBinding (const CIMKeyBinding& x) Constructs a CIMKeyBinding object from the value of a specified CIMKeyBinding object.
	CIMKeyBinding (const CIMName& name, const String& value, Type type) Constructs a CIMKeyBinding with a name, value, and type.
	CIMKeyBinding (const CIMName& name, const CIMValue& value) Constructs a CIMKeyBinding with a key name and CIMValue.
	~CIMKeyBinding () Destructs the CIMKeyBinding object
CIMKeyBinding&	operator= (const CIMKeyBinding& x) Assigns the value of the specified CIMKeyBinding object to this object.
const CIMName&	getName () const Gets the key name for the key binding.
void	setName (const CIMName& name) Sets the key name for the key binding.
const String&	getValue () const Gets the key value for the key binding.
void	setValue (const String& value) Sets the key value for the key binding.
Type	getType () const Gets the key type for the key binding.
void	setType (Type type) Sets the key type for the key binding.
Boolean	equal (CIMValue value) Compares the value and type of the key binding with a specified CIMValue.

Public Members

enum	Type The CIMKeyBinding Type corresponds to the CIM-XML key binding definition, in which the CIMType values are mapped into categories

enum Type

The CIMKeyBinding Type corresponds to the CIM-XML key binding definition, in which the CIMType values are mapped into categories

BOOLEAN

Boolean type

STRING

String, Char16, and CIMDateTime types

NUMERIC

Integer and real number types

REFERENCE

CIMObjectPath (reference) type

CIMKeyBinding()

Constructs a CIMKeyBinding object with null values

CIMKeyBinding(const CIMKeyBinding& x)

Constructs a CIMKeyBinding object from the value of a specified CIMKeyBinding object.

Parameters:

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

CIMKeyBinding(const CIMName& name, const String& value, Type type)

Constructs a CIMKeyBinding with a name, value, and type.

Parameters:

name - A CIMName containing the key name.
value - A String value for this key.
type - A CIMKeyBinding::Type specifying the type of this key.

CIMKeyBinding(const CIMName& name, const CIMValue& value)

Constructs a CIMKeyBinding with a key name and CIMValue. The key value and type are taken from the CIMValue. CIM types are converted to key binding types using this mapping:

        boolean - BOOLEAN
        uint8 - NUMERIC
        sint8 - NUMERIC
        uint16 - NUMERIC
        sint16 - NUMERIC
        uint32 - NUMERIC
        sint32 - NUMERIC
        uint64 - NUMERIC
        sint64 - NUMERIC
        real32 - NUMERIC
        real64 - NUMERIC
        char16 - STRING
        string - STRING
        datetime - STRING
        reference - REFERENCE
        

A value of type CIMTYPE_OBJECT cannot be used in a key binding.

Throws:

TypeMismatchException If the type is not a valid key type, false otherwise.

Parameters:

name - A CIMName containing the key name.
value - A CIMValue specifying the value and type of this key.

~CIMKeyBinding()

Destructs the CIMKeyBinding object

CIMKeyBinding& operator=(const CIMKeyBinding& x)

Assigns the value of the specified CIMKeyBinding object to this object.

Parameters:

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

Returns:

A reference to this CIMKeyBinding object.

const CIMName& getName() const

Gets the key name for the key binding.

Returns:

A CIMName containing the key name.

void setName(const CIMName& name)

Sets the key name for the key binding.

Parameters:

name - A CIMName containing the key name.

const String& getValue() const

Gets the key value for the key binding.

Returns:

A String containing the key value.

void setValue(const String& value)

Sets the key value for the key binding.

Parameters:

value - A String containing the key value.

Type getType() const

Gets the key type for the key binding.

Returns:

A CIMKeyBinding::Type containing the key type.

void setType(Type type)

Sets the key type for the key binding.

Parameters:

type - A CIMKeyBinding::Type containing the key type.

Boolean equal(CIMValue value)

Compares the value and type of the key binding with a specified CIMValue.

Parameters:

value - The CIMValue to be compared.

Returns:

True if the value and type of the key binding are the same as the specified CIMValue, false otherwise.

This class has no child classes.

Friends:

class CIMObjectPath

Alphabetic index HTML hierarchy of classes or Java