cimerror.h

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

        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 getProbableCause(ProbableCauseEnum& value) const;

    /** Modify the ProbableCause property value for the CIM_Error
        instance.
        @ param value ProbableCauseEnum 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 setProbableCause(ProbableCauseEnum value, bool null = false);

    /** Accessor for the ProbableCauseDescription property value in a
        CIM_Error Instance.
        @param value ProbableCauseEnumDescription 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 getProbableCauseDescription(String& value) const;

    /** Modify the ProbableCauseDescription property value for the CIM_Error
        instance.
        @ param value ProbableCauseEnumDescription 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 setProbableCauseDescription(const String& value, bool null = false);

    /** Accessor for the RecommendedActions property value in a
        CIM_Error Instance.
        @param value Array<String> that is the current value of
        the RecommendedActions 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 getRecommendedActions(Array<String>& value) const;

    /** Modify the RecommendedActions property value for the CIM_Error
      String  instance.
        @ param value Array<String> representing the values 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 setRecommendedActions(const Array<String>& value, bool null = false);

    /** Accessor for the ErrorSource property value in a
        CIM_Error Instance.
        @param value String that is the current value of
        the RecommendedActions 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 getErrorSource(String& value) const;

    /** Modify the ErrorSource property value for the CIM_Error
        instance.
        @ param value String representing the values 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 setErrorSource(const String& value, bool null = false);

    /** Accessor for the ErrorSourceFormat property value in a
        CIM_Error Instance.
        @param value ErrorSourceFormatEnum that is the current value of
        the RecommendedActions 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 getErrorSourceFormat(ErrorSourceFormatEnum& value) const;

    /** Modify the ErrorSourceFormat property value for the CIM_Error
        instance.
        @ param value String representing the values to be
        set in the property.  If the null property is true,
        this value should be 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 setErrorSourceFormat(ErrorSourceFormatEnum value, bool null = false);

    /** Accessor for the OtherErrorSourceFormat property value in a
        CIM_Error Instance.
        @param value String that is the current value of
        the OtherErrorSourceFormat 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 getOtherErrorSourceFormat(String& value) const;

    /** Modify the OtherErrorSourceFormat property value for the
        CIM_Error instance.
        @ param value String representing the values to be
        set in the property.  If the null property is true,
        this value should be 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 setOtherErrorSourceFormat(const String& value, bool null = false);

    /** Accessor for the CIMStatusCode property value in a
        CIM_Error Instance.
        @param value CIMStatusCodeEnum that is the current value of
        the CIMStatusCode 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 getCIMStatusCode(CIMStatusCodeEnum& value) const;

    /** Modify the CIMStatusCode property value for the
        CIM_Error instance.
        @ param value String representing the values to be
        set in the property.  If the null property is true,
        this value should be 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 setCIMStatusCode(CIMStatusCodeEnum value, bool null = false);

    /** Accessor for the CIMStatusCode property value in a
        CIM_Error Instance.
        @param value String that is the current value of
        the CIMStatusCode 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 getCIMStatusCodeDescription(String& value) const;

    /** Modify the CIMStatusCodeDescription property value for the
        CIM_Error instance.
        @ param value String representing the values to be
        set in the property.  If the null property is true,
        this value should be 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 setCIMStatusCodeDescription(const String& value, bool null = false);

    /** Get reference to internal CIMInstance.  This function tests the
        properties for validy and to assure that all properties that are
        required in the mof are in the CIMInstance
        @return CIMInstance with the target CIM_Error
        <p><b>example</b>
            CIM_Error err1;
            CIM_Error err2;
            err1.setProbableCause(PROBABLE_CAUSE_ADAPTER_CARD_ERROR);
            err2.setInstance(err1.getInstance());
    */

    const CIMInstance& getInstance() const;

    /** Set the internal instance (and throw an exception if instance
        argument has an incompatible property types). This function tests the
        properties for validy and to assure that all properties that are
        required in the mof are in the CIMInstance.
        @param instance CIMInstance which is the CIM_Error

        @exception  CIMExceptions TypeMismatchException if there is a
        property type mismatch and NoSuchPropertyException
        if a required property is missing.
        <p><b>example</b>
            CIM_Error err1;
            CIMInstance instance1 err1.getInstance();
    */
    const void setInstance(const CIMInstance& instance);

    /** Print this object to standard output. This is a diagnostic outut
        and the exact format of the output cannot be depended on.  It prints
        the name and value of each property in the CIM_Error instance.
    */
    void print() const;

private:

    CIMInstance _inst;
};

PEGASUS_NAMESPACE_END

#endif /* Pegasus_CIMError_h */