Classes Files

com::wombat::mamda::MamdaSecurityStatusUpdate

More…

Inherits from com.wombat.mamda.MamdaBasicEvent

Inherited by com.wombat.mamda.MamdaSecurityStatusListener

Public Functions

  Name
long getSecurityStatus()
short getSecurityStatusFieldState()
short getSecurityStatusEnum()
short getSecurityStatusEnumFieldState()
long getSecurityStatusQualifier()
short getSecurityStatusQualifierFieldState()
short getSecurityStatusQualifierEnum()
short getSecurityStatusQualifierEnumFieldState()
String getSecurityStatusStr()
short getSecurityStatusStrFieldState()
String getSecurityStatusQualifierStr()
short getSecurityStatusQualifierStrFieldState()
String getSecurityStatusOrigStr()
short getSecurityStatusOrigStrFieldState()
String getReason()
short getReasonFieldState()
char getShortSaleCircuitBreaker()
short getShortSaleCircuitBreakerFieldState()
char getLuldIndicator()
short getLuldIndicatorFieldState()
MamaDateTime getLuldTime()
short getLuldTimeFieldState()
MamaPrice getLuldHighLimit()
short getLuldHighLimitFieldState()
MamaPrice getLuldLowLimit()
short getLuldLowLimitFieldState()

Additional inherited members

Public Functions inherited from com.wombat.mamda.MamdaBasicEvent

  Name
MamaDateTime getSrcTime()
short getSrcTimeFieldState()
MamaDateTime getActivityTime()
short getActivityTimeFieldState()
long getEventSeqNum()
short getEventSeqNumFieldState()
MamaDateTime getEventTime()
short getEventTimeFieldState()

Detailed Description

class com::wombat::mamda::MamdaSecurityStatusUpdate;

MamdaSecurityStatusRecap is an interface that provides access to security status related fields.

Public Functions Documentation

function getSecurityStatus

long getSecurityStatus()

Deprecated:

Returns the security status as an enumerated long integer.

Use getSecurityStatusEnum() to return security status as an enumerated short integer or getSecurityStatusStr() to return it as a String.

Reimplemented by: com::wombat::mamda::MamdaSecurityStatusListener::getSecurityStatus

function getSecurityStatusFieldState

short getSecurityStatusFieldState()

Return: the security status Field State

Reimplemented by: com::wombat::mamda::MamdaSecurityStatusListener::getSecurityStatusFieldState

function getSecurityStatusEnum

short getSecurityStatusEnum()

Reimplemented by: com::wombat::mamda::MamdaSecurityStatusListener::getSecurityStatusEnum

NYSE Technologies normalised security status. See getSecurityStatusOrig for the original exchange value.

  • MamdaSecurityStatus.SECURITY_STATUS_NONE : No security status is known/available for this security.
  • MamdaSecurityStatus.SECURITY_STATUS_NORMAL : Security is open for normal quoting and trading
  • MamdaSecurityStatus.SECURITY_STATUS_CLOSED : Security is closed (usually before or after market open)
  • MamdaSecurityStatus.SECURITY_STATUS_HALTED : Security has been halted by exchange.
  • MamdaSecurityStatus.SECURITY_STATUS_NOT_EXIST : Security does not currently exist in cache (but it might in the future).
  • MamdaSecurityStatus.SECURITY_STATUS_DELETED : Security has been deleted (e.g., merger, expiration, etc.)
  • MamdaSecurityStatus.SECURITY_STATUS_AUCTION : Security has gone into auction.
  • MamdaSecurityStatus.SECURTTY_STATUS_CROSSING : Security crossing.
  • MamdaSecurityStatus.SECURITY_STATUS_UNKNOWN : Security status not currently known.

function getSecurityStatusEnumFieldState

short getSecurityStatusEnumFieldState()

Return: the security status enum Field State

Reimplemented by: com::wombat::mamda::MamdaSecurityStatusListener::getSecurityStatusEnumFieldState

function getSecurityStatusQualifier

