Status
Status is used throughout MarketGrid to control the functional behaviour of different entities in the system. It is implemented as a bit mask of the values from the Status enumeration.
Overview
A comprehensive description of the way in which Status works is provided in the Status and Functional Control document.
Metadata
- Underlying type:
u32
Values
| Key | Value | Description |
|---|---|---|
| None | 0 | An empty Status mask |
| Active | 1 | Any record that does not have the Active bit set is effectively deleted and is a candidate to be purged from the matching engine when the matching engine is next cycled. |
| Normal | 2 | A record that does not have the Normal bit set is suspended. The implications for a suspended record is dependent on the kind of record in question. See the Status and Functional Control documentation for a detailed explanation of the impact of being "Suspended" in MarketGrid. |
| BuyOrdersAccepted | 4 | The Product or Actor in question will accept or can enter Buy Orders. |
| SellOrdersAccepted | 8 | The Product or Actor in question will accept or can enter Sell Orders. |
| AmendAccepted | 16 | The Product or Actor in question can amend Orders. |
| CancelAccepted | 32 | The Product or Actor in question can enter or accept Order cancellations. |
| OneSideReportsAccepted | 64 | The Product or Actor in question can enter or accept one sided TradeReports transactions. |
| TwoSideReportsAccepted | 128 | The Product or Actor in question can enter or accept two sided TradeReports transactions. That is the entry of all counter party information at the time of deal creation. |
| CrossesAccepted | 256 | A cross is defined as when the same trading user is effectively on both sides of a reported Trade. This is only permitted when both the InstrumentMarket and User have this value set. |
| ExecutesAccepted | 512 | The Product or Actor in question can enter or accept two sided TradeReports transactions in the fully executed state at the time of deal reporting. That is the entry of all counter party information at the time of deal creation and leading to an immediately executed Trade. |
| ConfirmOrders | 1024 | The Product or Actor can accept or will be compelled to confirm the details of an Order entry transaction before it is sent to the matching engine. |
| RfqAccepted | 2048 | The Product or Actor in question can enter or accept RequestForQuote transactions. |
| RequirePostPermission | 4096 | The InstrumentMarket requires that a User has the PostOrder permission in order to submit an order that might rest in the book. |
| Closed | 8192 | The entity in question is "Closed". The functional implication of being "Closed" is dependent on the type of entity in question and the context in which the test is being performed. Accounts are particularly "Closed" when they are no longer in use but still required for historical purposes |
| Terminated | 16384 | Labelling an Auction or AuctionPhase as "Terminated" makes it unusable and distinguishes from normal completion of the event. |
| DenyDepositNonAdmin | 32768 | The Instrument in question does not permit normal Users to create Deposit HoldingTransactions. Only Users with the ApproveDeny Permission on the Holding table are permitted to make deposits. |
| DenyWithdrawNonAdmin | 65536 | The Instrument in question does not permit normal Users to create Withdrawal HoldingTransactions. Only Users with the ApproveDeny Permission on the Holding table are permitted to make withdrawals. |
| Released | 67108864 | The entity in question is to be released to the system and is now visible as with a normal record. That is it should be unhidden and have the Release status removed. |
| Hidden | 134217728 | The entity in question is hidden from the general Users in the system. This is normally when the record is created but before it is ready for general use. |
| ForceUnload | 268435456 | Force this record to be unloaded to cache files even if it would otherwise be "purged" from the matching engine during a write down. |
| BootstrapUser | 536870912 | A special status for the private User that is used to bootstrap the data in the system. This identifies this class of User to the engine to ensure it is used appropriately. |
| UnloadAllTrades | 1073741824 | Unload all the Trades when the SystemStatus has this Status. This is currently reserved for future use. |
| EngineOnly | 2147483648 | These entities are only relevant in the matching engine and so may receive special treatment during a system cycle depending on the type of the entity to which the Status has been applied. |
| Orders | 4092 | A consolidated mask of all the Order related Statuses to test for or mask their presence collectively. |
Referenced by
Tables
Messages
| Message | Field | Description |
|---|---|---|
| SessionChange | RecordStatus | |
| StatusSet | Status |