io.nadron.app

Interface Player

All Known Implementing Classes:

DefaultPlayer

public interface Player

A Player is a human or machine that is playing single or multiple games. This interface aims to abstract the basic properties of such a domain object.

Author:

Abraham Menacherry

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addSession(PlayerSession session) Add a session to a player.
String	getEmailId() Method used to get the email id of the gamer.
Object	getId() A unique key representing a gamer.
String	getName() Method used to get the name of the gamer.
void	logout(PlayerSession playerSession) When a player logs out, this method can be called.
boolean	removeSession(PlayerSession session) Remove the players session to a game.
void	setEmailId(String emailId) Method used to set the email id of the gamer.
void	setId(Object uniqueKey) A unique key representing a gamer.
void	setName(String name) Method used to set the name of the gamer.

Method Detail

getId

Object getId()

A unique key representing a gamer. This could be an email id or something unique.

Returns:

Returns the unique key for the gamer.

setId

void setId(Object uniqueKey)

A unique key representing a gamer. This could be an email id or something unique.

getName

String getName()

Method used to get the name of the gamer.

Returns:

Returns the name or null if none is associated.

setName

void setName(String name)

Method used to set the name of the gamer.

Parameters:

name - Set the string name, strings more than 100 characters long may be rejected.

getEmailId

String getEmailId()

Method used to get the email id of the gamer.

Returns:

Returns the email id string, null if none is set.

setEmailId

void setEmailId(String emailId)

Method used to set the email id of the gamer.

Parameters:

emailId - Sets the email id string. strings more than 50 characters long may be rejected.

addSession

boolean addSession(PlayerSession session)

Add a session to a player. This session signifies the players session to a game.

Parameters:

session - The session to add.

Returns:

true if add was successful, false if not.

removeSession

boolean removeSession(PlayerSession session)

Remove the players session to a game.

Parameters:

session - The session to remove.

Returns:

true if remove is successful, false other wise.

logout

void logout(PlayerSession playerSession)

When a player logs out, this method can be called. It can also be called by the remove session method when it finds that there are no more sessions for this player.

Parameters:

playerSession - The session which is to be logged out.