long getSecurityStatusQualifier()

Deprecated:

Returns the security status qualifier as an enumerated long integer.

Use getSecurityStatusQualifierEnum() to return security status as an enumerated short integer or getSecurityStatusQualifierStr() to return it as a String.

Reimplemented by: com::wombat::mamda::MamdaSecurityStatusListener::getSecurityStatusQualifier

function getSecurityStatusQualifierFieldState

short getSecurityStatusQualifierFieldState()

Return: the security status qualifier Field State

Reimplemented by: com::wombat::mamda::MamdaSecurityStatusListener::getSecurityStatusQualifierFieldState

function getSecurityStatusQualifierEnum

short getSecurityStatusQualifierEnum()

Reimplemented by: com::wombat::mamda::MamdaSecurityStatusListener::getSecurityStatusQualifierEnum

Security status qualifier.

  • MamdaSecurityStatusQual.SECURITY_STATUS_QUAL_NONE : No security status qualifier is known/available for this security.
  • MamdaSecurityStatusQual.SECURITY_STATUS_QUAL_EXCUSED : An Excused withdrawal from the market.
  • MamdaSecrutiyStatusQual.SECURITY_STATUS_QAUL_WITHDRAWN : Non-excused withdrawal by the market maker.
  • MamdaSecurityStatusQual.SECURITY_STATUS_QUAL_SUSPENDED : Suspended Trading
  • MamdaSecurityStatusQual.SECURITY_STATUS_QUAL_RESUME : Resume trading/quoting after halt.
  • MamdaSecurityStatusQual.SECURITY_STATUS_QUAL_QUOTE_RESUME : Resume quoting after halt. NASDAQ distinguishes between resumption of quoting versus trading, although these appear to always occur one after the other.
  • MamdaSecurityStatusQual.SECURITY_STATUS_QUAL_TRADE_RESUME : Resume trading after halt. NASDAQ distinguishes between resumption of quoting versus trading, although these appear to always occur one after the other.
  • MamdaSecurityStatusQual.SECURITY_STATUS_QUAL_RESUME_TIME : When the security is expected to resume trading.
  • MamdaSecurityStatusQual.SECURITY_STATUS_QUAL_MKT_IMB_BUY : Market Imbalance - Buy. A 50,000 share or more excess of market orders to buy over market orders to sell as of 9:00am on expiration days. A MktImbBuy implies an ordinary order imbalance (OrdImbBuy).
  • MamdaSecurityStatusQual.SECURITY_STATUS_QUAL_MKT_IMB_SELL : Market Imbalance - Sell. A 50,000 share or more excess of market orders to sell over market orders to buy as of 9:00am on expiration days. A MktImbSell implies an ordinary order imbalance (OrdImbSell).
  • MamdaSecurityStatusQual.SECURITY_STATUS_QUAL_NO_MKT_IMB : No Market Imbalance. Indicates that the imbalance of market orders for a security is less than 50,000 shares as of 9:00am on expiration days.
  • MamdaSecurityStatusQual.SECURITY_STATUS_QUAL_MOC_IMB_BUY : Market On Close Imbalance - Buy. An excess of 50,000 share or more of MOC orders to buy over MOC orders to sell (including MOC sell plus and MOC sell short orders). A MocImbBuy implies an ordinary order imbalance (OrdImbBuy).
  • MamdaSecurityStatusQual.SECURITY_STATUS_QUAL_MOC_IMB_SELL : Market On Close Imbalance - Sell. An excess of 50,000 share or more of MOC orders to sell (not including MOC sell short and MOC sell plus orders) over orders to buy (including MOC orders to buy minus). A MocImbSell implies an ordinary order imbalance (OrdImbSell).
  • MamdaSecurityStatusQual.SECURITY_STATUS_QUAL_NO_MOC_IMB : No Market On Close (MOC) Imbalance. The difference between the number of shares to buy MOC and the number of shares to sell MOC is less than 50,000.
  • MamdaSecurityStatusQual.SECURITY_STATUS_QUAL_ORDER_IMB : Non-regulatory condition: a significant imbalance of buy or sell orders exists for this security.
  • MamdaSecurityStatusQual.SECURITY_STATUS_QUAL_ORDER_INF : Non-regulatory condition where there is a significant influx of orders.
  • MamdaSecurityStatusQual.SECURITY_STATUS_QUAL_ORDER_IMB_BUY : Non-regulatory condition: a significant imbalance of buy orders exists for this security.
  • MamdaSecurityStatusQual.SECURITY_STATUS_QUAL_ORDER_IMB_SELL : Non-regulatory condition: a significant imbalance of sell orders exists for this security.
  • MamdaSecurityStatusQual.SECURITY_STATUS_QUAL_ORDER_IMB_NONE : The earlier imbalance of buy or sell orders no longer exists for this security. It also might mean that there is no imbalance to begin with.
  • MamdaSecurityStatusQual.SECURITY_STATUS_QUAL_RANGE_IND : Trading Range Indication. Not an Opening Delay or Trading Halted condition: this condition is used prior to the opening of a security to denote a probable trading range (bid and offer prices, no sizes).
  • MamdaSecurityStatusQual.MAMDA_SECURITY_STATUS_QUAL_ITS_PREOPEN : ITS pre-opening indication.
  • MamdaSecurityStatusQual.MAMDA_SECURITY_STATUS_QUAL_RESERVED : Reserved (e.g., CME).
  • MamdaSecurityStatusQual.MAMDA_SECURITY_STATUS_QUAL_FROZEN : Frozen (e.g., CME).
  • MamdaSecurityStatusQual.MAMDA_SECURITY_STATUS_QUAL_PREOPEN : Preopening state (e.g., CME).
  • MamdaSecurityStatusQual.MAMDA_SECURITY_STATUS_QUAL_ADD_INFO : Additional Information. For a security that is Opening Delayed or Trading Halted, if inadequate information is disclosed during a “news dissemination or news pending” Opening Delay or Trading Halt, the Opening Delay or Trading Halt reason could be subsequently reported as “Additional Information.”
  • MamdaSecurityStatusQual.MAMDA_SECURITY_STATUS_QUAL_OPEN_DELAY : Security’s opening has been delayed by exchange. This value is usually followed by another value specifying the reason for the opening delay.
  • MamdaSecurityStatusQual.MAMDA_SECURITY_STATUS_QUAL_NO_OPEN_NO_RESUME : Indicates that trading halt or opening delay will be in effect for the remainder of the trading day.
  • MamdaSecurityStatusQual.MAMDA_SECURITY_STATUS_QUAL_PRICE_IND : An approximation of what a security’s opening or re-opening price range (bid and offer prices, no sizes) will be when trading resumes after a delayed opening or after a trading halt.
  • MamdaSecurityStatusQual.MAMDA_SECURITY_STATUS_QUAL_EQUIPMENT : Non-regulatory condition: the ability to trade this security by a participant is temporarily inhibited due to a systems, equipment or communications facility problem, or for other technical reasons.
  • MamdaSecurityStatusQual.MAMDA_SECURITY_STATUS_QUAL_FILINGS : Not current in regulatory filings.
  • MamdaSecurityStatusQual.MAMDA_SECURITY_STATUS_QUAL_NEWS : News pending. Denotes a regulatory trading halt due to an expected news announcement which influence the security. An Opening Delay or Trading Halt may be continued once the news has been disseminated.
  • MamdaSecurityStatusQual.MAMDA_SECURITY_STATUS_QUAL_NEWS_DISSEM : News Dissemination. Denotes a regulatory trading halt when relevant news influencing the security is being disseminated. Trading is suspended until the primary market determines that an adequate publication or disclosure of information has occurred.
  • MamdaSecurityStatusQual.MAMDA_SECURITY_STATUS_QUAL_LISTING : Listing Noncompliance.
  • MamdaSecurityStatusQual.MAMDA_SECURITY_STATUS_QUAL_OPERATION : Operational Halt
  • MamdaSecurityStatusQual.MAMDA_SECURITY_STATUS_QUAL_INFO : Information Requested. Regulatory condition: more disclosure of information is requested by the exchange for this security.
  • MamdaSecurityStatusQual.MAMDA_SECURITY_STATUS_QUAL_SEC : SEC Suspension.
  • MamdaSecurityStatusQual.MAMDA_SECURITY_STATUS_QUAL_TIMES : News Resumption Times.
  • MamdaSecurityStatusQual.MAMDA_SECURITY_STATUS_QUAL_OTHER : Other Regulatory Halt.
  • MamdaSecurityStatusQual.MAMDA_SECURITY_STATUS_QUAL_RELATED : Related Security; In View Of Common. Non-regulatory condition: the halt or opening delay in this security is due to its relationship with another security. This condition also applies to non-common associated securities (e.g. warrants, rights, preferreds, classes, etc.) in view of the common stock.
  • IPO : Upcoming IPO issue not yet trading.

