lumis.doui.render

Interface IRenderable

All Known Implementing Classes:

CategorizationDataType.Data, ChannelDataType.Data, CharSequenceRenderableWrapper, DateDataType.Data, DateTimeDataType.Data, DocumentDataType.Data, EmailDataType.Data, FileDataType.Data, FilesDataType.Data, HtmlDataType.Data, ImageDataType.Data, LocaleMetaDataDataType.Data, LocalizableCharSequenceValue, MediaDataType.Data, OptionLookupValue, PageDataType.Data, PrincipalDataType.Data, RenderDataValue, ResourcesDataType.Data, TagDataType.Data, TimeDataType.Data, WorkflowStateDataType.Data

@StableMinor(version="12.3",
             sinceVersion="4.0")
public interface IRenderable

Classes that implements this interface offers a standard way to render its data in a xml format.

Since:

4.0.4

Version:

$Revision: 23747 $ $Date: 2020-04-07 23:16:33 +0000 (Tue, 07 Apr 2020) $

Method Summary

Modifier and Type	Method and Description
String	getDisplayString(IRenderer renderer) Returns the string to be displayed for representing this instance, when a short display is required.
String	getRenderData(IRenderer renderer) Returns the data of this object in a standard xml format.

Method Detail

getRenderData

String getRenderData(IRenderer renderer)
              throws PortalException

Returns the data of this object in a standard xml format.

Parameters:

renderer - the renderer object that will use the returned render data.

Returns:

the xml data for this object.

Throws:

PortalException

Since:

4.0.4

getDisplayString

String getDisplayString(IRenderer renderer)
                 throws PortalException

Returns the string to be displayed for representing this instance, when a short display is required.

Parameters:

renderer - the renderer object that will use the returned render data.

Returns:

the string to be used to friendly display this instance.

Throws:

PortalException

Since:

4.0.5