com.apama.firewall
Event OrderReceiver


The Risk Firewalls OrderReceiver object allows applications to receive order management service events that have been accepted by the Risk Firewall.

All of the order management events (IE com.apama.oms.NewOrder, com.apama.oms.AmendOrder, and com.apama.oms.CancelOrder) will have been queried against, and passed, the set of Rule Classes that have beenregistered with the Risk Firewall. The OrderReceiver also allows applications to send order update events (IE com.apama.oms.OrderUpdate) back through the Risk Firewall. These order updates will be received by any OrderSenders that are associated with this instance of the Risk Firewall.

This set of actions can also be called from a remotely connected Risk Firewall interface. This allows applications to receive accepted orders and send order updates from a different context to the Risk Firewall.
See Also:
com.apama.firewall.RiskFirewall#getOrderSender - This action is used to get an instance of the OrderSender object for the Risk Firewall.
com.apama.firewall.RiskFirewall#getOrderReceiver - This action is used to get an instance of the OrderReceiver object for the Risk Firewall.

Member summary
 action<action<com.apama.oms.NewOrder>> returns integeraddAcceptedOrderCallback

This action allows applications to add a callback action that will be called by the Risk Firewall whenever it receives a new order that has been accepted by all the Rule Classes registered with it.
 action<integer>removeAcceptedOrderCallback

This action allows applications to remove a specific accepted new order callback action that was previously added to the OrderReceiver.
 action<>clearAcceptedOrderCallbacks

This action allows applications to remove all accepted new order callback actions that were previously added to the OrderReceiver.
 action<action<com.apama.oms.AmendOrder>> returns integeraddAcceptedAmendCallback

This action allows applications to add a callback action that will be called by the Risk Firewall whenever it receives an amendment to an order that it is currently handling, and that has been accepted by all registered Rule Classes.
 action<integer>removeAcceptedAmendCallback

This action allows applications to remove a specific accepted order amendment callback action that was previously added to the OrderReceiver.
 action<>clearAcceptedAmendCallbacks

This action allows applications to remove all accepted order amendment callback actions that were previously added to the OrderReceiver.
 action<action<com.apama.oms.CancelOrder>> returns integeraddAcceptedCancelCallback

This action allows applications to add a callback action that will be called by the Risk Firewall whenever it receives a cancellation to an order that it is currently handling, and that has been accepted by all the registered Rule Classes.
 action<integer>removeAcceptedCancelCallback

This action allows applications to remove a specific accepted order cancellation callback action that was previously added to the OrderReceiver.
 action<>clearAcceptedCancelCallbacks

This action allows applications to remove all accepted order cancellation callback actions that were previously added to the OrderReceiver.
 action<com.apama.oms.OrderUpdate>sendOrderUpdate

This action sends an update to an existing order to the Risk Firewall associated with this OrderReceiver object. If an order update is sent that is not currently being handled by the Risk Firewall, then an error will be generated.
 
Member detail

addAcceptedAmendCallback

            action<action<com.apama.oms.AmendOrder>> returns integer addAcceptedAmendCallback
        
This action allows applications to add a callback action that will be called by the Risk Firewall whenever it receives an amendment to an order that it is currently handling, and that has been accepted by all registered Rule Classes.

Multiple callback actions may be added to the OrderReceiver if required.

Parameters:
cbOnAcceptedAmend - The application defined callback action that will be called for each accepted amend order received by the OrderReceiver
Returns:
A reference Id that can be used to remove the callback at a later date.
See Also:
com.apama.firewall.OrderReceiver#removeAcceptedAmendCallback - This action removes a specific accepted order amendment callback that was added to the OrderReceiver.
com.apama.firewall.OrderReceiver#clearAcceptedAmendCallbacks - This action clears all the accepted order amendment callbacks that were added to the OrderReceiver.

addAcceptedCancelCallback

            action<action<com.apama.oms.CancelOrder>> returns integer addAcceptedCancelCallback
        
This action allows applications to add a callback action that will be called by the Risk Firewall whenever it receives a cancellation to an order that it is currently handling, and that has been accepted by all the registered Rule Classes.

Multiple callback actions may be added to the OrderReceiver if required.

Parameters:
cbOnAcceptedAmend - The application defined callback action that will be called for each accepted cancel order received by the OrderReceiver
Returns:
A reference Id that can be used to remove the callback at a later date.
See Also:
com.apama.firewall.OrderReceiver#removeAcceptedCancelCallback - This action removes a specific accepted order cancellation callback that was added to the OrderReceiver.
com.apama.firewall.OrderReceiver#clearAcceptedCancelCallbacks - This action clears all the accepted order cancellation callbacks that were added to the OrderReceiver.

