version 1.27, 2002/05/31 04:02:09
|
version 1.32, 2002/07/30 16:14:53
|
|
|
//%///////////////////////////////////////////////////////////////////////////// | //%///////////////////////////////////////////////////////////////////////////// |
// | // |
// Copyright (c) 2000, 2001 The Open group, BMC Software, Tivoli Systems, IBM |
// Copyright (c) 2000, 2001, 2002 BMC Software, Hewlett-Packard Company, IBM, |
|
// The Open Group, Tivoli Systems |
// | // |
// 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 |
|
|
#define Pegasus_Object_h | #define Pegasus_Object_h |
| |
#include <Pegasus/Common/Config.h> | #include <Pegasus/Common/Config.h> |
|
#include <Pegasus/Common/Linkage.h> |
#include <Pegasus/Common/String.h> | #include <Pegasus/Common/String.h> |
|
#include <Pegasus/Common/CIMName.h> |
#include <Pegasus/Common/Array.h> | #include <Pegasus/Common/Array.h> |
#include <Pegasus/Common/CIMProperty.h> | #include <Pegasus/Common/CIMProperty.h> |
#include <Pegasus/Common/CIMQualifier.h> | #include <Pegasus/Common/CIMQualifier.h> |
|
|
| |
/** Accessor for ClassName component of the object. | /** Accessor for ClassName component of the object. |
@return - Returns the ClassName of the object in | @return - Returns the ClassName of the object in |
a String parameter. |
a CIMName parameter. |
<pre> | <pre> |
String className; |
CIMName className; |
CIMClass myclass("myclass", "superclass"); | CIMClass myclass("myclass", "superclass"); |
className = myclass.getClassName; | className = myclass.getClassName; |
</pre> | </pre> |
*/ | */ |
const String& getClassName() const; |
const CIMName& getClassName() const; |
| |
const CIMObjectPath& getPath() const; | const CIMObjectPath& getPath() const; |
| |
|
|
/** addQualifier - Adds the CIMQualifier object to the instance. | /** addQualifier - Adds the CIMQualifier object to the instance. |
Thows an exception of the CIMQualifier already exists in the instance | Thows an exception of the CIMQualifier already exists in the instance |
@param CIMQualifier object to add to instance | @param CIMQualifier object to add to instance |
@return ATTN: |
@return the resulting object. |
@exception Throws AlreadyExists. | @exception Throws AlreadyExists. |
*/ | */ |
CIMObject& addQualifier(const CIMQualifier& qualifier); | CIMObject& addQualifier(const CIMQualifier& qualifier); |
| |
/** findQualifier - Searches the instance for the qualifier object | /** findQualifier - Searches the instance for the qualifier object |
defined by the input parameter. | defined by the input parameter. |
@param String defining the qualifier object to be found. |
@param CIMName defining the qualifier object to be found. |
@return - Position of the qualifier to be used in subsequent | @return - Position of the qualifier to be used in subsequent |
operations or PEG_NOT_FOUND if the qualifier is not found. | operations or PEG_NOT_FOUND if the qualifier is not found. |
*/ | */ |
Uint32 findQualifier(const String& name) const; |
Uint32 findQualifier(const CIMName& name) const; |
|
|
/** existsQualifier - Searches the instance for the qualifier object |
|
defined by the input parameter. |
|
@param String defining the qualifier object to be found. |
|
@return - Returns True if the qualifier object exists or false |
|
if the qualifier is not found. |
|
*/ |
|
Boolean existsQualifier(const String& name) const; |
|
| |
/** getQualifier - Retrieves the qualifier object defined by the | /** getQualifier - Retrieves the qualifier object defined by the |
index input parameter. @ index for the qualifier object. | index input parameter. @ index for the qualifier object. |
|
|
@return: Returns qualifier object defined by index. | @return: Returns qualifier object defined by index. |
@exception Throws the OutOfBounds exception if the index | @exception Throws the OutOfBounds exception if the index |
is out of bounds | is out of bounds |
ATTN: What is effect of out of range index??? |
|
ATTN: Is the above statement correct??? |
|
*/ | */ |
CIMConstQualifier getQualifier(Uint32 pos) const; | CIMConstQualifier getQualifier(Uint32 pos) const; |
| |
|
|
parameter to the CIMObject | parameter to the CIMObject |
@param Property Object to be added. See the CIM Property | @param Property Object to be added. See the CIM Property |
class for definition of the property object | class for definition of the property object |
@return ATTN: |
@return the resulting object. |
@exception Throws the exception AlreadyExists if the property | @exception Throws the exception AlreadyExists if the property |
already exists. | already exists. |
*/ | */ |
|
|
/** findProperty - Searches the CIMProperty objects installed in the | /** findProperty - Searches the CIMProperty objects installed in the |
CIMObject for property objects with the name defined by the | CIMObject for property objects with the name defined by the |
input. | input. |
@param String with the name of the property object to be found |
@param CIMName with the name of the property object to be found |
@return Position in the CIM object to the property object if found or | @return Position in the CIM object to the property object if found or |
PEG_NOT_FOUND if no property object found with the name defined by the | PEG_NOT_FOUND if no property object found with the name defined by the |
input. | input. |
*/ | */ |
Uint32 findProperty(const String& name) const; |
Uint32 findProperty(const CIMName& name) const; |
|
|
/** existsProperty - Determines if a property object with the |
|
name defined by the input parameter exists in the class. |
|
@parm String parameter with the property name. |
|
@return True if the property object exists. |
|
*/ |
|
Boolean existsProperty(const String& name) const; |
|
| |
/** getProperty - Gets the CIMProperty object in the CIMObject defined | /** getProperty - Gets the CIMProperty object in the CIMObject defined |
by the input index parameter. | by the input index parameter. |
|
|
@return CIMProperty object corresponding to the index. | @return CIMProperty object corresponding to the index. |
@exception Throws the OutOfBounds exception if the index | @exception Throws the OutOfBounds exception if the index |
is out of bounds | is out of bounds |
|
|
ATTN: What is the effect of out of range? |
|
*/ | */ |
CIMProperty getProperty(Uint32 pos); | CIMProperty getProperty(Uint32 pos); |
| |
|
|
@return CIMProperty object corresponding to the index. | @return CIMProperty object corresponding to the index. |
@exception Throws the OutOfBounds exception if the index | @exception Throws the OutOfBounds exception if the index |
is out of bounds | is out of bounds |
|
|
ATTN: What is the effect of out of range? |
|
*/ | */ |
CIMConstProperty getProperty(Uint32 pos) const; | CIMConstProperty getProperty(Uint32 pos) const; |
| |
|
|
Boolean identical(const CIMConstObject& x) const; | Boolean identical(const CIMConstObject& x) const; |
| |
#ifdef PEGASUS_INTERNALONLY | #ifdef PEGASUS_INTERNALONLY |
/** isNull() - ATTN: */ |
/** isNull() */ |
Boolean isNull() const; | Boolean isNull() const; |
#endif | #endif |
| |
|
|
| |
~CIMConstObject(); | ~CIMConstObject(); |
| |
const String& getClassName() const; |
const CIMName& getClassName() const; |
| |
const CIMObjectPath& getPath() const; | const CIMObjectPath& getPath() const; |
| |
Uint32 findQualifier(const String& name) const; |
Uint32 findQualifier(const CIMName& name) const; |
| |
CIMConstQualifier getQualifier(Uint32 pos) const; | CIMConstQualifier getQualifier(Uint32 pos) const; |
| |
Uint32 getQualifierCount() const; | Uint32 getQualifierCount() const; |
| |
Uint32 findProperty(const String& name) const; |
Uint32 findProperty(const CIMName& name) const; |
| |
CIMConstProperty getProperty(Uint32 pos) const; | CIMConstProperty getProperty(Uint32 pos) const; |
| |