CIMException Class Reference

#include <Exception.h>

Inheritance diagram for CIMException:
Exception CIMOperationFailedException CIMAccessDeniedException CIMInvalidParameterException CIMMethodNotFoundException CIMNotSupportedException CIMObjectAlreadyExistsException CIMObjectNotFoundException CIMPropertyNotFoundException

List of all members.

Public Member Functions

 CIMException (CIMStatusCode code=CIM_ERR_SUCCESS, const String &message=String::EMPTY)
 CIMException (CIMStatusCode code, const String &message, const CIMInstance &instance)
 CIMException (CIMStatusCode code, const String &message, const Array< CIMInstance > &instances)
 CIMException (const CIMException &cimException)
CIMExceptionoperator= (const CIMException &cimException)
virtual ~CIMException ()
CIMStatusCode getCode () const

Detailed Description

The CIMException class models an error response to a CIM operation.


Constructor & Destructor Documentation

CIMException::CIMException ( CIMStatusCode  code = CIM_ERR_SUCCESS,
const String message = String::EMPTY 
)

Constructs a CIMException with a status code and error description message.

Parameters:
code A CIMStatusCode containing a DMTF defined status code specifying the type of the error
message A message String containing a more specific description of the error
CIMException::CIMException ( CIMStatusCode  code,
const String message,
const CIMInstance instance 
)

Constructs a CIMException with a status code, error description message, and a CIM_Error instance attached to the exception.

Parameters:
code A CIMStatusCode containing a DMTF defined status code specifying the type of the error
message A message String containing a more specific description of the error
instance A CIMInstance containing the CIM_Error instance to be added to the CIMException. This instance is NOT validated for type correctness nor correlation with the specified status code and error description.
CIMException::CIMException ( CIMStatusCode  code,
const String message,
const Array< CIMInstance > &  instances 
)

Constructs a CIMException with a status code, error description message, and an Array of CIM_Error instances attached to the exception.

Parameters:
code A CIMStatusCode containing a DMTF defined status code specifying the type of the error
message A message String containing a more specific description of the error
instances An Array of CIMInstance objects containing the CIM_Error instances to be added to the CIMException. These instances are NOT validated for type correctness nor correlation with the specified status code and error description.
CIMException::CIMException ( const CIMException cimException  ) 

Constructs a CIMException by copying another CIMException object.

Parameters:
cimException The CIMException object to copy
virtual CIMException::~CIMException (  )  [virtual]

Destructs a CIMException object.


Member Function Documentation

CIMStatusCode CIMException::getCode (  )  const

Gets the CIMStatusCode for the current CIMException. This is the code that defines the ERROR that was executed and transmitted to the Client.

Returns:
a single CIMStatusCode
CIMException& CIMException::operator= ( const CIMException cimException  ) 

Assigns the value from a specified CIMException object.

Parameters:
cimException The CIMException object to copy
Returns:
A reference to this CIMException object with the new assignment

Reimplemented from Exception.


The documentation for this class was generated from the following file:
  • /usr/src/startcom/BUILD/pegasus/src/Pegasus/Common/Exception.h