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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.Object
getColumnData(java.lang.String colName)
Gets the data for the column with the given name.java.lang.String
getData()
Returns the additional data which should be stored by OpenCms.java.lang.String
getDescription()
Returns the description to be stored by OpenCms.java.lang.String
getId()
Gets the ID of the data item.java.lang.String
getImage()
Gets the URL of the image to be displayed for this data item.java.lang.String
getTitle()
Gets the title to be stored by OpenCms.
-
-
-
Method Detail
-
getColumnData
java.lang.Object getColumnData(java.lang.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
java.lang.String getData()
Returns the additional data which should be stored by OpenCms.- Returns:
- the additional data to be stored
-
getDescription
java.lang.String getDescription()
Returns the description to be stored by OpenCms.- Returns:
- the description
-
getId
java.lang.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
java.lang.String getImage()
Gets the URL of the image to be displayed for this data item.- Returns:
- an URL pointing to an image
-
getTitle
java.lang.String getTitle()
Gets the title to be stored by OpenCms.- Returns:
- the title
-
-