com.apama.firewall
Event OrderSender


The Risk Firewalls OrderSender object allows applications to send order management service events (IE com.apama.oms.NewOrder, com.apama.oms.AmendOrder, and com.apama.oms.CancelOrder) to the Risk Firewall.

It also allows applications to register a callback action that can be used to receive order update events (IE com.apama.oms.OrderUpdate) from the Risk Firewall.

These order management events will then be queried by the Risk Firewall against all registered Rule Classes and Rule Class instances that have been added. If the order management event is approved, then it will be received on any OrderReceivers 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 send orders and receive 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<com.apama.oms.NewOrder >sendOrder

This action sends a new order to the Risk Firewall associated with this OrderSender object.
 action<com.apama.oms.NewOrder, action<com.apama.oms.OrderUpdate > >sendOrderCb

This action sends a new order to the Risk Firewall associated with this OrderSender object.
 action<com.apama.oms.AmendOrder >sendAmend

This action sends an amendment to an existng order to the Risk Firewall associated with this OrderSender object.
 action<com.apama.oms.CancelOrder >sendCancel

This action sends a cancellation to an existng order to the Risk Firewall associated with this OrderSender object.
 action<action<com.apama.oms.OrderUpdate > > returns integeraddOrderUpdateCallback

This action allows applications to add a callback action that will be called by the Risk Firewall whenever it receives an update to an order that it is currently handling.
 action<integer >removeOrderUpdateCallback

This action allows applications to remove a specific order update callback action that was previously added to the OrderSender.
 action< >clearOrderUpdateCallbacks

This action allows applications to remove all order update callback actions that were previously added to the OrderSender.
 
Member Detail

addOrderUpdateCallback

action<action<com.apama.oms.OrderUpdate > > returns integer addOrderUpdateCallback
This action allows applications to add a callback action that will be called by the Risk Firewall whenever it receives an update to an order that it is currently handling.

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

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

clearOrderUpdateCallbacks

action< > clearOrderUpdateCallbacks
This action allows applications to remove all order update callback actions that were previously added to the OrderSender.
See Also:
com.apama.firewall.OrderSender#addOrderUpdateCallback - This action adds an application defined callback action that will be called whenever the OrderSender receives an update to an order currently being handled by the Risk Firewall.
com.apama.firewall.OrderSender#removeOrderUpdateCallback - This action removes a specific order update callback that was added to the OrderSender.

removeOrderUpdateCallback

action<integer > removeOrderUpdateCallback
This action allows applications to remove a specific order update callback action that was previously added to the OrderSender.

Parameters:
refId - The identifier of the order update callback that should be removed.
See Also:
com.apama.firewall.OrderSender#addOrderUpdateCallback - This action adds an application defined callback action that will be called whenever the OrderSender receives an update to an order currently being handled by the Risk Firewall.
com.apama.firewall.OrderSender#clearOrderUpdateCallbacks - This action clears all the order update callbacks that were added to the OrderSender.

sendAmend

action<com.apama.oms.AmendOrder > sendAmend
This action sends an amendment to an existng order to the Risk Firewall associated with this OrderSender object.

The order amendment will be queried against all registered Rule Classes and Rule Class instances that have been added. If the order amendment was approved, then it will be received by any OrderReceivers that are associated with this Risk Firewall. If an amendment is made to an order that is not currently being handled by the Risk Firewall, then it will be rejected.

Parameters:
amendOrder - The amend order object to send to the Risk Firewall.
See Also:
com.apama.firewall.OrderSender#sendOrder - This action sends a new order to the Risk Firewall, but requires an order update callback to be added to receive and updates to this order.
com.apama.firewall.OrderReceiver#addAcceptedAmendCallback - This action is called whenever the Risk Firewall has approved an order amendment that has been placed against it.

sendCancel

action<com.apama.oms.CancelOrder > sendCancel
This action sends a cancellation to an existng order to the Risk Firewall associated with this OrderSender object.

The order cancellation will be queried against all registered Rule Classes and Rule Class instances that have been added. If the order cancellation was approved, then it will be received by any OrderReceivers that are associated with this Risk Firewall. If a cancellation is made to an order that is not currently being handled by the Risk Firewall, then it will be rejected.

Parameters:
cancelOrder - The cancel order object to send to the Risk Firewall.
See Also:
com.apama.firewall.OrderSender#sendOrder - This action sends a new order to the Risk Firewall, but requires an order update callback to be added to receive and updates to this order.
com.apama.firewall.OrderReceiver#addAcceptedCancelCallback - This action is called whenever the Risk Firewall has approved an order cancellation that has been placed against it.

sendOrder

action<com.apama.oms.NewOrder > sendOrder
This action sends a new order to the Risk Firewall associated with this OrderSender object.

The new order will be queried against all registered Rule Classes and Rule Class instances that have been added. If the order was approved, then it will be received by any OrderReceivers that are associated with this Risk Firewall.

Parameters:
newOrder - The new order object to send to the Risk Firewall.
See Also:
com.apama.firewall.OrderSender#sendOrderCb - This action provides the same functionality as the sendOrder() action, but also allows applications to define a specific callback action that will be called on all updates for this specific order.
com.apama.firewall.OrderReceiver#addAcceptedOrderCallback - This action is called whenever the Risk Firewall has approved a new order that has been placed against it.

sendOrderCb

action<com.apama.oms.NewOrder, action<com.apama.oms.OrderUpdate > > sendOrderCb
This action sends a new order to the Risk Firewall associated with this OrderSender object.

The new order will be queried against all registered Rule Classes and Rule Class instances that have been added. If the order was approved, then it will be received by any OrderReceivers that are associated with this Risk Firewall. This action provides the same functionality as the sendOrder() action, but also allows applications to define a specific callback action that will be called on all updates for this specific order.

Parameters:
newOrder - The new order object to send to the Risk Firewall.
cbOnOrderUpdate - The callback action that will be called whenever an update to this specific order has been received.
See Also:
com.apama.firewall.OrderSender#sendOrder - This action sends a new order to the Risk Firewall, but requires an order update callback to be added to receive and updates to this order.
com.apama.firewall.OrderReceiver#addAcceptedOrderCallback - This action is called whenever the Risk Firewall has approved a new order that has been placed against it.