function getSecurityStatusQualifierEnumFieldState

short getSecurityStatusQualifierEnumFieldState()

Return: the security status qualifier enum Field State

Reimplemented by: com::wombat::mamda::MamdaSecurityStatusListener::getSecurityStatusQualifierEnumFieldState

function getSecurityStatusStr

String getSecurityStatusStr()

Reimplemented by: com::wombat::mamda::MamdaSecurityStatusListener::getSecurityStatusStr

NYSE Technologies normalised security status. See getSecurityStatusOrig for the original exchange value.

  • None : No security status is known/available for this security.
  • Normal : Security is open for normal quoting and trading
  • Closed : Security is closed (usually before or after market open)
  • Halted : Security has been halted by exchange.
  • NotExist : Security does not currently exist in cache (but it might in the future).
  • Deleted : Security has been deleted (e.g., merger, expiration, etc.)
  • Auction : Security has gone into auction.
  • Crossing : Security crossing.
  • Unknown : Security status not currently known.

function getSecurityStatusStrFieldState

short getSecurityStatusStrFieldState()

Return: the security status string Field State

Reimplemented by: com::wombat::mamda::MamdaSecurityStatusListener::getSecurityStatusStrFieldState

function getSecurityStatusQualifierStr

String getSecurityStatusQualifierStr()

