com.SecurePlay
Interface SPPlayerInterface

All Known Implementing Classes:

SPPlayerClass

public interface SPPlayerInterface

This is the interface for the Player class

Author:

IT GlobalSecure Inc.

See Also:

SecurePlay License Information

Method Summary

boolean	addGame(SPGameInterface gameObj) This method adds a game association to a player object.
boolean	clearPlayer() This function safely removes a player's association with all games - it can only be done if this will not damage any ongoing games.
boolean	configurePlayerPID(java.lang.String pid) This method sets the Player ID for a previously created Player object to associate it with a SecurePlay library.
java.lang.String	getPlayerID() This method returns the Player ID for the current player instance
boolean	isInternal() Returns the status of the internalflag
boolean	removeGame(SPGameInterface gameObj) This method removes an assocation between a Player and a Game Instance.

Method Detail

getPlayerID

public java.lang.String getPlayerID()

This method returns the Player ID for the current player instance

Returns:

str - String - the Player ID

isInternal

public boolean isInternal()

Returns the status of the internalflag

Returns:

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

addGame

public boolean addGame(SPGameInterface gameObj)

This method adds a game association to a player object. It will return TRUE if the game is newly added or already associated with the Player. This method should not be called directly, it should be called through the Game instance.

Parameters:

gameObj - SPGameInterface(actual object) - game object handler, the game to be added

Returns:

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

removeGame

public boolean removeGame(SPGameInterface gameObj)

This method removes an assocation between a Player and a Game Instance. This method should not be called directly, it should be called through the game instance.

Parameters:

gameObj - SPGameInterface(actual object) - game object handler, the game to be removed

Returns:

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

clearPlayer

public boolean clearPlayer()

This function safely removes a player's association with all games - it can only be done if this will not damage any ongoing games. If any associations cannot be closed, it will return FALSE

Returns:

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

configurePlayerPID

public boolean configurePlayerPID(java.lang.String pid)

This method sets the Player ID for a previously created Player object to associate it with a SecurePlay library.

Parameters:

pid - String - id of the player to be configured

Returns:

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