christophedelory.betty.interfaces
Interface LocalLocation

All Superinterfaces:

DbCountryEntity, DbEntity, DbIdEntity, EJBLocalObject

public interface LocalLocation
extends EJBLocalObject, DbCountryEntity

Local interface for LocationEJB.

Version:

1.1.0

Author:

Christophe Delory

See Also:

LocationDetails

Method Summary

LocalBase	getBase() Returns the base EJB object attached to this EJB object.
String	getCountry() Returns the 2-letter country code identifier defined in ISO 3166.
Date	getCreationDate() Returns the creation date of this EJB object.
String	getCreationUserId() Returns the identifier of the user having created this EJB object.
String	getId() Returns the object identifier.
boolean	getIsCountry() Specifies if this object is also a country or not.
LocalLocation	getParentLocation() Returns the parent location, if any.
TimeZone	getTimeZone() Returns the time zone of this location.
String	getTimeZoneId() Returns the time zone identifier of this location.
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	setCountry(String country) Initializes the 2-letter country code identifier defined in ISO 3166.
void	setId(String id) Initializes the object identifier.
void	setIsCountry(boolean isCountry) Specifies if this object is also a country or not.
void	setParentLocation(LocalLocation location) Initializes the parent location.
void	setTimeZoneId(String timeZoneId) Initializes the time zone identifier of this location.
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()

getCountry

String getCountry()

Description copied from interface: DbCountryEntity

Returns the 2-letter country code identifier defined in ISO 3166.

Specified by:

getCountry in interface DbCountryEntity

Returns:

the country code. May be null.

See Also:

DbCountryEntity.setCountry(String)

setCountry

void setCountry(String country)

Description copied from interface: DbCountryEntity

Initializes the 2-letter country code identifier defined in ISO 3166.

Specified by:

setCountry in interface DbCountryEntity

Parameters:

country - the country code. May be null.

See Also:

DbCountryEntity.getCountry()

getIsCountry

boolean getIsCountry()

Description copied from interface: DbCountryEntity

Specifies if this object is also a country or not.

Specified by:

getIsCountry in interface DbCountryEntity

Returns:

true if this EJB object refers to a country, false otherwise.

See Also:

DbCountryEntity.setIsCountry(boolean)

setIsCountry

void setIsCountry(boolean isCountry)

Description copied from interface: DbCountryEntity

Specifies if this object is also a country or not.

Specified by:

setIsCountry in interface DbCountryEntity

Parameters:

isCountry - true if this EJB object refers to a country, false otherwise.

See Also:

DbCountryEntity.getIsCountry()

getTimeZoneId

String getTimeZoneId()

Returns the time zone identifier of this location.

Returns:

a time zone identifier. May be null.

Throws:

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

See Also:

setTimeZoneId(String), getTimeZone()

setTimeZoneId

void setTimeZoneId(String timeZoneId)

Initializes the time zone identifier of this location.

Parameters:

timeZoneId - a time zone identifier. May be null.

Throws:

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

See Also:

getTimeZoneId()

getTimeZone

TimeZone getTimeZone()
                     throws NamingException,
                            FinderException

Returns the time zone of this location.

Returns:

a time zone. May be null.

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

See Also:

getTimeZoneId()

getParentLocation

LocalLocation getParentLocation()

Returns the parent location, if any.

Returns:

the parent location. May be null.

Throws:

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

See Also:

setParentLocation(christophedelory.betty.interfaces.LocalLocation)

setParentLocation

void setParentLocation(LocalLocation location)

Initializes the parent location.

Parameters:

location - the parent location. May be null.

Throws:

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

See Also:

getParentLocation()

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