com.apama.firewall
Event ErrorConstants


The Consts event object contains a set of constants that are used for the generic error handling in the Risk Firewall. These constants should be used rather than the specific value in order to ensure future compatibility.
Constant summary
 constant integerCUSTOM_ERROR_TYPE_START := 1000

This constant value defines the value where custom error for the Risk Firewall can start.
 constant stringERROR_CALLBACK_ID := "ERROR_CALLBACK_ID"

This constant value defines the error key name that is used in the error params when an error occurs. This indicates the value will be the identifier of the error callback that was registered with the Risk Firewall.
 constant stringERROR_SUBTYPE := "ERROR_SUBTYPE"

This constant value defines the error key name that is used in the error params to indicate a error subType.
 constant integerFAILED_TO_ADD_RULE_INSTANCE := 4

This constant value defines the error type that is used when an error occurs whilst adding a Rule Class instance to the Risk Firewall.
 constant integerFAILED_TO_CREATE_RISKFIREWALL_INTERFACE := 1

This constant value defines the error type that is used when an error occurs whilst creating the Risk Firewall.
 constant integerFAILED_TO_LOCK_FIREWALL := 16

This constant value defines the error type that is used when the application attempts to lock the Risk Firewall from a remotely connected interface.
 constant integerFAILED_TO_MODIFY_RULE_INSTANCE := 5

This constant value defines the error type that is used when an error occurs whilst modifying a Rule Class instance in the Risk Firewall.
 constant integerFAILED_TO_OVERRIDE_SOFT_REJECT := 25

This constant value defines the error type that is used when an error occurs whilst overriding a Soft-Rejected order in the Risk Firewall.
 constant integerFAILED_TO_REGISTER_RULE_CLASS := 3

This constant value defines the error type that is used when an error occurs whilst registering a Rule Class with the Risk Firewall.
 constant integerFAILED_TO_REMOVE_ACCEPTEDAMENDCB := 19

This constant value defines the error type that is used when an error occurs whilst removing an accepted AmendOrder callback from the Risk Firewall.
 constant integerFAILED_TO_REMOVE_ACCEPTEDCANCELCB := 20

This constant value defines the error type that is used when an error occurs whilst removing an accepted CancelOrder callback from the Risk Firewall.
 constant integerFAILED_TO_REMOVE_ACCEPTEDORDERCB := 18

This constant value defines the error type that is used when an error occurs whilst removing an accepted NewOrder callback from the Risk Firewall.
 constant integerFAILED_TO_REMOVE_ERROR_CALLBACK := 2

This constant value defines the error type that is used when an error occurs whilst removing an error callback from the Risk Firewall.
 constant integerFAILED_TO_REMOVE_LOCKNOTIFICATIONCB := 8

This constant value defines the error type that is used when an error occurs whilst removing a Query Response callback from the Risk Firewall.
 constant integerFAILED_TO_REMOVE_ORDERUPDATECB := 21

This constant value defines the error type that is used when an error occurs whilst removing an accepted OrderUpdate callback from the Risk Firewall.
 constant integerFAILED_TO_REMOVE_QUERYRESPONSECB := 7

This constant value defines the error type that is used when an error occurs whilst removing a Query Response callback from the Risk Firewall.
 constant integerFAILED_TO_REMOVE_RULE_INSTANCE := 6

This constant value defines the error type that is used when an error occurs whilst removing a Rule Class instance from the Risk Firewall.
 constant integerFAILED_TO_SET_FIREWALL_CONFIG := 15

This constant value defines the error type that is used when the application attempts to modify the Risk Firewall configuration from a remotely connected interface.
 constant integerFAILED_TO_SET_RULE_CLASS_PRIORITY := 23

This constant value defines the error type that is used when an error occurs whilst setting a Rule Class priority.
 constant integerFAILED_TO_UNLOCK_FIREWALL := 17

This constant value defines the error type that is used when the application attempts to unlock the Risk Firewall from a remotely connected interface.
 constant integerINVALID_AMEND_ORDER := 9

This constant value defines the error type that is used when a request to amend an order is received by the Risk Firewall which has no record of the associated orderId, or it was in an invalid state.
 constant integerINVALID_CANCEL_ORDER := 10

This constant value defines the error type that is used when a request to cancel an order is received by the Risk Firewall which has no record of the associated orderId, or it was in an invalid state.
 constant integerINVALID_ORDER_UPDATE := 11

This constant value defines the error type that is used when an order update request is received by the Risk Firewall which has no record of the associated orderId, or it was in an invalid state.
 constant integerINVALID_PARAMETER := 24

This constant value defines the error type that is used when an invalid/unknown Parameter was provided.
 constant integerINVALID_QUERYREQUEST_ID := 12

This constant value defines the error type that is used when an invalid/unknown requestId was provided in a QueryResponse from a RuleClass when after it has responded to evaluating a query.
 constant integerINVALID_RULE_CLASS_NAME := 13

