org.appfuse.service

Interface GenericManager<T,PK extends Serializable>

Type Parameters:

T - a type variable

PK - the primary key for that type

All Known Subinterfaces:

RoleManager, UserManager

All Known Implementing Classes:

GenericManagerImpl, RoleManagerImpl, UserManagerImpl

public interface GenericManager<T,PK extends Serializable>

Generic Manager that talks to GenericDao to CRUD POJOs.

Extend this interface if you want typesafe (no casting necessary) managers for your domain objects.

Author:

Matt Raible Updated by jgarcia: added full text search + reindexing

Method Summary

Methods

Modifier and Type	Method and Description
boolean	exists(PK id) Checks for existence of an object of type T using the id arg.
T	get(PK id) Generic method to get an object based on class and identifier.
List<T>	getAll() Generic method used to get all objects of a particular type.
void	reindex() Generic method to regenerate full text index of the persistent class T
void	reindexAll(boolean async) Generic method to regenerate full text index of all indexed classes
void	remove(PK id) Generic method to delete an object based on class and id
void	remove(T object) Generic method to delete an object
T	save(T object) Generic method to save an object - handles both update and insert.
List<T>	search(String searchTerm, Class clazz) Generic method to search for an object.

Method Detail

getAll

List<T> getAll()

Generic method used to get all objects of a particular type. This is the same as lookup up all rows in a table.

Returns:

List of populated objects

get

T get(PK id)

Generic method to get an object based on class and identifier. An ObjectRetrievalFailureException Runtime Exception is thrown if nothing is found.

Parameters:

id - the identifier (primary key) of the object to get

Returns:

a populated object

See Also:

ObjectRetrievalFailureException

exists

boolean exists(PK id)

Checks for existence of an object of type T using the id arg.

Parameters:

id - the identifier (primary key) of the object to get

Returns:

- true if it exists, false if it doesn't

save

T save(T object)

Generic method to save an object - handles both update and insert.

Parameters:

object - the object to save

Returns:

the updated object

remove

void remove(T object)

Generic method to delete an object

Parameters:

object - the object to remove

remove

void remove(PK id)

Generic method to delete an object based on class and id

Parameters:

id - the identifier (primary key) of the object to remove

search

List<T> search(String searchTerm,
             Class clazz)

Generic method to search for an object.

Parameters:

searchTerm - the search term

clazz - type of class to search for.

Returns:

a list of matched objects

reindex

void reindex()

Generic method to regenerate full text index of the persistent class T

reindexAll

void reindexAll(boolean async)

Generic method to regenerate full text index of all indexed classes

Parameters:

async - true to perform the reindexing asynchronously