LocalEvent (Betty v1.1.0 Reference API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Betty v1.1.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

christophedelory.betty.interfaces
Interface LocalEvent

All Superinterfaces:: DbEntity, DbIdEntity, EJBLocalObject

public interface LocalEvent
extends EJBLocalObject, DbIdEntity
extends EJBLocalObject, DbIdEntity

Local interface for EventEJB.

Version:: 1.1.0
Author:: Christophe Delory
See Also:: EventDetails

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.
`Date`	`getDate()` Returns the event's date.
`String`	`getId()` Returns the object identifier.
`LocalLocation`	`getLocation()` Returns the event's location.
`LocalPhase`	`getPhase()` Returns the enclosing championship's phase.
`LocalModel`	`getScoreModel()` Returns the associated score processing model.
`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`	`setDate(Date date)` Initializes the event's date.
`void`	`setId(String id)` Initializes the object identifier.
`void`	`setLocation(LocalLocation location)` Initializes the event's location.
`void`	`setPhase(LocalPhase phase)` Initializes the enclosing championship's phase.
`void`	`setScoreModel(LocalModel dbModel)` Initializes the associated score 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()

getDate

Date getDate()

Returns the event's date.

Returns:: a date. Shall not be null.
Throws:: EJBException - if any exception occured during the execution of this method.
See Also:: setDate(java.util.Date)

setDate

void setDate(Date date)

Initializes the event's date.

Parameters:: date - a date. Shall not be null.
Throws:: EJBException - if any exception occured during the execution of this method.
See Also:: getDate()

getScoreModel

LocalModel getScoreModel()

Returns the associated score 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 score processing model. Shall not be null.
Throws:: EJBException - if any exception occured during the execution of this method.
See Also:: setScoreModel(christophedelory.betty.interfaces.LocalModel)

setScoreModel

void setScoreModel(LocalModel dbModel)

Initializes the associated score processing model.

Parameters:: dbModel - a score processing model. Shall not be null.
Throws:: EJBException - if any exception occured during the execution of this method.
See Also:: getScoreModel()

getPhase

LocalPhase getPhase()

Returns the enclosing championship's phase.
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. Shall not be null.
Throws:: EJBException - if any exception occured during the execution of this method.
See Also:: setPhase(christophedelory.betty.interfaces.LocalPhase)

setPhase

void setPhase(LocalPhase phase)

Initializes the enclosing championship's phase.

Parameters:: phase - a phase. Shall not be null.
Throws:: EJBException - if any exception occured during the execution of this method.
See Also:: getPhase()

getLocation

LocalLocation getLocation()

Returns the event's location.
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 location. Shall not be null.
Throws:: EJBException - if any exception occured during the execution of this method.
See Also:: setLocation(christophedelory.betty.interfaces.LocalLocation)

setLocation

void setLocation(LocalLocation location)

Initializes the event's location.

Parameters:: location - a location. Shall not be null.
Throws:: EJBException - if any exception occured during the execution of this method.
See Also:: getLocation()