com.apama.sor.oms
Event OrderDataView


The OrderDataView event helper provides a container for creating, updating and deleting a dataview for orders. The helper is used by the ParentOrderContainer event.
Since:
CMF 2.1.0
Spawns:
addDVItemReflector() - 

Import Summary
 TimeFormatPlugintimeMgr
 
Constant Summary
 constant stringPARENTORDERID := "ParentOrderId"
 constant stringROUTINGID := "RoutingId"
 
Member Summary
 wildcard stringid
 wildcard stringdvName
 wildcard integerdvItemId
 sequence<string >dvFieldNames
 sequence<string >dvFieldTypes
 dictionary<string, integer >dvFieldNameToIndex
 wildcard contextmainContext
 
Action Summary
 voidaddDataViewDefinition(string dvName, string dvDisplayName, context mainCtx)

Create a dataview for all further instances of the order container - should only ever be called once e.g. (new OrderDataView).createDataView() within an application per required dvName.
 voidaddDVItemReflector(context dvContext, string msgId, string dvName)
 voidaddItemNew(com.apama.oms.NewOrder newOrder, com.apama.oms.OrderUpdate orderUpdate, boolean isParent, com.apama.sor.oms.OrderState state)

Utility to add a new item to the orders dataview.
 voidcreate(string id, string dvName, context mainCtx)

Constructor to create a new data view item for an order.
 voiddeleteItem()

Utility to delete an item in the orders dataview.
 sequence<string >DVFIELDNAMES()
 sequence<string >DVFIELDTYPES()
 stringgetParam(dictionary<string, string > params, string name, string def)

Get string param or default.
 voiditemUpdate(com.apama.oms.OrderUpdate orderUpdate, com.apama.sor.oms.OrderState state)

Utility to update an existing item in the orders dataview.
 voiditemUpdateState(com.apama.sor.oms.OrderState state)

Utility to update the state of an order only.
 
Import Detail

timeMgr

TimeFormatPlugin timeMgr

Constant Detail

PARENTORDERID

constant string PARENTORDERID := "ParentOrderId"

ROUTINGID

constant string ROUTINGID := "RoutingId"

Member Detail

dvFieldNames

sequence<string > dvFieldNames

dvFieldNameToIndex

dictionary<string, integer > dvFieldNameToIndex

dvFieldTypes

sequence<string > dvFieldTypes

dvItemId

wildcard integer dvItemId

dvName

wildcard string dvName

id

wildcard string id

mainContext

wildcard context mainContext

Action Detail

addDataViewDefinition

void addDataViewDefinition(string dvName, string dvDisplayName, context mainCtx)
Create a dataview for all further instances of the order container - should only ever be called once e.g. (new OrderDataView).createDataView() within an application per required dvName.
Parameters:
dvName - The dataview name to create
dvDisplayName - The dataview display name to create
mainCtx - The main context

addDVItemReflector

void addDVItemReflector(context dvContext, string msgId, string dvName)
Parameters:
dvContext
msgId
dvName

addItemNew

void addItemNew(com.apama.oms.NewOrder newOrder, com.apama.oms.OrderUpdate orderUpdate, boolean isParent, com.apama.sor.oms.OrderState state)
Utility to add a new item to the orders dataview.
Parameters:
newOrder - The com.apama.oms.NewOrder event used to add to the data view
orderUpdate - The com.apama.oms.OrderUpdate event used to add to the data view
isParent - true if this order has child orders, false otherwise
state - The OrderState of the order
Spawns:
addDVItemReflector() - 

create

void create(string id, string dvName, context mainCtx)
Constructor to create a new data view item for an order.
Parameters:
id - The unique id for this instance
dvName - The dataview name to insert the dataview item into
mainCtx - The main context

deleteItem

void deleteItem()
Utility to delete an item in the orders dataview.

DVFIELDNAMES

sequence<string > DVFIELDNAMES()

DVFIELDTYPES

sequence<string > DVFIELDTYPES()

getParam

string getParam(dictionary<string, string > params, string name, string def)
Get string param or default.
Parameters:
params
name
def

itemUpdate

void itemUpdate(com.apama.oms.OrderUpdate orderUpdate, com.apama.sor.oms.OrderState state)
Utility to update an existing item in the orders dataview.
Parameters:
orderUpdate - 
state - 

itemUpdateState

void itemUpdateState(com.apama.sor.oms.OrderState state)
Utility to update the state of an order only.
Parameters:
state -