org.josef.ejb.crud

Interface CrudControllerRemote

All Known Subinterfaces:

CrudControllerLocal

All Known Implementing Classes:

CrudControllerBean

public interface CrudControllerRemote

Remote interface to CrudControllerBean.

Version:

1.0 $Revision: 5389 $

Author:

Kees Schotanus

Method Summary

Modifier and Type	Method and Description
<T> T	findById(Class<T> type, Number primaryKey) Finds a persisted entity by its primary key.
<T> List<T>	findByNamedQuery(Class<T> type, String queryName, Map<String,Object> queryParameters) Finds entities using a named query with the supplied queryName.
<T> T	merge(T entity) Merges the supplied entity with the persisted state of the supplied entity.
<T> T	persist(T entity) Persists (creates) the supplied entity.
<T> void	remove(Class<T> type, Number primaryKey) Removes a previously persisted entity.
String	testRemote() Simple test method to verify this controller works using a remote call.

Method Detail

testRemote

String testRemote()

Simple test method to verify this controller works using a remote call.

Returns:

"Remote!".

persist

<T> T persist(T entity)

Persists (creates) the supplied entity.

Type Parameters:

T - The type of entity to persist.

Parameters:

entity - The entity to persist.

Returns:

The persisted entity.

Throws:

NullPointerException - When the supplied entity is null.

findById

<T> T findById(Class<T> type,
               Number primaryKey)

Finds a persisted entity by its primary key.

Type Parameters:

T - The type of the entity to find.

Parameters:

type - The class type of the entity to find.

primaryKey - The primary key of the entity to find.

Returns:

The entity with the supplied primaryKey or null when no entity with the supplied primary key exists.

Throws:

NullPointerException - When either the supplied type or the supplied primaryKey is null.

merge

<T> T merge(T entity)

Merges the supplied entity with the persisted state of the supplied entity.

Type Parameters:

T - The type of the entity to merge.

Parameters:

entity - The entity to merge.

Returns:

A copy of the merged state of the supplied entity.

Throws:

NullPointerException - When the supplied entity is null.

remove

<T> void remove(Class<T> type,
                Number primaryKey)

Removes a previously persisted entity.

Type Parameters:

T - The type of the entity to remove.

Parameters:

type - The class type of the entity to remove.

primaryKey - The primary key of the entity to remove.

Throws:

NullPointerException - When either the supplied type or primaryKey is null.

findByNamedQuery

<T> List<T> findByNamedQuery(Class<T> type,
                             String queryName,
                             Map<String,Object> queryParameters)

Finds entities using a named query with the supplied queryName.

Type Parameters:

T - The type of the entities to find.

Parameters:

type - The class type of the entities to find.

queryName - Name of the named query.

queryParameters - Query parameters of the named query or null when no query parameters exist.

Returns:

List of entities of the supplied type.

Throws:

NullPointerException - When the supplied type is null.