org.pentaho.platform.api.ui
Interface IUIComponent

All Known Implementing Classes:
AbstractChartComponent, AbstractJFreeChartComponent, ActionComponent, BaseUIComponent, CategoryDatasetChartComponent, DashboardWidgetComponent, DialChartComponent, FilterPanelComponent, HtmlComponent, InputFormComponent, LoadDBRepositoryUIComponent, NavigationComponent, PieDatasetChartComponent, PMDUIComponent, PropertiesEditorUIComponent, PropertiesPanelUIComponent, SchedulerAdminUIComponent, SolutionManagerUIComponent, SolutionTreeUIComponent, SubscriptionAdminUIComponent, TimeSeriesCollectionChartComponent, UserFilesComponent, WidgetGridComponent, XmlComponent, XYSeriesCollectionChartComponent, XYZSeriesCollectionChartComponent

public interface IUIComponent


Method Summary
 void handleRequest(OutputStream outputStream, IActionRequestHandler actionRequestHandler, String contentType, HashMap requestParameterProviders)
           
 boolean validate()
           
 boolean validate(IPentahoSession session, IActionRequestHandler actionRequestHandler)
          Set the userSession member, generate a Log Id, set the requestHandler, and validate the component's configuration.
 

Method Detail

handleRequest

void handleRequest(OutputStream outputStream,
                   IActionRequestHandler actionRequestHandler,
                   String contentType,
                   HashMap requestParameterProviders)
                   throws IOException
Throws:
IOException

validate

boolean validate()

validate

boolean validate(IPentahoSession session,
                 IActionRequestHandler actionRequestHandler)
Set the userSession member, generate a Log Id, set the requestHandler, and validate the component's configuration. NOTE: this method has several side effects not related to validation. could probably use some refactoring

Parameters:
session -
actionRequestHandler -
Returns:
boolean true if component configuration is valid, else false