Package com.aquima.interactions.composer

Interface IContainer

All Superinterfaces:

ICompositeElement, IElement, Serializable

All Known Subinterfaces:

IPage

All Known Implementing Classes:

AnsweredContainer, ButtonContainer, Container, ContainerDelegate, FailedElement, Page, QuestionsContainer, SolutionsContainer, Table, TableCell, TableContainer, TableElement, TableHeader, TableRow, TreeListContainer

public interface IContainer
extends ICompositeElement

Interface for runtime container elements. Elements that wish to contain other elements (composite) should implement this interface.

Since:

5.0

Author:

O. Kerpershoek

Method Summary

Modifier and Type	Method	Description
IMultilingualText	getDisplayText()	This method returns the optional display text that should be used for this container.
EntityValue	getEntityInstanceId()	This method may return an instance ID indicating the instance that should be active when processing this container.
IMessage[]	getMessages(boolean includeChildren)	This method returns all the messages that were reported during the expand of this container.
String	getTypeName()	Method returning the name of the container type.

Methods inherited from interface com.aquima.interactions.composer.ICompositeElement

accept, equalsContent, getContentStyle, getElement, getElement, getElementCount, getElements

Methods inherited from interface com.aquima.interactions.composer.IElement

duplicate, getName, getParent, getPresentationStyles, getProperty, getPropertyKeys, getRuntimeKey, hasFocus, hasPresentationStyle, isReadonly, isReadonlyInheritFromParent, isVisible, setProperty

Method Details

getMessages

IMessage[] getMessages(boolean includeChildren)

This method returns all the messages that were reported during the expand of this container.

Parameters:

includeChildren - Boolean indicating if messages reported by child containers should also be returned.

Returns:

Array of messages that were reported during the expand of the container.

getDisplayText

IMultilingualText getDisplayText()

This method returns the optional display text that should be used for this container. If there is no display text defined for the container, this method will return a null value.

Returns:

Display text for the runtime container.

getEntityInstanceId

EntityValue getEntityInstanceId()

This method may return an instance ID indicating the instance that should be active when processing this container.

Returns:

Entity context associated with the container.

getTypeName

String getTypeName()

Method returning the name of the container type.

Returns:

The type name of the container.