Profile (dxFeed API 3.319)

java.lang.Object
- com.dxfeed.event.market.MarketEvent
- - com.dxfeed.event.market.Profile

All Implemented Interfaces:

EventType<String>, LastingEvent<String>, Serializable
```
public class Profile
extends MarketEvent
implements LastingEvent<String>
```
Profile information snapshot that contains security instrument description. It represents the most recent information that is available about the traded security on the market at any given moment of time.
Properties
Profile event has the following properties:
- eventSymbol - symbol of this event;
- description - description of the security instrument;
- shortSaleRestriction - short sale restriction of the security instrument;
- tradingStatus - trading status of the security instrument;
- statusReason - description of the reason that trading was halted;
- haltStartTime - starting time of the trading halt interval;
- haltEndTime - ending time of the trading halt interval;
- highLimitPrice - maximal (high) allowed price;
- lowLimitPrice - minimal (low) allowed price;
- high52WeekPrice - maximal (high) price in last 52 weeks;
- low52WeekPrice - minimal (low) price in last 52 weeks;
- beta - the correlation coefficient of the instrument to the S&P500 index;
- earningsPerShare - earnings per share;
- dividendFrequency - Frequency of cash dividends payments per year (calculated);
- exDividendAmount - the amount of the last paid dividend;
- exDividendDayId - identifier of the ex-dividend date;
- shares - shares outstanding;
- freeFloat - the number of shares that are available to the public for trade.
Implementation details
This event is implemented on top of QDS record Profile.
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Profile()
Creates new profile with default values.

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

