coldbox.system.web.context

Class ExceptionBean

lucee.Component
    extended by coldbox.system.web.context.ExceptionBean

Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com --- I model an Exception

Class Attributes:
  • synchronized : false
    •  
  • accessors : true
    •  
  • persistent : false
    •  
    Property Summary
    type property default serializable required
    any exceptionStruct
          Exception Struct.

    • access = public
    • returntype = any
    		 true false
    any extraInfo
          Extra info for exception tracking.

    • access = public
    • returntype = any
    		 true false
    any extraMessage
          Custom error messages.

    • access = public
    • returntype = any
    		 true false
    Constructor Summary
    init([any errorStruct='[runtime expression]'], [any extraMessage=''], [any extraInfo=''])
          Constructor.
    Method Summary
    any $toString()
         String representation of this error.
    any getDetail()
         Get error detail.
    any getErrNumber()
         Get err number.
    any getErrorCode()
         Get error code.
    string getExceptionStruct()
    any getExtendedInfo()
         Get error extended info.
    string getExtraInfo()
    string getExtraMessage()
    any getLockName()
         Get lock name.
    any getLockOperation()
         Get lock operation.
    struct getMemento()
         Get memento representation.
    any getMessage()
         Get error message.
    any getMissingFileName()
         Get missing file name.
    any getNativeErrorCode()
         Get native error code.
    any getQueryError()
         Get queryError.
    any getSql()
         Get SQL.
    any getSqlState()
         Get SQL State.
    any getStackTrace()
         Get error stackTrace.
    array getTagContext()
         Get error tag context.
    any getTagContextAsString()
         Get tag context as string.
    any getType()
         Get error type.
    any getWhere()
         Get where portion.
    any setExceptionStruct(any exceptionStruct)
    any setExtraInfo(any extraInfo)
    any setExtraMessage(any extraMessage)
    ExceptionBean setMemento(any memento)
         Set Memento.
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init([any errorStruct='[runtime expression]'], [any extraMessage=''], [any extraInfo=''])

    Constructor

    Parameters:
    errorStruct - The CFML error structure
    extraMessage - Custom error messages
    extraInfo - Extra info to store in the error
    Property Detail

    exceptionStruct

    property any exceptionStruct

    Exception Struct

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    extraInfo

    property any extraInfo

    Extra info for exception tracking

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    extraMessage

    property any extraMessage

    Custom error messages

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true
    Method Detail

    $toString

    public any $toString()

    String representation of this error

    getDetail

    public any getDetail()

    Get error detail

    getErrNumber

    public any getErrNumber()

    Get err number

    getErrorCode

    public any getErrorCode()

    Get error code

    getExceptionStruct

    public string getExceptionStruct()

    getExtendedInfo

    public any getExtendedInfo()

    Get error extended info

    getExtraInfo

    public string getExtraInfo()

    getExtraMessage

    public string getExtraMessage()

    getLockName

    public any getLockName()

    Get lock name

    getLockOperation

    public any getLockOperation()

    Get lock operation

    getMemento

    public struct getMemento()

    Get memento representation

    getMessage

    public any getMessage()

    Get error message

    getMissingFileName

    public any getMissingFileName()

    Get missing file name

    getNativeErrorCode

    public any getNativeErrorCode()

    Get native error code

    getQueryError

    public any getQueryError()

    Get queryError

    getSql

    public any getSql()

    Get SQL

    getSqlState

    public any getSqlState()

    Get SQL State

    getStackTrace

    public any getStackTrace()

    Get error stackTrace

    getTagContext

    public array getTagContext()

    Get error tag context

    getTagContextAsString

    public any getTagContextAsString()

    Get tag context as string

    getType

    public any getType()

    Get error type

    getWhere

    public any getWhere()

    Get where portion

    setExceptionStruct

    public any setExceptionStruct(any exceptionStruct)

    Parameters:
    exceptionStruct

    setExtraInfo

    public any setExtraInfo(any extraInfo)

    Parameters:
    extraInfo

    setExtraMessage

    public any setExtraMessage(any extraMessage)

    Parameters:
    extraMessage

    setMemento

    public ExceptionBean setMemento(any memento)

    Set Memento

    Parameters:
    memento - The mento to set