// Copyright 2008 Thiago H. de Paula Figueiredo

 //

 // Licensed under the Apache License, Version 2.0 (the "License");

 // you may not use this file except in compliance with the License.

 // You may obtain a copy of the License at

 //

 //     http://www.apache.org/licenses/LICENSE-2.0

 //

 // Unless required by applicable law or agreed to in writing, software

 // distributed under the License is distributed on an "AS IS" BASIS,

 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 // See the License for the specific language governing permissions and

 // limitations under the License.

 package br.com.arsmachina.tapestrycrud.services;

 import java.util.Set;

 import org.apache.tapestry5.PrimaryKeyEncoder;

 import br.com.arsmachina.module.Module;

 import br.com.arsmachina.tapestrycrud.encoder.ActivationContextEncoder;

 import br.com.arsmachina.tapestrycrud.encoder.LabelEncoder;

 import br.com.arsmachina.tapestrycrud.module.TapestryCrudModule;

 /**

  * Service that provides module-related methods.

  * 

  * @see Module

  * @author Thiago H. de Paula Figueiredo

  */

 public interface TapestryCrudModuleService {

         /**

          * Returns the set of all modules.

          * 

          * @return a {@link Set} of {@link TapestryCrudModule}s.

          */

         Set<TapestryCrudModule> getModules();

         /**

          * Returns the activation context encoder class corresponding to a given entity class.

          * 

          * @param <T> the entity type.

          * @param entityClass a {@link Class} instance. It cannot be null.

          * @return an {@link Class} or null (if no corresponding one is found).

          */

         <T> Class<? extends ActivationContextEncoder<T>> getActivationContextEncoderClass(

                         Class<T> entityClass);

         /**

          * Returns the encoder class corresponding to a given entity class.

          * 

          * @param <T> the entity type.

          * @param entityClass a {@link Class} instance. It cannot be null.

          * @return an {@link Class} or null (if no corresponding one is found).

          */

         <T> Class<? extends ActivationContextEncoder<T>> getEncoderClass(

                         Class<T> entityClass);

         /**

          * Returns the label encoder class corresponding to a given entity class.

          * 

          * @param <T> the entity type.

          * @param entityClass a {@link Class} instance. It cannot be null.

          * @return a {@link Class} or null (if no corresponding one is found).

          */

         <T> Class<? extends LabelEncoder<T>> getLabelEncoderClass(Class<T> entityClass);

         /**

          * Returns the primary key encoder class corresponding to a given entity class.

          * 

          * @param <T> the entity type.

          * @param entityClass a {@link Class} instance. It cannot be null.

          * @return a {@link Class} or null (if no corresponding one is found).

          */

         <T> Class<? extends PrimaryKeyEncoder<?, T>> getPrimaryKeyEncoderClass(Class<T> entityClass);

 }