com.SecurePlay
Interface SPGameInterface

All Known Implementing Classes:

SPGameClass

public interface SPGameInterface

This is the interface for all Game classes

Author:

IT GlobalSecure

See Also:

SecurePlay License Information

Method Summary

boolean	addComms(java.lang.String commsID) This method associates a comms service specified by the commsID string to a game instance.
boolean	addPlayer(java.lang.String pid) This method safely adds an existing Player, specified by the playerID to the game instance.
boolean	addTransaction(SPAbstractTransactionInterface transObj) This safely adds a transaction to a game instance and appropriately updates the game state.
java.lang.String	APIgetGameID() Gets the game id
SPLogInterface	APIgetGameLog() Gets the messagelog object from the gameinstance
java.lang.String	APIgetGamestatus() Getter function that returns the property: gamestatus
SPAbstractTransactionInterface	APIgetGameTransaction(java.lang.String tid) This method returns a specific transaction associated with a given game instance.
java.lang.String	APIgetLicenseSummary() This method returns a summary of the licensee information for the current game instance.
java.lang.String	APIgetMaster() Gets the master
java.lang.String[]	APIgetOpentransactionIDList() Getter function that returns the open transaction IDs
java.lang.String[]	APIgetPlayerIDList() Gets the player id list
java.lang.String	APIgetTransactionID() Gets the transaction id
boolean	closeTransaction(java.lang.String transID) Safely removes a transaction from a game instance.
SPCommsManagerClass	getCommsManager() Gets the comms manager object
SecurePlayClass	getSecurePlay() This method returns the unique SecurePlay library object associated with the game instance object.
boolean	isPlayerInternal(java.lang.String pid) Checks to see if the player is internal
void	onIncomingTransaction(SPMessageClass messObj) This method is the generic handler for incoming Game transaction methods.
boolean	removeComms(java.lang.String commsID) This method removes the association of a communications service with a game instance.
boolean	removePlayer(java.lang.String pid) This method safely removes a Player instance from an existing Game Instance.
boolean	setGameID(java.lang.String gid, SecurePlayClass spc) This method sets the internal ID for a comms service if it has not been set.
boolean	setPlayerComms(java.lang.String playerID, java.lang.String commsID) This method associates a specific player instance, specified by the playerID, with a specific communications service, specified by the commsID.
void	SPnotify(java.lang.String eventdescription, java.lang.String[] args, java.lang.String sourceMethod, java.lang.String sourceClass, java.lang.String errorType) This method notifies the Listeners of events
boolean	transactionincluded(java.lang.String tid) This method checks the specified transaction ID against the currently included transaction IDs in the game instance.

Method Detail

addPlayer

public boolean addPlayer(java.lang.String pid)

This method safely adds an existing Player, specified by the playerID to the game instance.

Parameters:

pid - String - the id of the player to be added

Returns:

result - Boolean: TRUE, if successful, FALSE, if no

removePlayer

public boolean removePlayer(java.lang.String pid)

This method safely removes a Player instance from an existing Game Instance.

Parameters:

pid - String - id of the player to be removed

Returns:

result - Boolean: TRUE, if successful, FALSE, if not.

setPlayerComms

public boolean setPlayerComms(java.lang.String playerID,
                              java.lang.String commsID)

This method associates a specific player instance, specified by the playerID, with a specific communications service, specified by the commsID. For certain remote players, a relay service is supported to allow messages to be forwarded. NOTE: there is a reserved comms service "internal" for player instances that are included in the local application session.

Parameters:

playerID - String - id of the player to be added

commsID - String - id of the comms object to be added

Returns:

result - Boolean: TRUE, if successful, FALSE, if not

addComms

public boolean addComms(java.lang.String commsID)

This method associates a comms service specified by the commsID string to a game instance.

Parameters:

commsID - String - id of the comms to be added

Returns:

result - Boolean: TRUE, if gamestatus is "complete", FALSE, if not

removeComms

public boolean removeComms(java.lang.String commsID)