addAcceptedOrderCallback

            action<action<com.apama.oms.NewOrder>> returns integer addAcceptedOrderCallback
        
This action allows applications to add a callback action that will be called by the Risk Firewall whenever it receives a new order that has been accepted by all the Rule Classes registered with it.

Multiple callback actions may be added to the OrderReceiver if required.

Parameters:
cbOnAcceptedOrder - The application defined callback action that will be called for each accepted new order received by the OrderReceiver
Returns:
A reference Id that can be used to remove the callback at a later date.
See Also:
com.apama.firewall.OrderReceiver#removeAcceptedOrderCallback - This action removes a specific accepted order callback that was added to the OrderReceiver.
com.apama.firewall.OrderReceiver#clearAcceptedOrderCallbacks - This action clears all the accepted order callbacks that were added to the OrderReceiver.

clearAcceptedAmendCallbacks

            action<> clearAcceptedAmendCallbacks
        
This action allows applications to remove all accepted order amendment callback actions that were previously added to the OrderReceiver.
See Also:
com.apama.firewall.OrderReceiver#addAcceptedAmendCallback - This action adds an application defined callback action that will be called whenever the OrderReceiver accepts an order amendment from the Risk Firewall.
com.apama.firewall.OrderReceiver#removeAcceptedAmendCallback - This action removes a specific accepted amend order callback that was added to the OrderReceiver.

clearAcceptedCancelCallbacks

            action<> clearAcceptedCancelCallbacks
        
This action allows applications to remove all accepted order cancellation callback actions that were previously added to the OrderReceiver.
See Also:
com.apama.firewall.OrderReceiver#addAcceptedCancelCallback - This action adds an application defined callback action that will be called whenever the OrderReceiver accepts an order cancellation from the Risk Firewall.
com.apama.firewall.OrderReceiver#removeAcceptedCancelCallback - This action removes a specific accepted cancel order callback that was added to the OrderReceiver.

clearAcceptedOrderCallbacks

            action<> clearAcceptedOrderCallbacks
        
This action allows applications to remove all accepted new order callback actions that were previously added to the OrderReceiver.
See Also:
com.apama.firewall.OrderReceiver#addAcceptedOrderCallback - This action adds an application defined callback action that will be called whenever the OrderReceiver accepts a new order from the Risk Firewall.
com.apama.firewall.OrderReceiver#removeAcceptedOrderCallback - This action removes a specific accepted order callback that was added to the OrderReceiver.

removeAcceptedAmendCallback

            action<integer> removeAcceptedAmendCallback
        
This action allows applications to remove a specific accepted order amendment callback action that was previously added to the OrderReceiver.

Parameters:
refId - The identifier of the cancel order callback that should be removed.
See Also:
com.apama.firewall.OrderReceiver#addAcceptedAmendCallback - This action adds an application defined callback action that will be called whenever the OrderReceiver accepts an order amendment from the Risk Firewall.
com.apama.firewall.OrderReceiver#clearAcceptedAmendCallbacks - This action clears all the accepted order amendment callbacks that were added to the OrderReceiver.

removeAcceptedCancelCallback

            action<integer> removeAcceptedCancelCallback
        
This action allows applications to remove a specific accepted order cancellation callback action that was previously added to the OrderReceiver.

Parameters:
refId - The identifier of the cancel order callback that should be removed.
See Also:
com.apama.firewall.OrderReceiver#addAcceptedCancelCallback - This action adds an application defined callback action that will be called whenever the OrderReceiver accepts an order cancellation from the Risk Firewall.
com.apama.firewall.OrderReceiver#clearAcceptedCancelCallbacks - This action clears all the accepted order cancellation callbacks that were added to the OrderReceiver.

removeAcceptedOrderCallback

            action<integer> removeAcceptedOrderCallback
        
This action allows applications to remove a specific accepted new order callback action that was previously added to the OrderReceiver.

Parameters:
refId - The identifier of the order update callback that should be removed.
See Also:
com.apama.firewall.OrderReceiver#addAcceptedOrderCallback - This action adds an application defined callback action that will be called whenever the OrderReceiver accepts a new order from the Risk Firewall.
com.apama.firewall.OrderReceiver#clearAcceptedOrderCallbacks - This action clears all the accepted order callbacks that were added to the OrderReceiver.

sendOrderUpdate

            action<com.apama.oms.OrderUpdatesendOrderUpdate
        
This action sends an update to an existing order to the Risk Firewall associated with this OrderReceiver object. If an order update is sent that is not currently being handled by the Risk Firewall, then an error will be generated.

Parameters:
orderUpdate - The order update object to send to the Risk Firewall.
See Also:
com.apama.firewall.OrderSender#addOrderUpdateCallback - This action is called whenever the Risk Firewall has received an update to an order that it is currently handling.