MVCViewGenerationService.java

package org.springframework.roo.addon.web.mvc.views;

import java.util.List;
import java.util.Map;

import org.springframework.roo.addon.jpa.addon.entity.JpaEntityMetadata;
import org.springframework.roo.addon.web.mvc.controller.addon.ControllerMetadata;
import org.springframework.roo.classpath.scanner.MemberDetails;
import org.springframework.roo.model.JavaType;

/**
 *
 * This interface will provide necessary operations to be able to
 * generate views.
 *
 * All component or service that wants to include some new view inside
 * generated project will delegate in this interface to include them.
 *
 * @author Juan Carlos García
 * @since 2.0
 */
public interface MVCViewGenerationService<T extends AbstractViewMetadata> {

  public static final String FIELD_SUFFIX = "field";
  public static final String TABLE_SUFFIX = "entity";
  public static final String DETAIL_SUFFIX = "detail";
  public static final String FINDER_SUFFIX = "finder";

  /**
   * Return JavaType which identifies the view Type (usually annotation java type)
   *
   * @return
   */
  JavaType getType();

  /**
   * This operation returns the unique identifier name of
   * a MVCViewGenerationService
   *
   * @return String with an unique identifier name
   */
  String getName();

  /**
   * This operation returns the view folder of the specified module, where views
   * will be included.
   *
   * @param moduleName module where view folder is located
   * @return String with the views folder path
   */
  String getViewsFolder(String moduleName);

  /**
   * This operation returns the file extension to use
   * on generated views.
   *
   * @return String with the file extension
   */
  String getViewsExtension();

  /**
   * This operation returns the folder where layouts
   * will be included.
   *
   * @return String with the views folder path
   */
  String getLayoutsFolder(String moduleName);

  /**
   * This operation returns the folder where fragment will be included.
   * If needed.
   *
   * @return String with the views folder path
   */
  String getFragmentsFolder(String moduleName);

  /**
   * This operation will add a list view using entityDetails
   * and the provided context
   *
   * @param moduleName module where list view will be added
   * @param entityMetadata entity metadata which contains information about it
   * @param entity Details of an entity to be able to generate view
   * @param detailsControllers list of related details controller to include
   * @param ctx ViewContext that contains necessary information about
   *            the controller, the project, etc...
   */
  void addListView(String moduleName, JpaEntityMetadata entityMetadata, MemberDetails entity,
      List<T> detailsControllers, ViewContext<T> ctx);


  /**
   * This operation will add a list view to be displayed inside a confirmation 
   * modal dialog during the deletion process.
   * 
   * @param moduleName module where list view will be added
   * @param entityMetadata entity metadata which contains information about it
   * @param entity Details of an entity to be able to generate view
   * @param ctx ViewContext that contains necessary information about
   *            the controller, the project, etc...
   */
  void addListDeleteModalView(String moduleName, JpaEntityMetadata entityMetadata,
      MemberDetails entity, ViewContext<T> ctx);

  void addListDeleteModalDetailView(String moduleName, JpaEntityMetadata entityMetadata,
      MemberDetails entity, ControllerMetadata controllerMetadata, ViewContext<T> ctx);

  /**
   * This operation will add a list view to be displayed inside a confirmation 
   * modal dialog during the batch deletion process
   * 
   * @param moduleName module where list view will be added
   * @param entityMetadata entity metadata which contains information about it
   * @param entity Details of an entity to be able to generate view
   * @param ctx ViewContext that contains necessary information about
   *            the controller, the project, etc...
   */
  void addListDeleteModalBatchView(String moduleName, JpaEntityMetadata entityMetadata,
      MemberDetails entity, ViewContext<T> ctx);

  void addListDeleteModalDetailBatchView(String moduleName, JpaEntityMetadata entityMetadata,
      MemberDetails entity, ControllerMetadata controllerMetadata, ViewContext<T> ctx);

  /**
   * This operation will add a show view using entityDetails
   * and the provided context
   *
   * @param moduleName module where show view will be added
   * @param entityMetadata entity metadata which contains information about it
   * @param entity Details of an entity to be able to generate view
   * @param detailsControllers list of related details controller to include
   * @param ctx ViewContext that contains necessary information about
   *            the controller, the project, etc...
   */
  void addShowView(String moduleName, JpaEntityMetadata entityMetadata, MemberDetails entity,
      List<T> detailsControllers, ViewContext<T> ctx);

