com.wombat.mamda.MamdaSecurityStatusRecap Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openmamda Show documentation
OpenMAMDA is a high performance Market Data API written on top of OpenMAMA.
There is a newer version: 6.3.2
/* $Id$
 *
 * OpenMAMA: The open middleware agnostic messaging API
 * Copyright (C) 2012 NYSE Technologies, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA
 */

package com.wombat.mamda;

import com.wombat.mama.MamaPrice;
import com.wombat.mama.MamaDateTime;

/**
 * MamdaSecurityStatusRecap is an interface that provides access to security status
 * related fields.
 */
public interface MamdaSecurityStatusRecap extends MamdaBasicRecap
{
    /**
     * @see MamdaSecurityStatusUpdate#getSecurityStatus() 
     * @deprecated
     */
    public long   getSecurityStatus();

    /**
     * @return the security status Field State
     */
    public short  getSecurityStatusFieldState();

    /**
     * @see MamdaSecurityStatusUpdate#getSecurityStatusQualifier()
     * @deprecated
     */
    public long   getSecurityStatusQualifier();

    /**
     * @return the security status Field State
     */
    public short  getSecurityStatusQualifierFieldState();

    /**
     * @see MamdaSecurityStatusUpdate#getSecurityStatusEnum()
     */ 
    public short  getSecurityStatusEnum();

    /**
     * @return the security status Field State
     */
    public short  getSecurityStatusEnumFieldState();

    /**
     * @see MamdaSecurityStatusUpdate#getSecurityStatusQualifierEnum()
     */
    public short  getSecurityStatusQualifierEnum(); 

    /**
     * @return the security status qualifier enum Field State
     */
    public short  getSecurityStatusQualifierEnumFieldState();

    /**
     * @see MamdaSecurityStatusUpdate#getSecurityStatusStr()
     */
    public String getSecurityStatusStr();

    /**
     * @return the security status string Field State
     */
    public short  getSecurityStatusStrFieldState();

    /**
     * @see MamdaSecurityStatusUpdate#getSecurityStatusQualifierStr()
     */
    public String getSecurityStatusQualifierStr();

    /**
     * @return the security status qualifier string Field State
     */
    public short  getSecurityStatusQualifierStrFieldState();

    /**
     * @see MamdaSecurityStatusUpdate#getSecurityStatusOrigStr()
     */
    public String getSecurityStatusOrigStr();

    /**
     * @return the security status orig string Field State
     */
    public short  getSecurityStatusOrigStrFieldState();

    /**
     * @see MamdaSecurityStatusUpdate#getReason()
     */
    public String getReason();

    /**
     * @return the reason Field State
     */
    public short  getReasonFieldState();

    /**
     * getShortSaleCircuitBreaker Returns the ShortSaleCircuitBreaker
     * @return ShortSaleCircuitBreaker
     * @see MamdaSecurityStatusUpdate#getShortSaleCircuitBreaker()
     */
    public char getShortSaleCircuitBreaker();  

    /**
     * @return Returns the FieldState, always MODIFIED.
     */
    public short getShortSaleCircuitBreakerFieldState();
   
    /**
     * @see MamdaSecurityStatusUpdate#getLuldIndicator()
     */
    public char getLuldIndicator();

    /**
     * return the Limit Up Limit Down Indicator Field State
     * MODIFIED (2) value indicates the fied 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
     */
    public short  getLuldIndicatorFieldState();

    /**
     * @see MamdaSecurityStatusUpdate#getLuldTime()
     */
    public MamaDateTime getLuldTime();

    /**
     * return the Limit Up Limit Down Time Field State
     * MODIFIED (2) value indicates the fied 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
     */
    public short getLuldTimeFieldState();

    /**
     * @see MamdaSecurityStatusUpdate#getLuldHighLimit()
     */
    public MamaPrice getLuldHighLimit();

    /**
     * return the Limit Up Limit Down High Limit Field State
     * MODIFIED (2) value indicates the fied 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
     */
    public short  getLuldHighLimitFieldState();

    /**
     * @see MamdaSecurityStatusUpdate#getLuldLowLimit()
     */
    public MamaPrice getLuldLowLimit();

    /**
     * return the Limit Up Limit Down Low Limit Field State
     * 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
     */
    public short  getLuldLowLimitFieldState();

}