christophedelory.betty.interfaces
Interface LocalMetadata

All Superinterfaces:

DbEntity, EJBLocalObject

public interface LocalMetadata
extends EJBLocalObject, DbEntity

Local interface for MetadataEJB.

Version:

1.1.0

Author:

Christophe Delory

See Also:

AbstractMetadataDetails

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.
String	getLocaleName() Returns the metadata locale.
String	getType() Returns the metadata type.
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.
String	getValue() Returns the value of this metadata.
void	setBase(LocalBase dbBase) Initializes the associated EJB object.
void	setCreationDate(Date date) Initializes the creation date.
void	setCreationUserId(String userId) Initializes the identifier of the user having created this EJB object.
void	setLocaleName(String localeName) Initializes the metadata locale.
void	setType(String type) Initializes the metadata type.
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.
void	setValue(String value) Initializes the value of this metadata.

Methods inherited from interface javax.ejb.EJBLocalObject

getEJBLocalHome, getPrimaryKey, isIdentical, remove

Method Detail

getType

String getType()

Returns the metadata type.

Returns:

the metadata type. Shall not be null.

Throws:

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

See Also:

DescriptionDetails.METADATA_TYPE, LinkDetails.METADATA_TYPE, setType(String)

setType

void setType(String type)

Initializes the metadata type.

Parameters:

type - a metadata type. Shall not be null.

Throws:

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

See Also:

getType()

getLocaleName

String getLocaleName()

Returns the metadata locale.

Returns:

a locale name. May be empty, but not null.

Throws:

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

See Also:

setLocaleName(String)

setLocaleName

void setLocaleName(String localeName)

Initializes the metadata locale.

Parameters:

localeName - a locale name. May be empty, but not null.

Throws:

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

See Also:

getLocaleName()

getValue

String getValue()

Returns the value of this metadata.

Returns:

a metadata value. Shall not be null.

Throws:

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

See Also:

setValue(String)

setValue

void setValue(String value)

Initializes the value of this metadata.

Parameters:

value - a metadata value. Shall not be null.

Throws:

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

See Also:

getValue()

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.

setCreationDate

void setCreationDate(Date date)

Initializes the creation date.

Parameters:

date - a date. Shall not be null.

Throws:

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

See Also:

getCreationDate()

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.

setCreationUserId

void setCreationUserId(String userId)

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

Parameters:

userId - a user identifier. Shall not be null.

Throws:

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

See Also:

getCreationUserId()

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