cimerror.h

Pegasus is an open-source implementationof the DMTF CIM and WBEM standards. It is designed to be por

    /** Enumeration of possible values for the
        CIMStatus Code Property of the CIM_Error Class
    */
    enum CIMStatusCodeEnum
    {
        CIM_STATUS_CODE_CIM_ERR_FAILED = 1,
        CIM_STATUS_CODE_CIM_ERR_ACCESS_DENIED = 2,
        CIM_STATUS_CODE_CIM_ERR_INVALID_NAMESPACE = 3,
        CIM_STATUS_CODE_CIM_ERR_INVALID_PARAMETER = 4,
        CIM_STATUS_CODE_CIM_ERR_INVALID_CLASS = 5,
        CIM_STATUS_CODE_CIM_ERR_NOT_FOUND = 6,
        CIM_STATUS_CODE_CIM_ERR_NOT_SUPPORTED = 7,
        CIM_STATUS_CODE_CIM_ERR_CLASS_HAS_CHILDREN = 8,
        CIM_STATUS_CODE_CIM_ERR_CLASS_HAS_INSTANCES = 9,
        CIM_STATUS_CODE_CIM_ERR_INVALID_SUPERCLASS = 10,
        CIM_STATUS_CODE_CIM_ERR_ALREADY_EXISTS = 11,
        CIM_STATUS_CODE_CIM_ERR_NO_SUCH_PROPERTY = 12,
        CIM_STATUS_CODE_CIM_ERR_TYPE_MISMATCH = 13,
        CIM_STATUS_CODE_CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED = 14,
        CIM_STATUS_CODE_CIM_ERR_INVALID_QUERY = 15,
        CIM_STATUS_CODE_CIM_ERR_METHOD_NOT_AVAILABLE = 16,
        CIM_STATUS_CODE_CIM_ERR_METHOD_NOT_FOUND = 17,
        CIM_STATUS_CODE_CIM_ERR_UNEXPECTED_RESPONSE = 18,
        CIM_STATUS_CODE_CIM_ERR_INVALID_RESPONSE_DESTINATION = 19,
        CIM_STATUS_CODE_CIM_ERR_NAMESPACE_NOT_EMPTY = 20
    };

    /** Default constructor creates a single CIMInstance representing the
        CIM_Error.  It builds in all of the properties in a CIM_Error and
        sets them to NULL.
    */
    CIMError();

    /** Constructor for minimum legal CIM_Error instance.  Requires input of
        all of the properties defined as required properties for CIM_Error.
        @param messageID String
        @param message String
        @param perceivedSeverity PerceivedSeverityEnum
        @param probableCause ProbableCauseEnum
        @param cimStatusCode CIMStatusCodeEnum
        @exceptions TBD
        <p><b>example</b>
        CIMError err1(PegasusOwningEntityName,
                  "MessageIDString",
                  "Text Of Message",
                  CIMError::PERCEIVED_SEVERITY_LOW,
                  CIMError::PROBABLE_CAUSE_UNEXPECTED_INFORMATION,
                  CIMError::CIM_STATUS_CODE_CIM_ERR_FAILED);
    */
    CIMError(const String& owningEntity,
             const String& messageID,
             const String& message,
             const PerceivedSeverityEnum& perceivedSeverity,
             const ProbableCauseEnum& probableCause,
             const CIMStatusCodeEnum& cimStatusCode);

    /** Copy constructor.
    */
    CIMError(const CIMError& x);

    /** Destructor.
    */
    ~CIMError();

    /** Accessor for the ErrorType property value in a CIM_Error
        Instance.
        @param value ErrorTypeEnum that is the current value of
        the Property in the CIM_Error Instance.
        @return bool returns true if the property is NOT Null.
        returns false the value of the property is Null.
        This value should be tested before accessing the returned
        value because the returned value will be invalid if
        the variable is null.
        @exception Generates CIM_ERR_TYPE_MISMATCH exception
        if property missing
        */
    bool getErrorType(ErrorTypeEnum& value) const;

    /** Modify the ErrorType property value for the CIM_Error
        instance.
        @ param value ErrorTypeEnum representing the value to be
        set in the property.  if the null property equals true,
        this value is ignored.
        @param null boolean that is defaulted to false. If set
        true, this causes the property to be set to NULL, overriding
        any value in the property.
        @exception Generates exceptions if missing
    */
    void setErrorType(ErrorTypeEnum value, bool null = false);

    /** Accessor for the OwningEntity property value in a CIM_Error
        Instance.
        @param value String that is the current value of
        the ErrorType Property in the CIM_Error Instance.
        @return bool returns true if the property is NOT Null.
        returns false the value of the property is Null.
        This value should be tested before accessing the returned
        value because the returned value will be invalid if
        the variable is null.
        @exception Generates CIM_ERR_TYPE_MISMATCH exception
        if property missing
     */
    bool getOwningEntity(String& value) const;

    /** Modify the OwningEntity property value for the CIM_Error
        instance.
        @ param value String representing the value to be
        set in the property.  If the null property equals true,
        this value is ignored.
        @param null boolean that is defaulted to zero. If set
        true, this causes the property to be set to NULL, overriding
        any value in the property.
        @exception Generates exceptions if TBD
    */
    void setOwningEntity(const String& value, bool null = false);

    /** Accessor for the OtherErrorType property value in a CIM_Error
        Instance.
        @param value String that is the current value of
        the OtherErrorType Property in the CIM_Error Instance.
        @return bool returns true if the property is NOT Null.
        returns false the value of the property is Null.
        This value should be tested before accessing the returned
        value because the returned value will be invalid if
        the variable is null.
        @exception Generates CIM_ERR_TYPE_MISMATCH exception
        if property missing
     */
    bool getOtherErrorType(String& value) const;

    /** Modify the OtherErrorType property value for the CIM_Error
        instance.
        @param value String representing the value to be
        set in the property.  If the null property equals true,
        this value is ignored.
        @param null bool Sets the property to null if this parameter
        is true, overriding any property value setting.
        @exception Generates exceptions if TBD
    */
    void setOtherErrorType(const String& value, bool null = false);

    /** Accessor for the MessageID property value in a CIM_Error
        Instance.
        @param value String that is the current value of
        the MessageID Property in the CIM_Error Instance.
        @return bool returns true if the property has a legitimate value
        (is NOT Null).
        It returns false if the value of the property is Null.
        This value should be tested before accessing the returned
        value because the returned value will be invalid if
        the variable is null.
        @exception Generates CIM_ERR_TYPE_MISMATCH exception
        if property missing
     */
    bool getMessageID(String& value) const;

    /** Modify the MessageID property value for the CIM_Error
        instance.
        @ param value String representing the value to be
        set in the property.  If the null property equals true,
        this value is ignored.
        @param null boolean that is defaulted to zero. If set
        true, this causes the property to be set to NULL, overriding
        any value in the property.
    */
    void setMessageID(const String& value, bool null = false);

    /** Accessor for the Message property value in a CIM_Error
        Instance.
        @param value String that is the current value of
        the MessageID Property in the CIM_Error Instance.
        @return bool returns true if the property has a legitimate value
        (is NOT Null).
        It returns false if the value of the property is Null.
        This value should be tested before accessing the returned
        value because the returned value will be invalid if
        the variable is null.
        @exception Generates CIM_ERR_TYPE_MISMATCH exception
        if property missing
     */
    bool getMessage(String& value) const;

    /** Modify the Message property value for the CIM_Error
        instance.
        @ param value String representing the value to be
        set in the property.  If the null property equals true,
        this value is ignored.
        @param null boolean that is defaulted to zero. If set
        true, this causes the property to be set to NULL, overriding
        any value in the property.
    */
    void setMessage(const String& value, bool null = false);

    /** Accessor for the MessageArguments property value in a CIM_Error
        Instance.
        @param value Array<String> that is the current value of
        the MessageArguments Array Property in the CIM_Error Instance.
        @return bool returns true if the property has a legitimate value
        (is NOT Null).
        It returns false if the value of the property is Null.
        This value should be tested before accessing the returned
        value because the returned value will be invalid if
        the variable is null.
        @exception Generates CIM_ERR_TYPE_MISMATCH exception
        if property missing
     */
    bool getMessageArguments(Array<String>&  value) const;

    /** Modify the MessageArguments property value for the CIM_Error
        instance.
        @ param value Array<String> representing the value to be
        set in the property.  If the null property equals true,
        this value is ignored.
        @param null boolean that is defaulted to zero. If set
        true, this causes the property to be set to NULL, overriding
        any value in the property.
    */
    void setMessageArguments(const Array<String>& value, bool null = false);

    /** Accessor for the PerceivedSeverity property value in a CIM_Error
        Instance.
        @param value PerceivedSeverityEnum that is the current value of
        the MessageArguments Array Property in the CIM_Error Instance.
        @return bool returns true if the property has a legitimate value
        (is NOT Null).
        It returns false if the value of the property is Null.
        This value should be tested before accessing the returned
        value because the returned value will be invalid if
        the variable is null.
        @exception Generates CIM_ERR_TYPE_MISMATCH exception
        if property missing
     */
    bool getPerceivedSeverity(PerceivedSeverityEnum& value) const;

    /** Modify the PerceivedSeverity property value for the CIM_Error
        instance.
        @ param value PerceivedSeverityEnum representing the value to be
        set in the property.  If the null property equals true,
        this value is ignored.
        @param null boolean that is defaulted to zero. If set
        true, this causes the property to be set to NULL, overriding
        any value in the property.
    */
    void setPerceivedSeverity(PerceivedSeverityEnum value, bool null = false);

    /** Accessor for the ProbableCause property value in a CIM_Error
        Instance.
        @param value ProbableCauseEnum that is the current value of