com.apama.utils
Event Error


Generic Error event.
Since:
CMF 5.1.0

Action summary
 stringgetMessage()

Get the error message as a free form string.
 com.apama.utils.ParamsgetParams()

Get the parameters of this error as a reference.
 integergetType()

Get the type of this error.
 voidsetMessage(string message)

Set the error message as a free form string.
 voidsetParams(com.apama.utils.Params params)

Set the parameters of this error as a reference to the supplied params.
 voidsetType(integer type)

Set the type of this error.
 
Action detail

getMessage

            string getMessage()
        
Get the error message as a free form string.
Returns:
The error message

getParams

            com.apama.utils.Params getParams()
        
Get the parameters of this error as a reference.

NOTE: This returns a reference to the stored params so any changes to the returned params event will be reflected in the error event. You can clone() the params when returned if you require.
Returns:
The params of the error

getType

            integer getType()
        
Get the type of this error.
Returns:
The Type of the error

setMessage

            void setMessage(string message)
        
Set the error message as a free form string.
Parameters:
message - The error message

setParams

            void setParams(com.apama.utils.Params params)
        
Set the parameters of this error as a reference to the supplied params.

NOTE: The Error event will store a reference to the params so any changes to the supplied params event will be reflected in the error event. You can clone() the params when passed in if you require.
Parameters:
params - The params of the error

setType

            void setType(integer type)
        
Set the type of this error.
Parameters:
type - The type of the error