christophedelory.betty.interfaces
Interface LocalPlayerScore

All Superinterfaces:

DbEntity, EJBLocalObject

public interface LocalPlayerScore
extends EJBLocalObject, DbEntity

Local interface for PlayerScoreEJB.

Version:

1.1.0

Author:

Christophe Delory

See Also:

PlayerIdDetails

Method Summary

LocalBase	getBase() Returns the base EJB object attached to this EJB object.
Date	getCreationDate() Returns the creation date of this EJB object.
String	getCreationUserId() Returns the identifier of the user having created this EJB object.
LocalPhase	getDependencyPhase() Returns the dependency phase allowing to choose the player (which is not known now in this case).
int	getDependencyPhaseRank() Returns the rank in the dependency phase allowing to choose the player (which is not known now in this case).
LocalEvent	getEvent() Returns the enclosing championship's event.
LocalPlayer	getPlayer() Returns the associated player.
int	getRank() Returns the current player rank value.
Integer	getResult() Returns the current player result.
int	getScore() Returns the current player score.
Date	getUpdateDate() Returns the update date of this EJB object.
String	getUpdateUserId() Returns the identifier of the user having performed the last update on this EJB object.
void	setBase(LocalBase dbBase) Initializes the associated EJB object.
void	setDependencyPhase(LocalPhase phase) Initializes the dependency phase allowing to choose the player (which is not known now in this case).
void	setDependencyPhaseRank(int rank) Initializes the rank in the dependency phase allowing to choose the player (which is not known now in this case).
void	setEvent(LocalEvent event) Initializes the enclosing championship's event.
void	setPlayer(LocalPlayer player) Initializes the associated player.
void	setRank(int rank) Initializes the player rank value.
void	setResult(Integer result) Initializes the player result value.
void	setScore(int score) Initializes the player score value.
void	setUpdateDate(Date date) Initializes the update date of this EJB object.
void	setUpdateUserId(String userId) Initializes the identifier of the user having performed the last update on this EJB object.

Methods inherited from interface javax.ejb.EJBLocalObject

getEJBLocalHome, getPrimaryKey, isIdentical, remove

Method Detail

getScore

int getScore()

Returns the current player score. There is no constraint on its value.

Returns:

a score value.

Throws:

EJBException - if any exception occured during the execution of this method.

See Also:

setScore(int)

setScore

void setScore(int score)

Initializes the player score value.

Parameters:

score - a score value.

Throws:

EJBException - if any exception occured during the execution of this method.

See Also:

getScore()

getRank

int getRank()

Returns the current player rank value.

Returns:

a rank value. Shall be strictly greater than 0.

Throws:

EJBException - if any exception occured during the execution of this method.

See Also:

setRank(int)

setRank

void setRank(int rank)

Initializes the player rank value.

Parameters:

rank - a rank value. Shall be strictly greater than 0.

Throws:

EJBException - if any exception occured during the execution of this method.

See Also:

getRank()

getResult

Integer getResult()

Returns the current player result. There is no constraint on its value.

Returns:

a result value. May be null.

Throws:

EJBException - if any exception occured during the execution of this method.

See Also:

setResult(Integer)

setResult

void setResult(Integer result)

Initializes the player result value.

Parameters:

result - a result value. May be null.

Throws:

EJBException - if any exception occured during the execution of this method.

See Also:

getResult()

getDependencyPhaseRank

int getDependencyPhaseRank()

Returns the rank in the dependency phase allowing to choose the player (which is not known now in this case).

Returns:

a rank value. Shall be strictly greater than 0.

Throws:

EJBException - if any exception occured during the execution of this method.

See Also:

setDependencyPhaseRank(int), getDependencyPhase()

setDependencyPhaseRank

void setDependencyPhaseRank(int rank)

Initializes the rank in the dependency phase allowing to choose the player (which is not known now in this case).

Parameters:

rank - a rank value. Shall be strictly greater than 0.

Throws:

EJBException - if any exception occured during the execution of this method.

See Also:

getDependencyPhaseRank(), setDependencyPhase(christophedelory.betty.interfaces.LocalPhase)

getEvent

LocalEvent getEvent()

Returns the enclosing championship's event.
Foreign key fields must be nullable by default. This is because the CMP specification requires an insert into the database after the ejbCreate method and an update to it after to pick up CMR changes made in ejbPostCreate. Since the EJB specification does not allow a relationship to be modified until ejbPostCreate, a foreign key will be initially set to null.

Returns:

an event. Shall not be null.

Throws:

EJBException - if any exception occured during the execution of this method.

See Also:

setEvent(christophedelory.betty.interfaces.LocalEvent)

