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

Interface ViewService

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 Details

    • 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. A new view instance is returned that is in the created state

      Parameters:
      viewId - - unique id for view configured on its definition
      Returns:
      View instance associated with the id or Null if id is not found

    • getViewByType

      View getViewByType(UifConstants.ViewType 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

      If a view if found for the type parameters, a new instance is returned that is in the created state

      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

    • getViewIdForViewType

      String getViewIdForViewType(UifConstants.ViewType viewType, Map<String,String> parameters)
      Retrieves the view id for the view associated with the given view type and view type parameters
      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:
      id for the view or null if a matching view was not found

    • getViewTypeService

      ViewTypeService getViewTypeService(UifConstants.ViewType viewType)