Reimplemented by: com::wombat::mamda::MamdaSecurityStatusListener::getSecurityStatusQualifierStr

Security status qualifier.

  • None : No security status qualifier is known/available for this security.
  • Excused : An Excused withdrawal from the market.
  • Withdrawn : Non-excused withdrawal by the market maker.
  • Suspended : Suspended Trading
  • Resume : Resume trading/quoting after halt.
  • QuoteResume : Resume quoting after halt. NASDAQ distinguishes between resumption of quoting versus trading, although these appear to always occur one after the other.
  • TradeResume : Resume trading after halt. NASDAQ distinguishes between resumption of quoting versus trading, although these appear to always occur one after the other.
  • ResumeTime : When the security is expected to resume trading.
  • MktImbBuy : Market Imbalance - Buy. A 50,000 share or more excess of market orders to buy over market orders to sell as of 9:00am on expiration days. A MktImbBuy implies an ordinary order imbalance (OrdImbBuy).
  • MktImbSell : Market Imbalance - Sell. A 50,000 share or more excess of market orders to sell over market orders to buy as of 9:00am on expiration days. A MktImbSell implies an ordinary order imbalance (OrdImbSell).
  • NoMktImb : No Market Imbalance. Indicates that the imbalance of market orders for a security is less than 50,000 shares as of 9:00am on expiration days.
  • MocImbBuy : Market On Close Imbalance - Buy. An excess of 50,000 share or more of MOC orders to buy over MOC orders to sell (including MOC sell plus and MOC sell short orders). A MocImbBuy implies an ordinary order imbalance (OrdImbBuy).
  • MocImbSell : Market On Close Imbalance - Sell. An excess of 50,000 share or more of MOC orders to sell (not including MOC sell short and MOC sell plus orders) over orders to buy (including MOC orders to buy minus). A MocImbSell implies an ordinary order imbalance (OrdImbSell).
  • NoMocImb : No Market On Close (MOC) Imbalance. The difference between the number of shares to buy MOC and the number of shares to sell MOC is less than 50,000.
  • OrderImb : Non-regulatory condition: a significant imbalance of buy or sell orders exists for this security.
  • OrderInf : Non-regulatory condition where there is a significant influx of orders.
  • OrderImbBuy : Non-regulatory condition: a significant imbalance of buy orders exists for this security.
  • OrderImbSell : Non-regulatory condition: a significant imbalance of sell orders exists for this security.
  • OrderImbNone : The earlier imbalance of buy or sell orders no longer exists for this security. It also might mean that there is no imbalance to begin with.
  • RangeInd : Trading Range Indication. Not an Opening Delay or Trading Halted condition: this condition is used prior to the opening of a security to denote a probable trading range (bid and offer prices, no sizes).
  • ItsPreOpen : ITS pre-opening indication.
  • Reserved : Reserved (e.g., CME).
  • Frozen : Frozen (e.g., CME).
  • PreOpen : Preopening state (e.g., CME).
  • AddInfo : Additional Information. For a security that is Opening Delayed or Trading Halted, if inadequate information is disclosed during a “news dissemination or news pending” Opening Delay or Trading Halt, the Opening Delay or Trading Halt reason could be subsequently reported as “Additional Information.”
  • OpenDelay : Security’s opening has been delayed by exchange. This value is usually followed by another value specifying the reason for the opening delay.
  • NoOpenNoResume : Indicates that trading halt or opening delay will be in effect for the remainder of the trading day.
  • PriceInd : An approximation of what a security’s opening or re-opening price range (bid and offer prices, no sizes) will be when trading resumes after a delayed opening or after a trading halt.
  • Equipment : Non-regulatory condition: the ability to trade this security by a participant is temporarily inhibited due to a systems, equipment or communications facility problem, or for other technical reasons.
  • Filings : Not current in regulatory filings.
  • News : News pending. Denotes a regulatory trading halt due to an expected news announcement which influence the security. An Opening Delay or Trading Halt may be continued once the news has been disseminated.
  • NewsDissem : News Dissemination. Denotes a regulatory trading halt when relevant news influencing the security is being disseminated. Trading is suspended until the primary market determines that an adequate publication or disclosure of information has occurred.
  • Listing : Listing Noncompliance.
  • Operation : Operational Halt
  • Info : Information Requested. Regulatory condition: more disclosure of information is requested by the exchange for this security.
  • SEC : SEC Suspension.
  • Times : News Resumption Times.
  • Other : Other Regulatory Halt.
  • Related : Related Security; In View Of Common. Non-regulatory condition: the halt or opening delay in this security is due to its relationship with another security. This condition also applies to non-common associated securities (e.g. warrants, rights, preferreds, classes, etc.) in view of the common stock.
  • IPO : Upcoming IPO issue not yet trading.

