it.list.jft
Interface EntityClass

All Known Subinterfaces:
Entity

public interface EntityClass

Interface that describes a specific market/service class.

All market/service EntityClasses share a set of common methods to:

In addition all market/service objects, that implement the Entity sub-interface, share, as well, these methods.

If necessary explicitly objects that implement this interface are created and returned by the JFT.getEntityClass() method.


Field Summary
static int TYPE_ENTITY
           
static int TYPE_ENUM
           
 
Method Summary
 int getEntityClassID()
          Returns the ID that identifies the EntityClass.
 String getEntityClassName()
          Returns the name that identifies the EntityClass.
 EntityField[] getEntityFields()
           
 int getNumSegments(int keyID)
          Returns the number of segments of the given KeyID of this EntityClass.
 int getType()
           
 boolean isKey(int keyID)
          Check if a given keyID is an index of a key for this EntityClass.
 boolean isKey(int keyID, boolean checkPrimary)
          Check if a given keyID is an index of a primary or duplicate key for this EntityClass.
 Entity makeEntity()
           
 

Field Detail

TYPE_ENTITY

static final int TYPE_ENTITY
See Also:
Constant Field Values

TYPE_ENUM

static final int TYPE_ENUM
See Also:
Constant Field Values
Method Detail

getEntityClassName

String getEntityClassName()
Returns the name that identifies the EntityClass.

Returns:
the name that identifies the EntityClass.
null and empty strings are never returned.

getEntityClassID

int getEntityClassID()
Returns the ID that identifies the EntityClass.

Returns:
the ID that identifies the EntityClass.
zero or negative values are never returned.

isKey

boolean isKey(int keyID)
Check if a given keyID is an index of a key for this EntityClass.

Parameters:
keyID - index to be checked
Returns:
true if keyID is an index of a key for this EntityClass,
falseotherwise.

isKey

boolean isKey(int keyID,
              boolean checkPrimary)
Check if a given keyID is an index of a primary or duplicate key for this EntityClass.

Parameters:
keyID - index to be checked
checkPrimary - check for primary or duplicate key index
Returns:
true if keyID is an index of a key for this EntityClass and it refers a primary or duplicate key as specified by checkPrimary parameter,
falseotherwise.

getNumSegments

int getNumSegments(int keyID)
Returns the number of segments of the given KeyID of this EntityClass.

Parameters:
keyID - the index of a key of this class.
Returns:
the number of segments of the given KeyID of this EntityClass.
0 is returned if the KeyID parameter is not a valid index of a key of this class.

getType

int getType()

getEntityFields

EntityField[] getEntityFields()

makeEntity

Entity makeEntity()


Submit a bug or feature to FT\API Programming Support<\font>