org.kuali.rice.krad.uif.service
Interface ViewService

All Known Implementing Classes:

ViewServiceImpl

public interface ViewService

Provides service methods for retrieving and updating View instances. The UIF interacts with this service from the client layer to pull information from the View dictionary and manage the View instance through its lifecycle

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

void	buildView(View view, Object model) Applies updates to the view based on the model data.
View	getView(String viewId, Map<String,String> parameters) Returns the View entry identified by the given id
View	getViewById(String viewId) Returns the View entry identified by the given id
View	getViewByType(String viewType, Map<String,String> parameters) Retrieves the View instance that is of the given view type and matches the given parameters (that are applicable for that type).
ViewTypeService	getViewTypeService(String viewType)
View	rebuildView(String viewId, Object model, Map<String,String> viewRequestParameters) Returns the View entry identified by the given id and runs through the complete lifecycle.

Method Detail

getViewById

View getViewById(String viewId)

Returns the View entry identified by the given id

The id matches the id configured for the View through the dictionary. The view is initialized before being returned

Parameters:

viewId - - unique id for view configured on its definition

Returns:

View instance associated with the id or Null if id is not found

getView

View getView(String viewId,
             Map<String,String> parameters)

Returns the View entry identified by the given id

The id matches the id configured for the View through the dictionary. The view is initialized before being returned

Any configuration sent through the options Map is used to initialize the View. This map contains present options the view is aware of and will typically come from request parameters. e.g. For maintenance Views there is the maintenance type option (new, edit, copy)

Parameters:

viewId - - unique id for view configured on its definition

parameters - - Map of key values pairs that provide configuration for the View, this is generally comes from the request and can be the request parameter Map itself. Any parameters not valid for the View will be filtered out

Returns:

View instance associated with the id or Null if id is not found

getViewByType

View getViewByType(String viewType,
                   Map<String,String> parameters)

Retrieves the View instance that is of the given view type and matches the given parameters (that are applicable for that type). If more than one views exists for the type and parameters, the view type may choose a default or throw an exception

Parameters:

viewType - - name that identifies the view type

parameters - - Map of parameter key/value pairs that are used to select the view, the parameters allowed depend on the view type

Returns:

View instance or Null if a matching view was not found

buildView

void buildView(View view,
               Object model)

Applies updates to the view based on the model data. Should be called to finalize the view before rendering

Performs dynamic generation of fields (such as collection rows), conditional logic, and state updating (conditional hidden, read-only, required).

Parameters:

view - - view instance to update

model - - Top level object containing the data (could be the form or a top level business object, dto)

rebuildView

View rebuildView(String viewId,
                 Object model,
                 Map<String,String> viewRequestParameters)

Returns the View entry identified by the given id and runs through the complete lifecycle. Used to rebuild the view on a post before rendering or on a session timeout

Parameters:

viewId - - unique id for view configured on its definition

model - - Form object containing the data for the view

viewRequestParameters - - Map of key values pairs that provide parameters for the view. This comes from the initial request to set view properties that have the RequestParameter annotation

Returns:

View instance associated with the id or Null if id is not found

getViewTypeService

ViewTypeService getViewTypeService(String viewType)