Package org.opencms.widgets.dataview

Interface I_CmsDataViewItem

public interface I_CmsDataViewItem
Interface describing a data item retrieved by an implementation of I_CmsDataView.

This interface provides both the data to display the data item in the widget used to select data items, as well as the data which should be stored by OpenCms when the data item is selected by the user (its ID, title, description and an additional data string for other information)

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    getColumnData(String colName)
    Gets the data for the column with the given name.
    String
    getData()
    Returns the additional data which should be stored by OpenCms.
    String
    getDescription()
    Returns the description to be stored by OpenCms.
    String
    getId()
    Gets the ID of the data item.
    String
    getImage()
    Gets the URL of the image to be displayed for this data item.
    String
    getTitle()
    Gets the title to be stored by OpenCms.

  • Method Details

    • getColumnData

      Object getColumnData(String colName)
      Gets the data for the column with the given name.

      The returned object should be of a type compatible with the type of the column returned by I_CmsDataView.getColumns() with the same name.

      Parameters:
      colName - the column name
      Returns:
      the value of the column

    • getData

      String getData()
      Returns the additional data which should be stored by OpenCms.
      Returns:
      the additional data to be stored

    • getDescription

      String getDescription()
      Returns the description to be stored by OpenCms.

      Returns:
      the description

    • getId

      String getId()
      Gets the ID of the data item.

      The ID should be unique for the given I_CmsDataView implementation which returned this data item.

      Returns:
      the ID of the data item

    • getImage

      String getImage()
      Gets the URL of the image to be displayed for this data item.

      Returns:
      an URL pointing to an image

    • getTitle

      String getTitle()
      Gets the title to be stored by OpenCms.

      Returns:
      the title