org.mineot.mopenentity.entity

Class BasicEntity

java.lang.Object

org.mineot.mopenentity.entity.BasicEntity

All Implemented Interfaces:

Serializable, Activable, Entitable, LogicDeletable, Remarkable, Clearable

Direct Known Subclasses:

AuditEntity

@MappedSuperclass
public abstract class BasicEntity
extends Object
implements Entitable, Activable, LogicDeletable, Remarkable

Basic Entity. Basic structure of a entity. Used by hibernate to generate a simple table, with the ID field. Is it a abstract class, so you can implement yours entities and add more fields

Version:

1.0.0

Author:

Fabiano Pires (the mineot) - mineot.com - E-mail

See Also:

Entitable, Activable, LogicDeletable, Remarkable, Serialized Form

Field Summary

Fields inherited from interface org.mineot.mopenentity.implementable.entities.Activable

ACTIVE

Fields inherited from interface org.mineot.mopenentity.implementable.entities.LogicDeletable

DELETED

Fields inherited from interface org.mineot.mopenentity.implementable.entities.Remarkable

REMARKS

Fields inherited from interface org.mineot.mopenentity.implementable.entities.Entitable

ID

Constructor Summary

Constructors

Constructor and Description
BasicEntity() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear all object
boolean	equals(Object obj)
Long	getId() Return the value of ID field
String	getRemarks() Returns the remarks
int	hashCode()
boolean	isActive() Informs if this entities is active
boolean	isDeleted() Return if this entity it is deleted
void	setActive(boolean active) Defines the activation state this entity
void	setDeleted(boolean deleted) Defines this entity like as deleted or not
void	setId(Long id) Defines a new value to field ID.
void	setRemarks(String remarks) Defines a new value to the remarks
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BasicEntity

public BasicEntity()

Default constructor. Sets the ID field like null, ACTIVE field like true, DELETED field like false and REMARKS field like null.

Method Detail

getId

public Long getId()

Description copied from interface: Entitable

Return the value of ID field

Specified by:

getId in interface Entitable

Returns:

return a long value or null

setId

public void setId(Long id)

Description copied from interface: Entitable

Defines a new value to field ID. Not is recommended you sets this value, because is responsibility of the Hibernate set it.

Specified by:

setId in interface Entitable

Parameters:

id - set a long value or null

isActive

public boolean isActive()

Description copied from interface: Activable

Informs if this entities is active

Specified by:

isActive in interface Activable

Returns:

true if is active

setActive

public void setActive(boolean active)

Description copied from interface: Activable

Defines the activation state this entity

Specified by:

setActive in interface Activable

Parameters:

active - inform 'true' to active the entity

isDeleted

public boolean isDeleted()

Description copied from interface: LogicDeletable

Return if this entity it is deleted

Specified by:

isDeleted in interface LogicDeletable

Returns:

true if is deleted

setDeleted

public void setDeleted(boolean deleted)

Description copied from interface: LogicDeletable

Defines this entity like as deleted or not

Specified by:

setDeleted in interface LogicDeletable

Parameters:

deleted - set true if is deleted

getRemarks

public String getRemarks()

Description copied from interface: Remarkable

Returns the remarks

Specified by:

getRemarks in interface Remarkable

Returns:

return a simple string or null

setRemarks

public void setRemarks(String remarks)

Description copied from interface: Remarkable

Defines a new value to the remarks

Specified by:

setRemarks in interface Remarkable

Parameters:

remarks - sets a simple string value or null

clear

public void clear()

Description copied from interface: Clearable

Clear all object

Specified by:

clear in interface Clearable

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object