christophedelory.betty.interfaces
Interface LocalPhase

All Superinterfaces:

DbEntity, DbIdEntity, EJBLocalObject

public interface LocalPhase
extends EJBLocalObject, DbIdEntity

Local interface for PhaseEJB.

Version:

1.1.0

Author:

Christophe Delory

See Also:

PhaseDetails

Method Summary

LocalBase	getBase() Returns the base EJB object attached to this EJB object.
LocalChampionship	getChampionship() Returns the enclosing championship.
Date	getCreationDate() Returns the creation date of this EJB object.
String	getCreationUserId() Returns the identifier of the user having created this EJB object.
Date	getEndDate() Returns the date of the last event in this phase.
String	getId() Returns the object identifier.
LocalModel	getRankModel() Returns the associated rank processing model.
Date	getStartDate() Returns the date of the first event in this phase.
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	setChampionship(LocalChampionship championship) Initializes the enclosing championship.
void	setId(String id) Initializes the object identifier.
void	setRankModel(LocalModel dbModel) Initializes the associated rank processing model.
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

getId

String getId()

Description copied from interface: DbIdEntity

Returns the object identifier.

Specified by:

getId in interface DbIdEntity

Returns:

an object identifier. Shall not be null.

See Also:

DbIdEntity.setId(String)

setId

void setId(String id)

Description copied from interface: DbIdEntity

Initializes the object identifier.

Specified by:

setId in interface DbIdEntity

Parameters:

id - an object identifier. Shall not be null.

See Also:

DbIdEntity.getId()

getRankModel

LocalModel getRankModel()

Returns the associated rank processing model.
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 rank processing model. Shall not be null.

Throws:

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

See Also:

setRankModel(christophedelory.betty.interfaces.LocalModel)

setRankModel

void setRankModel(LocalModel dbModel)

Initializes the associated rank processing model.

Parameters:

dbModel - a rank processing model. Shall not be null.

Throws:

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

See Also:

getRankModel()

getChampionship

LocalChampionship getChampionship()

Returns the enclosing championship.
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 championship. Shall not be null.

Throws:

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

See Also:

setChampionship(christophedelory.betty.interfaces.LocalChampionship)

setChampionship

void setChampionship(LocalChampionship championship)

Initializes the enclosing championship.

Parameters:

championship - a championship. Shall not be null.

Throws:

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

See Also:

getChampionship()

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()

getStartDate

Date getStartDate()
                  throws NamingException,
                         FinderException

Returns the date of the first event in this phase.

Returns:

the date of the first event in this phase. Is null if no events can be found.

Throws:

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

NamingException - if a naming exception is encountered.

FinderException - in case of failure to find any requested EJB object(s).

Since:

0.9.2

getEndDate

Date getEndDate()
                throws NamingException,
                       FinderException

Returns the date of the last event in this phase.

Returns:

the date of the last event in this phase. Is null if no events can be found.

Throws:

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

NamingException - if a naming exception is encountered.

FinderException - in case of failure to find any requested EJB object(s).

Since:

0.9.2