Package org.kuali.rice.krad.uif.service

Interface ViewTypeService

public interface ViewTypeService
Provides methods handing View instance of certain types

The type service is invoked to handle type parameters that can be used for additional indexing of views and retrieval.

As the view dictionary entries are indexed the associated view type will be retrieved and if there is an associated ViewTypeService it will be invoked to provide parameter information for further indexing. This is useful to index a view based on other properties, like a class name.

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

  • Method Details

    • getViewTypeName

      UifConstants.ViewType getViewTypeName()
      Gives the view type name that is supported by the type service

      The name is used to associated a type (and thus a view type service) with a view instance through the view type name property. Thus must be unique among all view types implemented

      Returns:
      ViewType view type name

    • getParametersFromViewConfiguration

      Map<String,String> getParametersFromViewConfiguration(org.springframework.beans.PropertyValues propertyValues)
      Pulls values for the supported parameters from the views configured property values. These name/value pairs are used to index the view for later retrieval
      Parameters:
      propertyValues - - property values configured on the view bean definition
      Returns:
      Mapinvalid input: '<'String, String> of parameters where map key is the parameter name, and the map value is the parameter value

    • getParametersFromRequest

      Map<String,String> getParametersFromRequest(Map<String,String> requestParameters)
      Pulls entries from the given map that are supported parameters for the view type. In addition, defaults can be set or additional parameters set as needed. Used by the ViewService to retrieve a View instance based on the incoming request parameters
      Parameters:
      requestParameters - - Map of request parameters to pull view type parameters from
      Returns:
      Mapinvalid input: '<'String, String> of parameters where map key is the parameter name, and the map value is the parameter value