function getSecurityStatusQualifierStrFieldState

short getSecurityStatusQualifierStrFieldState()

Return: the security status qualifier string Field State

Reimplemented by: com::wombat::mamda::MamdaSecurityStatusListener::getSecurityStatusQualifierStrFieldState

function getSecurityStatusOrigStr

String getSecurityStatusOrigStr()

See: MamdaSecurityStatusUpdate::getSecurityStatusOrigStr()

Reimplemented by: com::wombat::mamda::MamdaSecurityStatusListener::getSecurityStatusOrigStr

function getSecurityStatusOrigStrFieldState

short getSecurityStatusOrigStrFieldState()

Return: the security status original Field State

Reimplemented by: com::wombat::mamda::MamdaSecurityStatusListener::getSecurityStatusOrigStrFieldState

function getReason

String getReason()

Return: The reason for the current status.

Reimplemented by: com::wombat::mamda::MamdaSecurityStatusListener::getReason

Unnormalized (feed-specific) reason associated with the current status of the security (e.g. halted, delayed, etc.). For normalized field, see getSecurityStatusQualifierStr/getSecurityStatusQualifierEnum.

function getReasonFieldState

short getReasonFieldState()

Return: the reason Field State

Reimplemented by: com::wombat::mamda::MamdaSecurityStatusListener::getReasonFieldState

