Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.fxcm.fix.entity
Class TradingSecurity

    java.lang.Object
      com.fxcm.fix.Instrument
          com.fxcm.fix.TradingSecurity
              com.fxcm.fix.entity.TradingSecurity

All Implemented Interfaces:
  com.fxcm.entity.IEntity, Serializable

    public class TradingSecurity

extends TradingSecurity
implements com.fxcm.entity.IEntity

See Also:
  Serialized Form

Field Summary
`static String` | `INSTRDB_FINDALL` Database action : find all instruments
`static String` | `INSTRDB_LOAD` Database action : retrieve one instrument by ID

Fields inherited from class com.fxcm.fix.Instrument
`OBJ_TYPE`

Constructor Summary
`TradingSecurity()`
`TradingSecurity(String aSymbol, int aFXCMSymID, int aFXCMSymPrecision, double aFXCMSymPointSize, int aFXCMSymSortOrder, String aCurrency, double aRoundLot)`
`TradingSecurity(String aSymbol, int aFXCMSymID, int aFXCMSymPrecision, String aCurrency, double aRoundLot)`

Method Summary
`Date` | `getCreationTime()` Returns the creation time of an entity.
`String` | `getDesc()` Returns the description of the entity.
`Date` | `getModificationTime()` Returns the time of last modification of the entity.
`String` | `getName()` Returns the name of the entity.
`com.fxcm.entity.IPK` | `getPK()` Returns the primary key for this entity.
`com.fxcm.entity.IStatus` | `getStatus()` Returns the status of the entity.
`boolean` | `isDeleted()` Determines whether entity is deleted.
`boolean` | `isNew()` Determines whether entity is new.
`long` | `lastTouch()` Return the time when the entity was last updated from db
`void` | `setCreationTime(Date aTime)` Sets the creation time of an entity.
`void` | `setDeleted()` Sets up entity as deleted.
`void` | `setDesc(String aDesc)` Sets the description of the entity.
`void` | `setFXCMSymID(int aFXCMSymID)` Updates FXCM ID of currency offer.
`void` | `setModificationTime(Date aTime)` Sets the time of last modification of the entity.
`void` | `setName(String aName)` Sets the name of the entity.
`void` | `setNew()` Sets up entity is new.
`void` | `setPK(com.fxcm.entity.IPK aPk)` Sets the primary key of the entity.
`void` | `setStatus(com.fxcm.entity.IStatus aStatus)` Sets the status of the entity.
`void` | `touch()` Sets the time when the entity was last updated from db.

Methods inherited from class com.fxcm.fix.TradingSecurity
`fill, getCurrency, getFXCMSubscriptionStatus, getFXCMSymInterestBuy, getFXCMSymInterestSell, getRoundLot, setCurrency, setFXCMSubscriptionStatus, setFXCMSymInterestBuy, setFXCMSymInterestSell, setRoundLot, toString`

Methods inherited from class com.fxcm.fix.Instrument
`equals, getCFICode, getContractMultiplier, getFactor, getFXCMCondDistEntryLimit, getFXCMCondDistEntryStop, getFXCMCondDistLimit, getFXCMCondDistStop, getFXCMMaxQuantity, getFXCMMinQuantity, getFXCMProductID, getFXCMSymID, getFXCMSymPointSize, getFXCMSymPrecision, getFXCMSymSortOrder, getFXCMTradingStatus, getProduct, getSecurityType, getSymbol, getType, isBullion, isCommodity, isForex, isIndex, isTreasury, isValid, priceToString, printState, setCFICode, setContractMultiplier, setFactor, setFXCMCondDistEntryLimit, setFXCMCondDistEntryStop, setFXCMCondDistLimit, setFXCMCondDistStop, setFXCMMaxQuantity, setFXCMMinQuantity, setFXCMProductID, setFXCMSymPointSize, setFXCMSymPrecision, setFXCMSymSortOrder, setFXCMTradingStatus, setProduct, setSecurityType, setSymbol`

Methods inherited from class java.lang.Object
`getClass, hashCode, notify, notifyAll, wait, wait, wait`

Methods inherited from interface com.fxcm.entity.IEntity
`getType, isValid, printState`

Field Detail

### INSTRDB_FINDALL

    public static final String INSTRDB_FINDALL

  Database action : find all instruments

  See Also:
    Constant Field Values

### INSTRDB_LOAD

    public static final String INSTRDB_LOAD

  Database action : retrieve one instrument by ID

  See Also:
    Constant Field Values

Constructor Detail

### TradingSecurity

    public TradingSecurity()

### TradingSecurity

    public TradingSecurity(String aSymbol,
                           int aFXCMSymID,
                           int aFXCMSymPrecision,
                           String aCurrency,
                           double aRoundLot)

