br.com.arsmachina.controller

Interface WriteableController<T,K extends Serializable>

Type Parameters:

T - the entity class related to this controller.

K - the type of the field that represents the entity class' primary key.

All Known Subinterfaces:

Controller<T,K>

All Known Implementing Classes:

ControllerImpl, WriteableControllerImpl

public interface WriteableController<T,K extends Serializable>

Interface that defines a read-write, generic and generified controller for a given entity class.

Author:

Thiago H. de Paula Figueiredo

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(K id) Removes an object given its primary key.
void	delete(T object) Removes an object.
void	evict(T object) Removes an object from the current persistence context.
boolean	isPersistent(T object) Tells whether a given object is already persistent or not.
void	save(T object) Saves (inserts) an object.
T	saveOrUpdate(T object) Saves (inserts) or updates an object.
T	update(T object) Updates an object.

Method Detail

delete

void delete(T object)

Removes an object.

Parameters:

object - a T.

delete

void delete(K id)

Removes an object given its primary key.

Parameters:

id - a K.

save

void save(T object)

Saves (inserts) an object.

Parameters:

object - a T

update

T update(T object)

Updates an object. If it is not persistent, an IllegalArgumentException is thrown. The return value must be the object that is attached to the persistence context of the underlying implementation, if it exists. Otherwise, this method simply returns the object passed as a parameter. This return value was added to deal ORM frameworks like JPA, that do not attach the updated object to the persistence context. See EntityManager.merge().

Parameters:

object - a T.

Returns:

a T.

Throws:

IllegalArgumentException - if object is null or not persistent.

saveOrUpdate

T saveOrUpdate(T object)

Saves (inserts) or updates an object. If it is already persistent, it is updated. Otherwise, it is saved (inserted). The return value must be the object that is attached to the persistence context of the underlying implementation, if it exists. Otherwise, this method simply returns the object passed as a parameter. This return value was added to deal ORM frameworks like JPA, that do not attach the updated object to the persistence context. See EntityManager.merge().

Parameters:

object - a T

Returns:

a T.

Throws:

IllegalArgumentException - if object is null.

evict

void evict(T object)

Removes an object from the current persistence context. This method only has meaningful implementations when used with ORM frameworks that have an evict concept (Hibernate, JPA, etc).

Parameters:

object - a T.

isPersistent

boolean isPersistent(T object)

Tells whether a given object is already persistent or not.

Returns:

a boolean.