CIMException Class Reference

#include <Exception.h>

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

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
 
- Public Member Functions inherited from Exception
 Exception (const String &message)
 
 Exception (const Exception &exception)
 
virtual ~Exception ()
 
Exceptionoperator= (const Exception &exception)
 
virtual const StringgetMessage () const
 

Additional Inherited Members

- Protected Member Functions inherited from Exception
 Exception ()
 
- Protected Attributes inherited from Exception
ExceptionRep * _rep
 

Detailed Description

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

Constructor & Destructor Documentation

◆ CIMException() [1/4]

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

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

Parameters
codeA CIMStatusCode containing a DMTF defined status code specifying the type of the error
messageA message String containing a more specific description of the error

◆ CIMException() [2/4]

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
codeA CIMStatusCode containing a DMTF defined status code specifying the type of the error
messageA message String containing a more specific description of the error
instanceA 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() [3/4]

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
codeA CIMStatusCode containing a DMTF defined status code specifying the type of the error
messageA message String containing a more specific description of the error
instancesAn 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() [4/4]

CIMException::CIMException ( const CIMException cimException)

Constructs a CIMException by copying another CIMException object.

Parameters
cimExceptionThe CIMException object to copy

◆ ~CIMException()

virtual CIMException::~CIMException ( )
virtual

Destructs a CIMException object.

Member Function Documentation

◆ getCode()

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

◆ operator=()

CIMException& CIMException::operator= ( const CIMException cimException)

Assigns the value from a specified CIMException object.

Parameters
cimExceptionThe CIMException object to copy
Returns
A reference to this CIMException object with the new assignment

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