org.springframework.roo.addon.web.mvc.controller.addon.finder

Interface WebFinderOperations

All Known Implementing Classes:

WebFinderOperationsImpl

public interface WebFinderOperations

Provides operations for Web MVC finder functionality.

Since:

1.2.0

Author:

Stefan Schmidt, Paula Navarro

Method Summary

Modifier and Type	Method and Description
void	createOrUpdateSearchControllerForAllEntities(ControllerMVCResponseService responseType, org.springframework.roo.model.JavaPackage controllerPackage, String pathPrefix) Creates or updates all controllers with it's associated entities query methods.
void	createOrUpdateSearchControllerForEntity(org.springframework.roo.model.JavaType entity, List<String> queryMethods, ControllerMVCResponseService responseType, org.springframework.roo.model.JavaPackage controllerPackage, String pathPrefix) Creates or updates the controller associated to specified entity with the specified query methods.
List<String>	getFindersWhichCanBePublish(org.springframework.roo.model.JavaType entity, ControllerMVCResponseService responseType) Returns finders names which can be publish
List<String>	getFindersWhichCanBePublish(org.springframework.roo.addon.layers.repository.jpa.addon.RepositoryJpaMetadata repositoryMetadata, ControllerMVCResponseService responseType) Returns finders names which can be publish
boolean	isWebFinderInstallationPossible()

Method Detail

isWebFinderInstallationPossible

boolean isWebFinderInstallationPossible()

createOrUpdateSearchControllerForEntity

void createOrUpdateSearchControllerForEntity(org.springframework.roo.model.JavaType entity,
                                             List<String> queryMethods,
                                             ControllerMVCResponseService responseType,
                                             org.springframework.roo.model.JavaPackage controllerPackage,
                                             String pathPrefix)

Creates or updates the controller associated to specified entity with the specified query methods.

Parameters:

entity - the JavaType representing the entity which associated repository has the finders to publish in web layer.

queryMethods - the List of finder names to publish in web layer.

responseType - the ControllerMVCResponseService to be used by generated controller.

controllerPackage - the JavaPackage where controller should be generated.

pathPrefix - the String with the default controller path for finder requests.

createOrUpdateSearchControllerForAllEntities

void createOrUpdateSearchControllerForAllEntities(ControllerMVCResponseService responseType,
                                                  org.springframework.roo.model.JavaPackage controllerPackage,
                                                  String pathPrefix)

Creates or updates all controllers with it's associated entities query methods.

Parameters:

responseType - the ControllerMVCResponseService to be used by generated controllers.

controllerPackage - the JavaPackage where controllers should be generated.

pathPrefix - the String with the default controller paths for finder requests.

getFindersWhichCanBePublish

List<String> getFindersWhichCanBePublish(org.springframework.roo.model.JavaType entity,
                                         ControllerMVCResponseService responseType)

Returns finders names which can be publish

Parameters:

entity -

responseType - (optional, can be null)

Returns:

getFindersWhichCanBePublish

List<String> getFindersWhichCanBePublish(org.springframework.roo.addon.layers.repository.jpa.addon.RepositoryJpaMetadata repositoryMetadata,
                                         ControllerMVCResponseService responseType)

Returns finders names which can be publish

Parameters:

repositoryMetadata -

responseType -

Returns: