ControllerOperations.java

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

import java.util.List;

import org.springframework.roo.addon.jpa.addon.entity.JpaEntityMetadata;
import org.springframework.roo.addon.web.mvc.controller.addon.responses.ControllerMVCResponseService;
import org.springframework.roo.addon.web.mvc.controller.annotations.RooController;
import org.springframework.roo.addon.web.mvc.controller.annotations.finder.RooSearch;
import org.springframework.roo.classpath.details.ClassOrInterfaceTypeDetails;
import org.springframework.roo.model.JavaPackage;
import org.springframework.roo.model.JavaType;
import org.springframework.roo.project.Feature;
import org.springframework.roo.project.FeatureNames;
import org.springframework.roo.project.maven.Pom;

/**
 * Provides an API with the available Operations to include Spring MVC on
 * generated project and generate new controllers.
 *
 * @author Ben Alex
 * @author Stefan Schmidt
 * @author Juan Carlos García
 * @author Paula Navarro
 */
public interface ControllerOperations extends Feature {

  public static final String FEATURE_NAME = FeatureNames.MVC;

  /**
   * This operation will check if setup operation is available
   *
   * @return true if setup operation is available. false if not.
   */
  boolean isSetupAvailable();

  /**
   * This operation will setup Spring MVC on generated project.
   *
   * @param module
   *            Pom module where Spring MVC should be included
   * @param usesDefaultModule
   * 			boolean that indicates if the setup command is using the default 
   * 			application module
   */
  void setup(Pom module, boolean usesDefaultModule);

  /**
   * This operation will check if add controllers operation is available
   *
   * @return true if add controller operation is available. false if not.
   */
  boolean isAddControllerAvailable();

  /**
   * This operation will check if add detail controllers operation is available
   *
   * @return true if add detail controller operation is available. false if not.
   */
  boolean isAddDetailControllerAvailable();

  /**
   * This operation will check if the operation publish services methods is available
   *
   * @return true if publish services methods is available. false if not.
   */
  boolean isPublishOperationsAvailable();


  /**
   * This operation will generate or update a controller for every class
   * annotated with @RooJpaEntity
   *
   * @param responseType
   *            View provider to use
   * @param controllerPackage
   *            Package where is situated the controller
   * @param pathPrefix
   *            Prefix to use in RequestMapping
   */
  void createOrUpdateControllerForAllEntities(ControllerMVCResponseService responseType,
      JavaPackage controllerPackage, String pathPrefix);

  /**
   * This operation will generate or update a controller for a specified
   * entity
   *
   * @param entity
   *            Entity over which create the controller
   * @param responseType
   *            View provider to use
   * @param controllerPackage
   *            Package where is situated the controller
   * @param pathPrefix
   *            Prefix to use in RequestMapping
   */
  void createOrUpdateControllerForEntity(JavaType entity,
      ControllerMVCResponseService responseType, JavaPackage controllerPackage, String pathPrefix);

  /**
   * This operation will generate or update a first level detail controller
   * for every class annotated with @RooJpaEntity that has defined a @RooController
   *
   * @param responseType
   *            View provider to use
   * @param controllerPackage
   *            Package where is situated the controller
   * @param viewsList Separated comma list of all parent views where the new detail 
   * 			will be displayed
   */
  void createOrUpdateDetailControllersForAllEntities(ControllerMVCResponseService responseType,
      JavaPackage controllerPackage, String viewsList);

  /**
   * This operation will generate or update a level detail controller for a
   * specified field located in specified entity
   *
   * @param entity
   *            Entity over which create the controller
   * @param relationField
   * 			Field that set the relationship
   * @param responseType
   *            View provider to use
   * @param controllerPackage
   *            Package where is situated the controller
   * @param viewsList Separated comma list of all parent views where the new detail 
   * 			will be displayed
   */
  void createOrUpdateDetailControllerForEntity(JavaType entity, String relationField,
      ControllerMVCResponseService responseType, JavaPackage controllerPackage, String viewsList);

  /**
   * Get all the methods that can be published from the service or the controller established by parameter
   *
   * @param currentService Service from which obtain methods
   * @param currentController Controller from which obtain methods
   * @return methods names list
   */
  public List<String> getAllMethodsToPublish(String currentService, String currentController);

  /**
   * Generate the operations selected in the controller indicated
   *
   * @param controller Controller where the operations will be created
   * @param operations Service operations names that will be created
   */
  public void exportOperation(JavaType controller, List<String> operations);

  /**
   * Return a list of {@link RelationInfoExtended} for a field relation path of a entity.
   *
   * path is split by dot char and every return item is information for every path element.
   *
   * by example: entity could be Customer and path "order.details"
   *
   * @param entity
   * @param path
   * @return list of infos
   * @throws NullPointerException if entity is null
   * @throws IllegalArgumentException if path is incorrect
   */
  public List<RelationInfoExtended> getRelationInfoFor(JavaType entity, String path);

  /**
   * Return a list of {@link RelationInfoExtended} for a field relation path of a entity.
   *
   * path is split by dot char and every return item is information for every path element.
   *
   * by example: entity could be Customer and path "order.details"
   *
   * @param entity
   * @param path
   * @return
   */
  public List<RelationInfoExtended> getRelationInfoFor(JpaEntityMetadata entity, String path);

  /**
   * Gets base Path for referenced controller
   *
   * @param controller JavaType correctly annotated with {@link RooController}
   * @return
   */
  public String getBasePathForController(JavaType controller);

  /**
   * Gets base Path for referenced controller
   *
   * @param controller details correctly annotated with {@link RooController}
   * @return
   */
  public String getBasePathForController(ClassOrInterfaceTypeDetails controller);

  /**
   * Gets base URL for referenced controller
   *
   * @param controller JavaType correctly annotated with {@link RooController}
   * @return
   */
  public String getBaseUrlForController(JavaType controller);

  /**
   * Gets base URL for referenced controller
   *
   * @param controller details correctly annotated with {@link RooController}
   * @return
   */
  public String getBaseUrlForController(ClassOrInterfaceTypeDetails controller);

  /**
   * Gets finder base URL for referenced controller
   *
   * @param controller JavaType correctly annotated with {@link RooController} and {@link RooSearch}
   * @param finder target. Should be one of {@link RooSearch#finders()}
   * @return
   */
  public String getBaseUrlControllerForFinder(JavaType controller, String finder);

  /**
   * Gets finder base URL for referenced controller
   *
   * @param controller details correctly annotated with {@link RooController} and {@link RooSearch}
   * @param finder target. Should be one of {@link RooSearch#finders()}
   * @return
   */
  public String getBaseUrlControllerForFinder(ClassOrInterfaceTypeDetails controller, String finder);

  /**
   * Method that creates a new LinkFactory class related to the provided controller
   * 
   * @param controller
   */
  void createLinkFactoryClass(JavaType controller);

}