com.dxfeed.event.market
Class Profile

java.lang.Object
  extended by com.dxfeed.event.market.MarketEvent
      extended by com.dxfeed.event.market.Profile
All Implemented Interfaces:
LastingEvent, Serializable

public final class Profile
extends MarketEvent
implements LastingEvent

Profile information snapshot that contains security instrument description. It represents the most recent information that is available about the traded security in the market at any given moment of time.

Implementation details

This event is implemented on top of QDS record Profile.

See Also:
Serialized Form

Constructor Summary
Profile()
          Creates new profile with default values.
Profile(String eventSymbol)
          Creates new profile with the specified event symbol.
 
Method Summary
 String getDescription()
          Returns description of the security instrument.
 long getHaltEndTime()
          Returns ending time of the trading halt interval.
 long getHaltStartTime()
          Returns starting time of the trading halt interval.
 String getStatusReason()
          Returns description of the reason that trading was halted.
 boolean isTradingHalted()
          Returns true if trading of this security instrument is halted.
 void setDescription(String description)
          Changes description of the security instrument.
 void setHaltEndTime(long haltEndTime)
          Changes ending time of the trading halt interval.
 void setHaltStartTime(long haltStartTime)
          Changes starting time of the trading halt interval.
 void setStatusReason(String statusReason)
          Changes description of the reason that trading was halted.
 void setTradingHalted(boolean isTradingHalted)
          Changes trading halt status of this security instrument.
 String toString()
          Returns string representation of this profile event.
 
Methods inherited from class com.dxfeed.event.market.MarketEvent
getEventSymbol, setEventSymbol
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Profile

public Profile()
Creates new profile with default values.


Profile

public Profile(String eventSymbol)
Creates new profile with the specified event symbol.

Parameters:
eventSymbol - event symbol.
Method Detail

getDescription

public String getDescription()
Returns description of the security instrument.

Returns:
description of the security instrument.

setDescription

public void setDescription(String description)
Changes description of the security instrument.

Parameters:
description - description of the security instrument.

isTradingHalted

public boolean isTradingHalted()
Returns true if trading of this security instrument is halted.

Returns:
true if trading of this security instrument is halted.

setTradingHalted

public void setTradingHalted(boolean isTradingHalted)
Changes trading halt status of this security instrument.

Parameters:
isTradingHalted - true if trading of this security instrument is halted.

getStatusReason

public String getStatusReason()
Returns description of the reason that trading was halted.

Returns:
description of the reason that trading was halted.

setStatusReason

public void setStatusReason(String statusReason)
Changes description of the reason that trading was halted.

Parameters:
statusReason - description of the reason that trading was halted.

getHaltStartTime

public long getHaltStartTime()
Returns starting time of the trading halt interval. Time is measured in milliseconds between the current time and midnight, January 1, 1970 UTC.

Returns:
starting time of the trading halt interval.

setHaltStartTime

public void setHaltStartTime(long haltStartTime)
Changes starting time of the trading halt interval. Time is measured in milliseconds between the current time and midnight, January 1, 1970 UTC.

Parameters:
haltStartTime - starting time of the trading halt interval.

getHaltEndTime

public long getHaltEndTime()
Returns ending time of the trading halt interval. Time is measured in milliseconds between the current time and midnight, January 1, 1970 UTC.

Returns:
ending time of the trading halt interval.

setHaltEndTime

public void setHaltEndTime(long haltEndTime)
Changes ending time of the trading halt interval. Time is measured in milliseconds between the current time and midnight, January 1, 1970 UTC.

Parameters:
haltEndTime - ending time of the trading halt interval.

toString

public String toString()
Returns string representation of this profile event.

Overrides:
toString in class Object
Returns:
string representation of this profile event.


Copyright © 2013 Devexperts. All Rights Reserved.