### TradingSecurity

    public TradingSecurity(String aSymbol,
                           int aFXCMSymID,
                           int aFXCMSymPrecision,
                           double aFXCMSymPointSize,
                           int aFXCMSymSortOrder,
                           String aCurrency,
                           double aRoundLot)

Method Detail

### getDesc

    public String getDesc()

  Returns the description of the entity.

  Specified by:
    `getDesc` in interface `com.fxcm.entity.IEntity`
  Returns:
    Description of the entity.

### getCreationTime

    public Date getCreationTime()

  Returns the creation time of an entity.
  Not allowed here.

  Specified by:
    `getCreationTime` in interface `com.fxcm.entity.IEntity`
  Returns:
    `null` always.

### getModificationTime

    public Date getModificationTime()

  Returns the time of last modification of the entity.
  Not allowed here.

  Specified by:
    `getModificationTime` in interface `com.fxcm.entity.IEntity`
  Returns:
    `null` always.

### getName

    public String getName()

  Returns the name of the entity.

  Specified by:
    `getName` in interface `com.fxcm.entity.IEntity`
  Returns:
    Name of the entity.

### getPK

    public com.fxcm.entity.IPK getPK()

  Returns the primary key for this entity.

  Specified by:
    `getPK` in interface `com.fxcm.entity.IEntity`
  Returns:
    primary key for this entity.

### getStatus

    public com.fxcm.entity.IStatus getStatus()

  Returns the status of the entity.
  Not allowed here.

  Specified by:
    `getStatus` in interface `com.fxcm.entity.IEntity`
  Returns:
    `null` always.

### isDeleted

    public boolean isDeleted()

  Determines whether entity is deleted.

  Specified by:
    `isDeleted` in interface `com.fxcm.entity.IEntity`
  Returns:
    `false` alwais

### isNew

    public boolean isNew()

  Determines whether entity is new.

  Specified by:
    `isNew` in interface `com.fxcm.entity.IEntity`
  Returns:
    `false` alwais

### lastTouch

    public long lastTouch()

  Return the time when the entity was last updated from db

  Specified by:
    `lastTouch` in interface `com.fxcm.entity.IEntity`
  Returns:
    touch time

### setCreationTime

    public void setCreationTime(Date aTime)

  Sets the creation time of an entity.
  Not allowed here.

  Specified by:
    `setCreationTime` in interface `com.fxcm.entity.IEntity`
  Parameters:
    `aTime` - Creation time.

### setDeleted

    public void setDeleted()

  Sets up entity as deleted.
  Not allowed here.

  Specified by:
    `setDeleted` in interface `com.fxcm.entity.IEntity`

### setDesc

    public void setDesc(String aDesc)

  Sets the description of the entity.
  Not allowed here.

  Specified by:
    `setDesc` in interface `com.fxcm.entity.IEntity`
  Parameters:
    `aDesc` - Description of the entity.

### setModificationTime

    public void setModificationTime(Date aTime)

  Sets the time of last modification of the entity.
  Not allowed here.

  Specified by:
    `setModificationTime` in interface `com.fxcm.entity.IEntity`
  Parameters:
    `aTime` - timestamp of last modification

### setName

    public void setName(String aName)

  Sets the name of the entity.
  Not allowed here.

  Specified by:
    `setName` in interface `com.fxcm.entity.IEntity`
  Parameters:
    `aName` - Name of the entity.

### setNew

    public void setNew()

  Sets up entity is new.
  Not allowed here.

  Specified by:
    `setNew` in interface `com.fxcm.entity.IEntity`

### setPK

    public void setPK(com.fxcm.entity.IPK aPk)

  Sets the primary key of the entity.
  FXCM Offer ID inside

  Specified by:
    `setPK` in interface `com.fxcm.entity.IEntity`
  Parameters:
    `aPk` - Entity primary key.

### setStatus

    public void setStatus(com.fxcm.entity.IStatus aStatus)
                   throws com.fxcm.GenericException

  Sets the status of the entity.
  Not allowed here.

  Specified by:
    `setStatus` in interface `com.fxcm.entity.IEntity`
  Parameters:
    `aStatus` - Entity status.
  Throws:
    `com.fxcm.GenericException` - when illegal state transition happen

### touch

    public void touch()

  Sets the time when the entity was last updated from db.

  Specified by:
    `touch` in interface `com.fxcm.entity.IEntity`

### setFXCMSymID

    public void setFXCMSymID(int aFXCMSymID)

  Description copied from class: `Instrument`
  Updates FXCM ID of currency offer.

  Overrides:
    `setFXCMSymID` in class `Instrument`
  Parameters:
    `aFXCMSymID` - Offer ID

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2012 FXCM, LLC. All Rights Reserved.