Class ReportingPageDS
java.lang.Object
com.aquima.interactions.foundation.report.ReportingDS
com.aquima.interactions.composer.report.ReportingPageDS
- All Implemented Interfaces:
IContainerDS
,IElementDS
,IPageDS
,IReportingDS
IPageDS implementation that adds error reporting.
- Since:
- 5.0
- Author:
- O. Kerpershoek
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
ReportingPageDS
(IInitializationReport report, IPageDS datasource) -
Method Summary
Modifier and TypeMethodDescriptionString[]
This method returns an array containing all the channel names of the channels in which the container is allowed to be used.String[]
This method returns an array containing all the role names of the roles for which the container is allowed to be used.This method returns the content style that should be used when including the element that is referred to.This method returns the text object that should be used as the display text for the container.String[]
This method returns the possible exit events that can be fired by this container.getName()
This method returns the (unique) name of the element.String[]
This method returns the presentation styles that should be used when including the content element that is referred to.This method returns the type name of the container.boolean
This method returns a boolean indicating if the container considers the context read-only, and does not require any write access to the context during an expand.boolean
This method indicated if the container is a dynamic container.void
iterateContents
(IContainmentVisitor visitor) This method should iterate over all the content of this container, and invoke the visitor to add the content.void
This method should iterate over all the mapped exit events of the container, and invoke the visitor to add the mapping.void
iterateProperties
(IPropertyVisitor visitor) This method should iterate over all the properties of the container, and invoke the visitor to add the property.Methods inherited from class com.aquima.interactions.foundation.report.ReportingDS
addError, addMessage, getCategory, getReport
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.aquima.interactions.foundation.report.IReportingDS
addMessage
-
Constructor Details
-
Method Details
-
iterateContents
Description copied from interface:IContainerDS
This method should iterate over all the content of this container, and invoke the visitor to add the content.- Specified by:
iterateContents
in interfaceIContainerDS
- Parameters:
visitor
- The visitor that should be used to add the content to.
-
getAllowedChannels
Description copied from interface:IContainerDS
This method returns an array containing all the channel names of the channels in which the container is allowed to be used. When the container is available for all channels, it is recommended to return either an empty array or a null value.- Specified by:
getAllowedChannels
in interfaceIContainerDS
- Returns:
- Array containing all the channels for which the container is available.
-
getAllowedRoles
Description copied from interface:IContainerDS
This method returns an array containing all the role names of the roles for which the container is allowed to be used. When the container is available for all roles, it is recommended to return either an empty array or a null value.- Specified by:
getAllowedRoles
in interfaceIContainerDS
- Returns:
- Array containing all the roles for which the container is available.
-
getPresentationStyles
Description copied from interface:IElementDS
This method returns the presentation styles that should be used when including the content element that is referred to.- Specified by:
getPresentationStyles
in interfaceIElementDS
- Returns:
- the presentation styles that should be used when including the content element that is referred to.
-
getTypeName
Description copied from interface:IContainerDS
This method returns the type name of the container.- Specified by:
getTypeName
in interfaceIContainerDS
- Returns:
- the type name of the container.
-
getDisplayText
Description copied from interface:IContainerDS
This method returns the text object that should be used as the display text for the container. The text object may contain expressions, as it will be parsed during initialization to a IDynamicText object.- Specified by:
getDisplayText
in interfaceIContainerDS
- Returns:
- the text object that should be used as the display text for the container.
-
isDynamic
public boolean isDynamic()Description copied from interface:IContainerDS
This method indicated if the container is a dynamic container.- Specified by:
isDynamic
in interfaceIContainerDS
- Returns:
- boolean indicating if the container is a dynamic container.
-
isContextImmutable
public boolean isContextImmutable()Description copied from interface:IContainerDS
This method returns a boolean indicating if the container considers the context read-only, and does not require any write access to the context during an expand.- Specified by:
isContextImmutable
in interfaceIContainerDS
- Returns:
- Boolean indicating if the container considers the context read-only.
-
iterateProperties
Description copied from interface:IContainerDS
This method should iterate over all the properties of the container, and invoke the visitor to add the property.- Specified by:
iterateProperties
in interfaceIContainerDS
- Parameters:
visitor
- The visitor that should be used to add the properties to.
-
getName
Description copied from interface:IElementDS
This method returns the (unique) name of the element. The name is required when adding the content as a definition to the composer, but it is optional when the element is added directly as inline sub-content.- Specified by:
getName
in interfaceIElementDS
- Returns:
- the (unique) name of the element.
-
getExitEvents
Description copied from interface:IContainerDS
This method returns the possible exit events that can be fired by this container. This method should return null when this container is unaware of its exit events.- Specified by:
getExitEvents
in interfaceIContainerDS
- Returns:
- the possible exit events, can be null.
-
getContentStyle
Description copied from interface:IContainerDS
This method returns the content style that should be used when including the element that is referred to.
Pre version 7.0 the content style equals the tagname of the container.
- Specified by:
getContentStyle
in interfaceIContainerDS
- Returns:
- the content style that should be used when including the element that is referred to.
-
iterateExitEvents
Description copied from interface:IContainerDS
This method should iterate over all the mapped exit events of the container, and invoke the visitor to add the mapping.- Specified by:
iterateExitEvents
in interfaceIContainerDS
- Parameters:
visitor
- The visitor that should be used to add the events to.
-