setEvent

void setEvent(LocalEvent event)

Initializes the enclosing championship's event.

Parameters:

event - an event. Shall not be null.

Throws:

EJBException - if any exception occured during the execution of this method.

See Also:

getEvent()

getPlayer

LocalPlayer getPlayer()

Returns the associated player.
Foreign key fields must be nullable by default. This is because the CMP specification requires an insert into the database after the ejbCreate method and an update to it after to pick up CMR changes made in ejbPostCreate. Since the EJB specification does not allow a relationship to be modified until ejbPostCreate, a foreign key will be initially set to null.

Returns:

a player. May be null if not known now.

Throws:

EJBException - if any exception occured during the execution of this method.

See Also:

setPlayer(christophedelory.betty.interfaces.LocalPlayer), getDependencyPhase()

setPlayer

void setPlayer(LocalPlayer player)

Initializes the associated player.

Parameters:

player - a player. May be null.

Throws:

EJBException - if any exception occured during the execution of this method.

See Also:

getPlayer()

getDependencyPhase

LocalPhase getDependencyPhase()

Returns the dependency phase allowing to choose the player (which is not known now in this case).
Foreign key fields must be nullable by default. This is because the CMP specification requires an insert into the database after the ejbCreate method and an update to it after to pick up CMR changes made in ejbPostCreate. Since the EJB specification does not allow a relationship to be modified until ejbPostCreate, a foreign key will be initially set to null.

Returns:

a phase. May be null.

Throws:

EJBException - if any exception occured during the execution of this method.

See Also:

setDependencyPhase(christophedelory.betty.interfaces.LocalPhase), getDependencyPhaseRank()

setDependencyPhase

void setDependencyPhase(LocalPhase phase)

Initializes the dependency phase allowing to choose the player (which is not known now in this case).

Parameters:

phase - a phase. May be null.

Throws:

EJBException - if any exception occured during the execution of this method.

See Also:

getDependencyPhase(), setDependencyPhaseRank(int)

getCreationDate

Date getCreationDate()

Description copied from interface: DbEntity

Returns the creation date of this EJB object.

Specified by:

getCreationDate in interface DbEntity

Returns:

a date. Shall not be null.

getCreationUserId

String getCreationUserId()

Description copied from interface: DbEntity

Returns the identifier of the user having created this EJB object.

Specified by:

getCreationUserId in interface DbEntity

Returns:

a user identifier. Shall not be null.

getUpdateDate

Date getUpdateDate()

Description copied from interface: DbEntity

Returns the update date of this EJB object.

Specified by:

getUpdateDate in interface DbEntity

Returns:

a date. Shall not be null.

See Also:

DbEntity.setUpdateDate(java.util.Date), DbEntity.getUpdateUserId()

setUpdateDate

void setUpdateDate(Date date)

Description copied from interface: DbEntity

Initializes the update date of this EJB object.

Specified by:

setUpdateDate in interface DbEntity

Parameters:

date - a date. Shall not be null.

See Also:

DbEntity.getUpdateDate(), DbEntity.setUpdateUserId(String)

getUpdateUserId

String getUpdateUserId()

Description copied from interface: DbEntity

Returns the identifier of the user having performed the last update on this EJB object.

Specified by:

getUpdateUserId in interface DbEntity

Returns:

a user identifier. Shall not be null.

See Also:

DbEntity.setUpdateUserId(String), DbEntity.getUpdateDate()

setUpdateUserId

void setUpdateUserId(String userId)

Description copied from interface: DbEntity

Initializes the identifier of the user having performed the last update on this EJB object.

Specified by:

setUpdateUserId in interface DbEntity

Parameters:

userId - a user identifier. Shall not be null.

See Also:

DbEntity.getUpdateUserId(), DbEntity.setUpdateDate(java.util.Date)

getBase

LocalBase getBase()

Description copied from interface: DbEntity

Returns the base EJB object attached to this EJB object.
Foreign key fields must be nullable by default. This is because the CMP specification requires an insert into the database after the ejbCreate method and an update to it after to pick up CMR changes made in ejbPostCreate. Since the EJB specification does not allow a relationship to be modified until ejbPostCreate, a foreign key will be initially set to null.

Specified by:

getBase in interface DbEntity

Returns:

a base EJB object. Shall not be null.

See Also:

DbEntity.setBase(christophedelory.interfaces.LocalBase)

setBase

void setBase(LocalBase dbBase)

Description copied from interface: DbEntity

Initializes the associated EJB object.

Specified by:

setBase in interface DbEntity

Parameters:

dbBase - an EJB object. Shall not be null.

See Also:

DbEntity.getBase()