function getShortSaleCircuitBreaker

char getShortSaleCircuitBreaker()

Return: ShortSaleCircuitBreaker

  • return values:
  • Blank: Short Sale Restriction Not in Effect.
  • A: Short Sale Restriction Activiated.
  • C: Short Sale Restriction Continued.
  • D: Sale Restriction Deactivated.
  • E: Sale Restriction in Effect.

Reimplemented by: com::wombat::mamda::MamdaSecurityStatusListener::getShortSaleCircuitBreaker

get the ShortSaleCircuitBreaker

function getShortSaleCircuitBreakerFieldState

short getShortSaleCircuitBreakerFieldState()

Return: the reason Field State

Reimplemented by: com::wombat::mamda::MamdaSecurityStatusListener::getShortSaleCircuitBreakerFieldState

function getLuldIndicator

char getLuldIndicator()

See: MamdaSecurityStatusUpdate::getLuldIndicator()

Reimplemented by: com::wombat::mamda::MamdaSecurityStatusListener::getLuldIndicator

function getLuldIndicatorFieldState

short getLuldIndicatorFieldState()

Reimplemented by: com::wombat::mamda::MamdaSecurityStatusListener::getLuldIndicatorFieldState

return the Limit Up Limit Down High Limit MODIFIED (2) value indicates the field was updated in last tick NOT MODIFIED (1) value indicate that there was no change in the last tick NOT_INITIALISED (0) value indicates that the field has never been updated

function getLuldTime

MamaDateTime getLuldTime()

See: MamdaSecurityStatusUpdate::getLuldTime()

Reimplemented by: com::wombat::mamda::MamdaSecurityStatusListener::getLuldTime

function getLuldTimeFieldState

short getLuldTimeFieldState()

Reimplemented by: com::wombat::mamda::MamdaSecurityStatusListener::getLuldTimeFieldState

return the Limit Up Limit Down High Limit MODIFIED (2) value indicates the field was updated in last tick NOT MODIFIED (1) value indicate that there was no change in the last tick NOT_INITIALISED (0) value indicates that the field has never been updated

function getLuldHighLimit

MamaPrice getLuldHighLimit()

See: MamdaSecurityStatusUpdate::getLuldHighLimit()

Reimplemented by: com::wombat::mamda::MamdaSecurityStatusListener::getLuldHighLimit

function getLuldHighLimitFieldState

short getLuldHighLimitFieldState()

Reimplemented by: com::wombat::mamda::MamdaSecurityStatusListener::getLuldHighLimitFieldState

return the Limit Up Limit Down High Limit MODIFIED (2) value indicates the field was updated in last tick NOT MODIFIED (1) value indicate that there was no change in the last tick NOT_INITIALISED (0) value indicates that the field has never been updated

function getLuldLowLimit

MamaPrice getLuldLowLimit()

See: MamdaSecurityStatusUpdate::getLuldLowLimit()

Reimplemented by: com::wombat::mamda::MamdaSecurityStatusListener::getLuldLowLimit

function getLuldLowLimitFieldState

short getLuldLowLimitFieldState()

Reimplemented by: com::wombat::mamda::MamdaSecurityStatusListener::getLuldLowLimitFieldState

return the Limit Up Limit Down Low Limit MODIFIED (2) value indicates the field was updated in last tick NOT MODIFIED (1) value indicate that there was no change in the last tick NOT_INITIALISED (0) value indicates that the field has never been updated


Updated on 2023-03-31 at 15:30:35 +0100