org.springframework.roo.addon.web.mvc.controller.annotations.scaffold

Annotation Type RooWebScaffold

@Retention(value=SOURCE)
 @Target(value=TYPE)
public @interface RooWebScaffold

Indicates a type that requires ROO controller support.

This annotation will cause ROO to produce code that would typically appear in MVC controllers. Importantly, such code does NOT depend on any singletons and is intended to safely serialise. In the current release this code will be emitted to an ITD.

The following functionality will be introduced in the ITD:

• The Spring MVC org.springframework.stereotype.Controller annotation will be declared on the controller type if not exists
• Setting this annotation will also generate JSP view pages corresponding to the functionalities included
• The formBackingObject() property defines the persistent type which is exposed through this controller

There are two cases in which ROO will not emit one or more of the above artifacts:

• The user provides the equivalent methods on the controller object itself
• A specific RooWebScaffold annotation value indicates the desired output type should not be emitted (all emit by default)

Since:

1.0

Author:

Stefan Schmidt

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<?>	formBackingObject Every controller is responsible for a single form backing object.
String	path All view-related artifacts for a specific controller are stored in a sub-directory under WEB-INF/views/path.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	create Creates a create() method which allows the creation of a new entity.
boolean	delete Creates a delete() method which deletes an entity for a given id.
boolean	exposeFinders Deprecated.
boolean	exposeJson Deprecated.
boolean	populateMethods Indicate if Roo should create data population methods used for model attributes required for the Spring MVC forms.
boolean	update Creates an update() method which allows alteration of an existing entity.

Element Detail

formBackingObject

public abstract Class<?> formBackingObject

Every controller is responsible for a single form backing object. The form backing object defined here class will be exposed in a RESTful way.

path

public abstract String path

All view-related artifacts for a specific controller are stored in a sub-directory under WEB-INF/views/path. The path parameter defines the name of this sub-directory or path. This path is also used to define the restful resource in the URL to which the controller is mapped.

Returns:

The view path.

create

public abstract boolean create

Creates a create() method which allows the creation of a new entity.

Returns:

indicates if the create() method should be provided (defaults to "true"; optional)

Default:

true

delete

public abstract boolean delete

Creates a delete() method which deletes an entity for a given id.

Returns:

indicates if the delete() method should be provided (defaults to "true"; optional)

Default:

true

exposeFinders

@Deprecated
public abstract boolean exposeFinders

Deprecated.

This flag is not used any more as of Roo 1.2.0. Please annotate controller types with RooSearch instead. (Was: Will scan the formBackingObjects for installed finder methods and expose them when configured.)

Returns:

indicates if the finders methods should be provided (defaults to "true"; optional)

Default:

true

exposeJson

@Deprecated
public abstract boolean exposeJson

Deprecated.

This flag is not used any more as of Roo 1.2.0. Please annotate controller types with org.springframework.roo.addon.web.mvc.controller.annotations.json.RooWebJson instead. (Was: Will scan the formBackingObjects for org.springframework.roo.addon.json.annotations.RooJson annotation and expose json when configured.)

Returns:

indicates if the json methods should be provided (defaults to "true"; optional)

Default:

true

populateMethods

public abstract boolean populateMethods

Indicate if Roo should create data population methods used for model attributes required for the Spring MVC forms. If this flag is set to false the developer is expected to manage the population of the model attributes by himself.

Returns:

indicates if the populateXXX() methods should be provided (defaults to "true"; optional)

Default:

true

update

public abstract boolean update

Creates an update() method which allows alteration of an existing entity.

Returns:

indicates if the update() method should be provided (defaults to "true"; optional)

Default:

true