br.com.arsmachina.tapestrycrud.module
Interface TapestryCrudModule

All Known Implementing Classes:
DefaultTapestryCrudModule

public interface TapestryCrudModule

Interface that defines information about a module, whatever its conventions are.

Author:
Thiago H. de Paula Figueiredo

Method Summary
<T> Class<? extends ActivationContextEncoder<T>>
getActivationContextEncoderClass(Class<T> entityClass)
          Returns the activation context encoder class corresponding to a given entity class.
<T> Class<? extends Encoder<T,?>>
getEncoderClass(Class<T> entityClass)
          Returns the encoder class corresponding to a given entity class.
<T> Class<? extends LabelEncoder<T>>
getLabelEncoderClass(Class<T> entityClass)
          Returns the label encoder class corresponding to a given entity class.
 String getName()
          Returns the module name.
<T> Class<? extends PrimaryKeyEncoder<?,T>>
getPrimaryKeyEncoderClass(Class<T> entityClass)
          Returns the label encoder class corresponding to a given entity class.
 

Method Detail

getActivationContextEncoderClass

<T> Class<? extends ActivationContextEncoder<T>> getActivationContextEncoderClass(Class<T> entityClass)
Returns the activation context encoder class corresponding to a given entity class.

Type Parameters:
T - the entity type.
Parameters:
entityClass - a Class instance. It cannot be null.
Returns:
an ActivationContextEncoder or null (if no corresponding one is found).

getEncoderClass

<T> Class<? extends Encoder<T,?>> getEncoderClass(Class<T> entityClass)
Returns the encoder class corresponding to a given entity class.

Type Parameters:
T - the entity type.
Parameters:
entityClass - a Class instance. It cannot be null.
Returns:
an Encoder or null (if no corresponding one is found).

getLabelEncoderClass

<T> Class<? extends LabelEncoder<T>> getLabelEncoderClass(Class<T> entityClass)
Returns the label encoder class corresponding to a given entity class.

Type Parameters:
T - the entity type.
Parameters:
entityClass - a Class instance. It cannot be null.
Returns:
a LabelEncoder or null (if no corresponding one is found).

getPrimaryKeyEncoderClass

<T> Class<? extends PrimaryKeyEncoder<?,T>> getPrimaryKeyEncoderClass(Class<T> entityClass)
Returns the label encoder class corresponding to a given entity class.

Type Parameters:
T - the entity type.
Parameters:
entityClass - a Class instance. It cannot be null.
Returns:
a PrimaryKeyEncoder or null (if no corresponding one is found).

getName

String getName()
Returns the module name. Just used for logging and debugging purposes.

Returns:
a String.


Copyright © 2008-2009 Thiago H. de Paula Figueiredo. All Rights Reserved.