Package io.jenkins.plugins.datatables

Interface AsyncTableContentProvider

All Known Implementing Classes:
DefaultAsyncTableContentProvider
public interface AsyncTableContentProvider
Defines additional API methods a Jenkins ModelObject must provide in order to render JQuery DataTables in a corresponding jelly view using the tag table.jelly of the data-tables-api-plugin. Those tables will have the data loaded asynchronously using an Ajax call.

Typically, you do not need to implement this interface directly. Preferred way is to use the default implementation in DefaultAsyncTableContentProvider that already provides the correct extraction of the data rows as JSON objects.

Author:
Ullrich Hafner

  • Method Summary

    Modifier and Type
    Method
    Description
    TableModel
    getTableModel(String id)
    Returns the table model with the specified ID.
    String
    getTableRows(String id)
    Returns the rows of the table model with the specified ID.

  • Method Details

    • getTableModel

      TableModel getTableModel(String id)
      Returns the table model with the specified ID. A model object may show several data tables, each table must use a unique ID.
      Parameters:
      id - ID of the table model
      Returns:
      the table model with the specified ID

    • getTableRows

      String getTableRows(String id)
      Returns the rows of the table model with the specified ID. The rows must use the JSON specification of the data attribute of the data table. Note that this method will be invoked asynchronously using an Ajax call after the page has been rendered.
      Parameters:
      id - ID of the table model
      Returns:
      the table model with the specified ID