This method removes the association of a communications service with a game instance.

Parameters:

commsID - String - id of the comms to be removed

Returns:

result - Boolean: TRUE, if successful, FALSE, if not

addTransaction

public boolean addTransaction(SPAbstractTransactionInterface transObj)

This safely adds a transaction to a game instance and appropriately updates the game state.

Parameters:

transObj - SPAbstractTransactionInterface - the transaction Object handler

Returns:

result - Boolean: TRUE, if successful, FALSE, if not

closeTransaction

public boolean closeTransaction(java.lang.String transID)

Safely removes a transaction from a game instance.

Parameters:

transID - String - the id of the transaction to be closed

Returns:

result - Boolean: TRUE, if successful, FALSE, if not

APIgetGameTransaction

public SPAbstractTransactionInterface APIgetGameTransaction(java.lang.String tid)

This method returns a specific transaction associated with a given game instance.

Parameters:

tid - String - identifier for transaction object

Returns:

result - Boolean: TRUE, if successful, FALSE, if not

onIncomingTransaction

public void onIncomingTransaction(SPMessageClass messObj)

This method is the generic handler for incoming Game transaction methods.

Parameters:

messObj - SPMessageClass - incoming Message Object

isPlayerInternal

public boolean isPlayerInternal(java.lang.String pid)

Checks to see if the player is internal

Parameters:

pid - String - id of the player to be checked

Returns:

result - Boolean: TRUE, if successful, FALSE, if not

APIgetGameID

public java.lang.String APIgetGameID()

Gets the game id

Returns:

str - String - the game id

APIgetPlayerIDList

public java.lang.String[] APIgetPlayerIDList()

Gets the player id list

Returns:

pidlist - String[] - the player id list

APIgetOpentransactionIDList

public java.lang.String[] APIgetOpentransactionIDList()

Getter function that returns the open transaction IDs

Returns:

opentransactionIDList - String

getCommsManager

public SPCommsManagerClass getCommsManager()

Gets the comms manager object

Returns:

comms - SPCommsManagerClass - the comms manager object

APIgetMaster

public java.lang.String APIgetMaster()

Gets the master

Returns:

master String - the master

APIgetTransactionID

public java.lang.String APIgetTransactionID()

Gets the transaction id

Returns:

tranid - String - the transaction id

getSecurePlay

public SecurePlayClass getSecurePlay()

This method returns the unique SecurePlay library object associated with the game instance object.

Returns:

spc - SecurePlayLibrary - the secure play library

SPnotify

public void SPnotify(java.lang.String eventdescription,
                     java.lang.String[] args,
                     java.lang.String sourceMethod,
                     java.lang.String sourceClass,
                     java.lang.String errorType)

This method notifies the Listeners of events

Parameters:

eventdescription -

args - - String[] - arguments

APIgetGameLog

public SPLogInterface APIgetGameLog()

Gets the messagelog object from the gameinstance

Returns:

messlog - SPLogInterface - this object contains the message logs of the game instance.

APIgetLicenseSummary

public java.lang.String APIgetLicenseSummary()

This method returns a summary of the licensee information for the current game instance. This information needs to be publicly available from any game instance, see SecurePlay license for details.

Returns:

fulllicensetext - String - this string contains full license information.

APIgetGamestatus

public java.lang.String APIgetGamestatus()

Getter function that returns the property: gamestatus

Returns:

gamestatus - String

setGameID

public boolean setGameID(java.lang.String gid,
                         SecurePlayClass spc)

This method sets the internal ID for a comms service if it has not been set. NOTE, this ID is not the public, network, or other ID for the communications service, but simply an internal handler.

Parameters:

gid - String - game id

spc - - SecurePlayClass

Returns:

boolean: TRUE, if succesful, FALSE, if not

transactionincluded

public boolean transactionincluded(java.lang.String tid)

This method checks the specified transaction ID against the currently included transaction IDs in the game instance.

Parameters:

tid - String - the id of the transaction in question

Returns:

result Boolean: TRUE, if included, FALSE, if not