This constant value defines the error type that is used when an invalid/unknown Rule Class name was provided.
 constant integerINVALID_RULE_INSTANCE_ID := 22

This constant value defines the error type that is used when an invalid/unknown Rule Instance Id was provided.
 constant integerNO_ERROR := 0

This constant value indicates that there was no error.
 constant stringORDER_ID := "ORDER_ID"

This constant value defines the error key name that is used in the error params when an error occurs. This indicates the orderId that was used on the OMS request made to the Risk Firewall that caused an error.
 constant integerQUERYREQUEST_TIMEOUT := 14

This constant value defines the error type that is used when a Query Request timedout.
 constant stringRISKFIREWALL_NAME := "RISKFIREWALL_NAME"

This constant value defines the error key name that is used in the error params when an error occurs. This indicates the value will be the name of the Risk Firewall.
 constant stringRULECLASS_NAME := "RULECLASS_NAME"

This constant value defines the error key name that is used in the error params when an error occurs. This indicates the value will be the name of the Rule Class associated with this error.
 constant stringRULECLASS_QUERYID := "RULECLASS_QUERYID"

This constant value defines the error key name that is used in the error params when an error occurs. This indicates the requestId that was used in a Query Response that was associated with the error.
 constant stringRULEINSTANCE_CONFIG := "RULEINSTANCE_CONFIG"

This constant value defines the error key name that is used in the error params when an error occurs. This indicates the value will be the configuration of the Rule Class instance that this error was associated with.
 constant stringRULEINSTANCE_ID := "RULEINSTANCE_ID"

This constant value defines the error key name that is used in the error params when an error occurs. This indicates the value will be the identifier of the Rule Class instance that this error was associated with.
 
Constant detail

CUSTOM_ERROR_TYPE_START

constant integer CUSTOM_ERROR_TYPE_START := 1000
This constant value defines the value where custom error for the Risk Firewall can start.

ERROR_CALLBACK_ID

constant string ERROR_CALLBACK_ID := "ERROR_CALLBACK_ID"
This constant value defines the error key name that is used in the error params when an error occurs. This indicates the value will be the identifier of the error callback that was registered with the Risk Firewall.

ERROR_SUBTYPE

constant string ERROR_SUBTYPE := "ERROR_SUBTYPE"
This constant value defines the error key name that is used in the error params to indicate a error subType.

FAILED_TO_ADD_RULE_INSTANCE

constant integer FAILED_TO_ADD_RULE_INSTANCE := 4
This constant value defines the error type that is used when an error occurs whilst adding a Rule Class instance to the Risk Firewall.

FAILED_TO_CREATE_RISKFIREWALL_INTERFACE

constant integer FAILED_TO_CREATE_RISKFIREWALL_INTERFACE := 1
This constant value defines the error type that is used when an error occurs whilst creating the Risk Firewall.

FAILED_TO_LOCK_FIREWALL

constant integer FAILED_TO_LOCK_FIREWALL := 16
This constant value defines the error type that is used when the application attempts to lock the Risk Firewall from a remotely connected interface.

FAILED_TO_MODIFY_RULE_INSTANCE

constant integer FAILED_TO_MODIFY_RULE_INSTANCE := 5
This constant value defines the error type that is used when an error occurs whilst modifying a Rule Class instance in the Risk Firewall.

FAILED_TO_OVERRIDE_SOFT_REJECT

constant integer FAILED_TO_OVERRIDE_SOFT_REJECT := 25
This constant value defines the error type that is used when an error occurs whilst overriding a Soft-Rejected order in the Risk Firewall.

FAILED_TO_REGISTER_RULE_CLASS

constant integer FAILED_TO_REGISTER_RULE_CLASS := 3
This constant value defines the error type that is used when an error occurs whilst registering a Rule Class with the Risk Firewall.

FAILED_TO_REMOVE_ACCEPTEDAMENDCB

constant integer FAILED_TO_REMOVE_ACCEPTEDAMENDCB := 19
This constant value defines the error type that is used when an error occurs whilst removing an accepted AmendOrder callback from the Risk Firewall.

FAILED_TO_REMOVE_ACCEPTEDCANCELCB

constant integer FAILED_TO_REMOVE_ACCEPTEDCANCELCB := 20
This constant value defines the error type that is used when an error occurs whilst removing an accepted CancelOrder callback from the Risk Firewall.

FAILED_TO_REMOVE_ACCEPTEDORDERCB

constant integer FAILED_TO_REMOVE_ACCEPTEDORDERCB := 18
This constant value defines the error type that is used when an error occurs whilst removing an accepted NewOrder callback from the Risk Firewall.

FAILED_TO_REMOVE_ERROR_CALLBACK

constant integer FAILED_TO_REMOVE_ERROR_CALLBACK := 2
This constant value defines the error type that is used when an error occurs whilst removing an error callback from the Risk Firewall.