  /**
   * This operation will add a showInline view using entityDetails
   * and the provided context
   *
   * @param moduleName module where show view will be added
   * @param entityMetadata entity metadata which contains information about it
   * @param entity Details of an entity to be able to generate view
   * @param detailsControllers list of related details controller to include
   * @param ctx ViewContext that contains necessary information about
   *            the controller, the project, etc...
   */
  void addShowInlineView(String moduleName, JpaEntityMetadata entityMetadata, MemberDetails entity,
      ViewContext<T> ctx);

  /**
   * This operation will add views related to a details controller using entityDetails
   * and the provided context
   *
   * @param moduleName module where create view will be added
   * @param entityMetadata entity metadata which contains information about it
   * @param entity Details of an entity to be able to generate view
   * @param controllerMetadata controller metadata
   * @param viewMetadata
   * @param ctx ViewContext that contains necessary information about
   *            the controller, the project, etc...
   */
  void addDetailsViews(String moduleName, JpaEntityMetadata entityMetadata, MemberDetails entity,
      ControllerMetadata controllerMetadata, T viewMetadata, ViewContext<T> ctx);

  /**
   * This operation will add views related to a details item controller using entityDetails
   * and the provided context
   *
   * @param moduleName module where create view will be added
   * @param entityMetadata entity metadata which contains information about it
   * @param entity Details of an entity to be able to generate view
   * @param controllerMetadata controller metadata
   * @param viewMetadata
   * @param ctx ViewContext that contains necessary information about
   *            the controller, the project, etc...
   */
  void addDetailsItemViews(String moduleName, JpaEntityMetadata entityMetadata,
      MemberDetails entity, ControllerMetadata controllerMetadata, T viewMetadata,
      ViewContext<T> ctx);

  /**
   * This operation will add a create view using entityDetails
   * and the provided context
   *
   * @param moduleName module where create view will be added
   * @param entityMetadata entity metadata which contains information about it
   * @param entity Details of an entity to be able to generate view
   * @param ctx ViewContext that contains necessary information about
   *            the controller, the project, etc...
   */
  void addCreateView(String moduleName, JpaEntityMetadata entityMetadata, MemberDetails entity,
      ViewContext<T> ctx);

  /**
   * This operation will add an update view using entityDetails
   * and the provided context
   *
   * @param moduleName module where update view will be added
   * @param entityMetadata entity metadata which contains information about it
   * @param entity Details of an entity to be able to generate view
   * @param ctx ViewContext that contains necessary information about
   *            the controller, the project, etc...
   */
  void addUpdateView(String moduleName, JpaEntityMetadata entityMetadata, MemberDetails entity,
      ViewContext<T> ctx);

  /**
   * This operation will add a finder form view using entityDetails and the
   * provided context
   *
   * @param moduleName the module where finder form view will be added
   * @param entityMetadata entity metadata which contains information about it
   * @param viewMetadata
   * @param formBean the type that should provided by the model when the form view loads
   * @param finderName the name of the finder for which this form will be created
   * @param ctx the ViewContext that contains necessary information about
   *            the controller, the project, etc...
   */
  void addFinderFormView(String moduleName, JpaEntityMetadata entityMetadata, T viewMetadata,
      JavaType formBean, String finderName, ViewContext<T> ctx);

  /**
   * This operation will add a finder list view using entityDetails and the
   * provided context. This view will show finder result list
   *
   * @param moduleName the module where finder list view will be added
   * @param entityMetadata entity metadata which contains information about it
   * @param entity Details of an entity to be able to generate view
   * @param viewMetadata
   * @param returnType the JavaType that will be returned by this list view.
   * @param finderName the name of the finder for which this form will be created
   * @param detailsControllers list of related details controller to include
   * @param ctx the ViewContext that contains necessary information about
   *            the controller, the project, etc...
   */
  void addFinderListView(String moduleName, JpaEntityMetadata entityMetadada, MemberDetails entity,
      T viewMetadata, JavaType formBean, JavaType returnType, String finderName,
      List<T> detailsControllers, ViewContext<T> ctx);

  /**
   * This operation will add the application index view using
   * the provided context
   *
   * @param moduleName module where index view will be added
   * @param ctx ViewContext that contains necessary information about
   *            the controller, the project, etc...
   */
  void addIndexView(String moduleName, ViewContext<T> ctx);

  /**
   * This operation will add the login view using the provided
   * context
   *
   * @param moduleName module where index view will be added
   * @param ctx ViewContext that contains necessary information about
   *            the controller, the project, etc...
   */
  void addLoginView(String moduleName, ViewContext<T> ctx);

  /**
   * This operation will add the application accessibility view using
   * the provided context
   *
   * @param moduleName module where index view will be added
   * @param ctx ViewContext that contains necessary information about
   *            the controller, the project, etc...
   */
  void addAccessibilityView(String moduleName, ViewContext<T> ctx);