Constructors
Constructor and Description
`Profile()` Creates new profile with default values.
`Profile(String eventSymbol)` Creates new profile with the specified event symbol.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected String`	`baseFieldsToString()`
`double`	`getBeta()` Returns the correlation coefficient of the instrument to the S&P500 index.
`String`	`getDescription()` Returns description of the security instrument.
`double`	`getDividendFrequency()` Returns frequency of cash dividends payments per year (calculated).
`double`	`getEarningsPerShare()` Returns earnings per share (the company’s profits divided by the number of shares).
`double`	`getExDividendAmount()` Returns the amount of the last paid dividend.
`int`	`getExDividendDayId()` Returns identifier of the day of the last dividend payment (ex-dividend date).
`protected int`	`getFlags()` Returns implementation-specific flags.
`double`	`getFreeFloat()` Returns free-float - the number of shares outstanding that are available to the public for trade.
`long`	`getHaltEndTime()` Returns ending time of the trading halt interval.
`long`	`getHaltStartTime()` Returns starting time of the trading halt interval.
`double`	`getHigh52WeekPrice()` Returns the maximal (high) price in last 52 weeks.
`double`	`getHighLimitPrice()` Returns the maximal (high) allowed price.
`double`	`getLow52WeekPrice()` Returns the minimal (low) price in last 52 weeks.
`double`	`getLowLimitPrice()` Returns the minimal (low) allowed price.
`double`	`getShares()` Returns the number of shares outstanding.
`ShortSaleRestriction`	`getShortSaleRestriction()` Returns short sale restriction of the security instrument.
`String`	`getStatusReason()` Returns description of the reason that trading was halted.
`TradingStatus`	`getTradingStatus()` Returns trading status of the security instrument.
`boolean`	`isShortSaleRestricted()` Returns short sale restriction status of the security instrument.
`boolean`	`isTradingHalted()` Returns trading halt status of the security instrument.
`void`	`setBeta(double beta)` Changes the correlation coefficient of the instrument to the S&P500 index.
`void`	`setDescription(String description)` Changes description of the security instrument.
`void`	`setDividendFrequency(double dividendFrequency)` Changes frequency of cash dividends payments per year.
`void`	`setEarningsPerShare(double earningsPerShare)` Changes Earnings per share (the company’s profits divided by the number of shares).
`void`	`setExDividendAmount(double exDividendAmount)` Changes the amount of the last paid dividend.
`void`	`setExDividendDayId(int exDividendDayId)` Changes identifier of the day of the last dividend payment (ex-dividend date).
`protected void`	`setFlags(int flags)` Changes implementation-specific flags.
`void`	`setFreeFloat(double freeFloat)` Changes free-float - the number of shares outstanding that are available to the public for trade
`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`	`setHigh52WeekPrice(double high52WeekPrice)` Changes the maximal (high) price in last 52 weeks.
`void`	`setHighLimitPrice(double highLimitPrice)` Changes the maximal (high) allowed price.
`void`	`setLow52WeekPrice(double low52WeekPrice)` Changes the minimal (low) price in last 52 weeks.
`void`	`setLowLimitPrice(double lowLimitPrice)` Changes the minimal (low) allowed price.
`void`	`setShares(double shares)` Changes the number of shares outstanding.
`void`	`setShortSaleRestricted(boolean isShortSaleRestricted)` Deprecated. use `setShortSaleRestriction` instead.
`void`	`setShortSaleRestriction(ShortSaleRestriction restriction)` Changes short sale restriction of the security instrument.
`void`	`setStatusReason(String statusReason)` Changes description of the reason that trading was halted.
`void`	`setTradingHalted(boolean isTradingHalted)` Deprecated. use `setTradingStatus` instead.
`void`	`setTradingStatus(TradingStatus status)` Changes trading status of the security instrument.
`String`	`toString()` Returns string representation of this profile event.

Methods inherited from class com.dxfeed.event.market.MarketEvent
getEventSymbol, getEventTime, setEventSymbol, setEventTime

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.dxfeed.event.EventType
getEventSymbol, getEventTime, setEventSymbol, setEventTime

- 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.
  - getShortSaleRestriction
```
public ShortSaleRestriction getShortSaleRestriction()
```
    Returns short sale restriction of the security instrument.
    
    Returns:
    
    short sale restriction of the security instrument.
  - setShortSaleRestriction
```
public void setShortSaleRestriction(ShortSaleRestriction restriction)
```
    Changes short sale restriction of the security instrument.
    
    Parameters:
    
    restriction - short sale restriction of the security instrument.
  - isShortSaleRestricted
```
public boolean isShortSaleRestricted()
```
    Returns short sale restriction status of the security instrument.
    
    Returns:
    
    true if short sale of the security instrument is restricted.
  - setShortSaleRestricted
```
@Deprecated
public void setShortSaleRestricted(boolean isShortSaleRestricted)
```
    Deprecated. use setShortSaleRestriction instead.
    
    Changes short sale restriction status of the security instrument.
    
    Parameters:
    
    isShortSaleRestricted - true if short sale of the security instrument is restricted.
  - getTradingStatus
```
public TradingStatus getTradingStatus()
```
    Returns trading status of the security instrument.
    
    Returns:
    
    trading status of the security instrument.
  - setTradingStatus
```
public void setTradingStatus(TradingStatus status)
```
    Changes trading status of the security instrument.
    
    Parameters:
    
    status - trading status of the security instrument.
  - isTradingHalted
```
public boolean isTradingHalted()
```
    Returns trading halt status of the security instrument.
    
    Returns:
    
    true if trading of the security instrument is halted.
  - setTradingHalted
```
@Deprecated
public void setTradingHalted(boolean isTradingHalted)
```
    Deprecated. use setTradingStatus instead.
    
    Changes trading halt status of the security instrument.
    
    Parameters:
    
    isTradingHalted - true if trading of the 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.
  - getHighLimitPrice
```
public double getHighLimitPrice()
```
    Returns the maximal (high) allowed price.
    
    Returns:
    
    the maximal (high) allowed price.
  - setHighLimitPrice
```
public void setHighLimitPrice(double highLimitPrice)
```
    Changes the maximal (high) allowed price.
    
    Parameters:
    
    highLimitPrice - the maximal (high) allowed price.
  - getLowLimitPrice
```
public double getLowLimitPrice()
```
    Returns the minimal (low) allowed price.
    
    Returns:
    
    the minimal (low) allowed price.
  - setLowLimitPrice
```
public void setLowLimitPrice(double lowLimitPrice)
```
    Changes the minimal (low) allowed price.
    
    Parameters:
    
    lowLimitPrice - the minimal (low) allowed price.
  - getHigh52WeekPrice
```
public double getHigh52WeekPrice()
```
    Returns the maximal (high) price in last 52 weeks.
    
    Returns:
    
    the maximal (high) price in last 52 weeks.
  - setHigh52WeekPrice
```
public void setHigh52WeekPrice(double high52WeekPrice)
```
    Changes the maximal (high) price in last 52 weeks.
    
    Parameters:
    
    high52WeekPrice - the maximal (high) price in last 52 weeks.
  - getLow52WeekPrice
```
public double getLow52WeekPrice()
```
    Returns the minimal (low) price in last 52 weeks.
    
    Returns:
    
    the minimal (low) price in last 52 weeks.
  - setLow52WeekPrice
```
public void setLow52WeekPrice(double low52WeekPrice)
```
    Changes the minimal (low) price in last 52 weeks.
    
    Parameters:
    
    low52WeekPrice - the minimal (low) price in last 52 weeks.
  - getBeta
```
public double getBeta()
```
    Returns the correlation coefficient of the instrument to the S&P500 index.
    
    Returns:
    
    the correlation coefficient of the instrument to the S&P500 index.
  - setBeta
```
public void setBeta(double beta)
```
    Changes the correlation coefficient of the instrument to the S&P500 index.
    
    Parameters:
    
    beta - the correlation coefficient of the instrument to the S&P500 index
  - getEarningsPerShare
```
public double getEarningsPerShare()
```
    Returns earnings per share (the company’s profits divided by the number of shares).
    
    Returns:
    
    earnings per share
  - setEarningsPerShare
```
public void setEarningsPerShare(double earningsPerShare)
```
    Changes Earnings per share (the company’s profits divided by the number of shares).
    
    Parameters:
    
    earningsPerShare - earnings per share
  - getDividendFrequency
```
public double getDividendFrequency()
```
    Returns frequency of cash dividends payments per year (calculated).
    
    Returns:
    
    Frequency of cash dividends payments per year
  - setDividendFrequency
```
public void setDividendFrequency(double dividendFrequency)
```
    Changes frequency of cash dividends payments per year.
    
    Parameters:
    
    dividendFrequency - frequency of cash dividends payments per year
  - getExDividendAmount
```
public double getExDividendAmount()
```
    Returns the amount of the last paid dividend.
    
    Returns:
    
    the amount of the last paid dividend
  - setExDividendAmount
```
public void setExDividendAmount(double exDividendAmount)
```
    Changes the amount of the last paid dividend.
    
    Parameters:
    
    exDividendAmount - the amount of the last paid dividend
  - getExDividendDayId
```
public int getExDividendDayId()
```
    Returns identifier of the day of the last dividend payment (ex-dividend date). Identifier of the day is the number of days passed since January 1, 1970.
    
    Returns:
    
    the identifier of the day of the last dividend payment
  - setExDividendDayId
```
public void setExDividendDayId(int exDividendDayId)
```
    Changes identifier of the day of the last dividend payment (ex-dividend date). Identifier of the day is the number of days passed since January 1, 1970.
    
    Parameters:
    
    exDividendDayId - identifier of the day of the last dividend payment
  - getShares
```
public double getShares()
```
    Returns the number of shares outstanding.
    
    Returns:
    
    shares outstanding
  - setShares
```
public void setShares(double shares)
```
    Changes the number of shares outstanding.
    
    Parameters:
    
    shares - shares outstanding.
  - getFreeFloat
```
public double getFreeFloat()
```
    Returns free-float - the number of shares outstanding that are available to the public for trade.
    
    Returns:
    
    free-float
  - setFreeFloat
```
public void setFreeFloat(double freeFloat)
```
    Changes free-float - the number of shares outstanding that are available to the public for trade
    
    Parameters:
    
    freeFloat - the number of shares outstanding that are available to the public for trade
  - toString
```
public String toString()
```
    Returns string representation of this profile event.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    string representation of this profile event.
  - baseFieldsToString
```
protected String baseFieldsToString()
```
  - getFlags
```
protected int getFlags()
```
    Returns implementation-specific flags. Do not use this method directly. It may be removed or changed in the future versions.
    
    Returns:
    
    flags.
  - setFlags
```
protected void setFlags(int flags)
```
    Changes implementation-specific flags. Do not use this method directly. It may be removed or changed in the future versions.
    
    Parameters:
    
    flags - flags.

Class Profile

Properties

Implementation details

Constructor Summary

Method Summary

Methods inherited from class com.dxfeed.event.market.MarketEvent

Methods inherited from class java.lang.Object

Methods inherited from interface com.dxfeed.event.EventType

Constructor Detail

Profile

Profile

Method Detail

getDescription

setDescription

getShortSaleRestriction

setShortSaleRestriction

isShortSaleRestricted

setShortSaleRestricted

getTradingStatus

setTradingStatus

isTradingHalted

setTradingHalted

getStatusReason

setStatusReason

getHaltStartTime

setHaltStartTime

getHaltEndTime

setHaltEndTime

getHighLimitPrice

setHighLimitPrice

getLowLimitPrice

setLowLimitPrice

getHigh52WeekPrice

setHigh52WeekPrice

getLow52WeekPrice

setLow52WeekPrice

getBeta

setBeta

getEarningsPerShare

setEarningsPerShare

getDividendFrequency

setDividendFrequency

getExDividendAmount

setExDividendAmount

getExDividendDayId

setExDividendDayId

getShares

setShares

getFreeFloat

setFreeFloat

toString

baseFieldsToString

getFlags

setFlags