FAILED_TO_REMOVE_LOCKNOTIFICATIONCB

constant integer FAILED_TO_REMOVE_LOCKNOTIFICATIONCB := 8
This constant value defines the error type that is used when an error occurs whilst removing a Query Response callback from the Risk Firewall.

FAILED_TO_REMOVE_ORDERUPDATECB

constant integer FAILED_TO_REMOVE_ORDERUPDATECB := 21
This constant value defines the error type that is used when an error occurs whilst removing an accepted OrderUpdate callback from the Risk Firewall.

FAILED_TO_REMOVE_QUERYRESPONSECB

constant integer FAILED_TO_REMOVE_QUERYRESPONSECB := 7
This constant value defines the error type that is used when an error occurs whilst removing a Query Response callback from the Risk Firewall.

FAILED_TO_REMOVE_RULE_INSTANCE

constant integer FAILED_TO_REMOVE_RULE_INSTANCE := 6
This constant value defines the error type that is used when an error occurs whilst removing a Rule Class instance from the Risk Firewall.

FAILED_TO_SET_FIREWALL_CONFIG

constant integer FAILED_TO_SET_FIREWALL_CONFIG := 15
This constant value defines the error type that is used when the application attempts to modify the Risk Firewall configuration from a remotely connected interface.

FAILED_TO_SET_RULE_CLASS_PRIORITY

constant integer FAILED_TO_SET_RULE_CLASS_PRIORITY := 23
This constant value defines the error type that is used when an error occurs whilst setting a Rule Class priority.

FAILED_TO_UNLOCK_FIREWALL

constant integer FAILED_TO_UNLOCK_FIREWALL := 17
This constant value defines the error type that is used when the application attempts to unlock the Risk Firewall from a remotely connected interface.

INVALID_AMEND_ORDER

constant integer INVALID_AMEND_ORDER := 9
This constant value defines the error type that is used when a request to amend an order is received by the Risk Firewall which has no record of the associated orderId, or it was in an invalid state.

INVALID_CANCEL_ORDER

constant integer INVALID_CANCEL_ORDER := 10
This constant value defines the error type that is used when a request to cancel an order is received by the Risk Firewall which has no record of the associated orderId, or it was in an invalid state.

INVALID_ORDER_UPDATE

constant integer INVALID_ORDER_UPDATE := 11
This constant value defines the error type that is used when an order update request is received by the Risk Firewall which has no record of the associated orderId, or it was in an invalid state.

INVALID_PARAMETER

constant integer INVALID_PARAMETER := 24
This constant value defines the error type that is used when an invalid/unknown Parameter was provided.

INVALID_QUERYREQUEST_ID

constant integer INVALID_QUERYREQUEST_ID := 12
This constant value defines the error type that is used when an invalid/unknown requestId was provided in a QueryResponse from a RuleClass when after it has responded to evaluating a query.

INVALID_RULE_CLASS_NAME

constant integer INVALID_RULE_CLASS_NAME := 13
This constant value defines the error type that is used when an invalid/unknown Rule Class name was provided.

INVALID_RULE_INSTANCE_ID

constant integer INVALID_RULE_INSTANCE_ID := 22
This constant value defines the error type that is used when an invalid/unknown Rule Instance Id was provided.

NO_ERROR

constant integer NO_ERROR := 0
This constant value indicates that there was no error.

ORDER_ID

constant string ORDER_ID := "ORDER_ID"
This constant value defines the error key name that is used in the error params when an error occurs. This indicates the orderId that was used on the OMS request made to the Risk Firewall that caused an error.

QUERYREQUEST_TIMEOUT

constant integer QUERYREQUEST_TIMEOUT := 14
This constant value defines the error type that is used when a Query Request timedout.

RISKFIREWALL_NAME

constant string RISKFIREWALL_NAME := "RISKFIREWALL_NAME"
This constant value defines the error key name that is used in the error params when an error occurs. This indicates the value will be the name of the Risk Firewall.

RULECLASS_NAME

constant string RULECLASS_NAME := "RULECLASS_NAME"
This constant value defines the error key name that is used in the error params when an error occurs. This indicates the value will be the name of the Rule Class associated with this error.

RULECLASS_QUERYID

constant string RULECLASS_QUERYID := "RULECLASS_QUERYID"
This constant value defines the error key name that is used in the error params when an error occurs. This indicates the requestId that was used in a Query Response that was associated with the error.

RULEINSTANCE_CONFIG

constant string RULEINSTANCE_CONFIG := "RULEINSTANCE_CONFIG"
This constant value defines the error key name that is used in the error params when an error occurs. This indicates the value will be the configuration of the Rule Class instance that this error was associated with.

RULEINSTANCE_ID

constant string RULEINSTANCE_ID := "RULEINSTANCE_ID"
This constant value defines the error key name that is used in the error params when an error occurs. This indicates the value will be the identifier of the Rule Class instance that this error was associated with.