  /**
   * This operation will add the application error view using
   * the provided context
   *
   * @param ctx ViewContext that contains necessary information about
   *            the controller, the project, etc...
   */
  void addErrorView(String moduleName, ViewContext<T> ctx);


  /**
   * This operation will add the default-layout view using
   * the provided context
   *
   * @param moduleName module where default view will be added
   * @param ctx ViewContext that contains necessary information about
   *            the controller, the project, etc...
   */
  void addDefaultLayout(String moduleName, ViewContext<T> ctx);

  /**
   * This operation will add the default-layout-no-menu view using
   * the provided context
   *
   * @param moduleName module where default view will be added
   * @param ctx ViewContext that contains necessary information about
   *            the controller, the project, etc...
   */
  void addDefaultLayoutNoMenu(String moduleName, ViewContext<T> ctx);

  /**
   * This operation will add the home-layout view using
   * the provided context
   *
   * @param moduleName module where default view will be added
   * @param ctx ViewContext that contains necessary information about
   *            the controller, the project, etc...
   */
  void addHomeLayout(String moduleName, ViewContext<T> ctx);

  /**
   * This operation will add the footer fragment using
   * the provided context
   *
   * @param moduleName module where footer fragment will be added
   * @param ctx ViewContext that contains necessary information about
   *            the controller, the project, etc...
   */
  void addFooter(String moduleName, ViewContext<T> ctx);

  /**
   * This operation will add the header fragment using
   * the provided context
   *
   * @param moduleName module where header fragment will be added
   * @param ctx ViewContext that contains necessary information about
   *            the controller, the project, etc...
   */
  void addHeader(String moduleName, ViewContext<T> ctx);

  /**
   * This operation will add the menu fragment using
   * the provided context
   *
   * @param moduleName module where menu fragment will be added
   * @param ctx ViewContext that contains necessary information about
   *            the controller, the project, etc...
   */
  void addMenu(String moduleName, ViewContext<T> ctx);

  /**
   * This operation will add the modal fragment using
   * the provided context
   *
   * @param moduleName module where session fragment will be added
   * @param ctx ViewContext that contains necessary information about
   *            the controller, the project, etc...
   */
  void addModal(String moduleName, ViewContext<T> ctx);


  /**
   * This operation will add the modal-confirm fragment using
   * the provided context
   *
   * @param moduleName module where session fragment will be added
   * @param ctx ViewContext that contains necessary information about
   *            the controller, the project, etc...
   */
  void addModalConfirm(String moduleName, ViewContext<T> ctx);


  /**
   * This operation will add the session-links fragment using
   * the provided context
   *
   * @param moduleName module where session fragment will be added
   * @param ctx ViewContext that contains necessary information about
   *            the controller, the project, etc...
   */
  void addSessionLinks(String moduleName, ViewContext<T> ctx);

  /**
   * This operation will add the languages fragment using
   * the provided context
   *
   * @param moduleName module where session fragment will be added
   * @param ctx ViewContext that contains necessary information about
   *            the controller, the project, etc...
   */
  void addLanguages(String moduleName, ViewContext<T> ctx);

  /**
   * This operation will updates menu view.
   *
   * TODO: Maybe, instead of modify all menu view, only new generated controller should
   * be included on it. Must be fixed on future versions.
   *
   * @param moduleName module where menu view is located
   * @param ctx ViewContext that contains necessary information about
   *            the controller, the project, etc...
   */
  void updateMenuView(String moduleName, ViewContext<T> ctx);

  /**
   * This operation will install all necessary templates on generated project.
   * With that, Spring Roo users will be able to customize the Spring Roo templates
   * to be able to generate views with their custom code.
   */
  void installTemplates();

  /**
   * Get labels to add or update in i18n system for a specific entity
   *
   * @param entityMemberDetails
   * @param entity
   * @param entityMetadata
   * @param controllerMetadata
   * @param module
   * @param ctx
   * @return
   */
  Map<String, String> getI18nLabels(MemberDetails entityMemberDetails, JavaType entity,
      JpaEntityMetadata entityMetadata, ControllerMetadata controllerMetadata, String module,
      ViewContext<T> ctx);

  /**
   * Create a view Context for controller
   *
   * @param controllerMetadata
   * @param entity
   * @param entityMetadata
   * @param viewMetadata
   * @return
   */
  ViewContext<T> createViewContext(ControllerMetadata controllerMetadata, JavaType entity,
      JpaEntityMetadata entityMetadata, T viewMetadata);

  /**
   * Return the templates base path
   */
  String getTemplatesLocation();
}