Package com.aquima.interactions.composer.ds

Interface IContainerDS

All Superinterfaces:
IElementDS, IReportingDS
All Known Subinterfaces:
IPageDS
All Known Implementing Classes:
ContainerDelegateDS, ContainerDS, ExecuteTaskPage, PageDS, ReportingContainerDS, ReportingPageDS, XmlContainerDS, XmlContainerDS, XmlPageDS, XmlPageDS
public interface IContainerDS extends IElementDS
Data source interface used to initialize a container element.
Since:
5.0
Author:
O. Kerpershoek

  • Method Summary

    Modifier and Type
    Method
    Description
    String[]
    getAllowedChannels()
    This method returns an array containing all the channel names of the channels in which the container is allowed to be used.
    String[]
    getAllowedRoles()
    This method returns an array containing all the role names of the roles for which the container is allowed to be used.
    String
    getContentStyle()
    This method returns the content style that should be used when including the element that is referred to.
    IMultilingualText
    getDisplayText()
    This method returns the text object that should be used as the display text for the container.
    String[]
    getExitEvents()
    This method returns the possible exit events that can be fired by this container.
    String
    getTypeName()
    This method returns the type name of the container.
    boolean
    isContextImmutable()
    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
    isDynamic()
    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
    iterateExitEvents(IContainerExitEventVisitor visitor)
    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 interface com.aquima.interactions.composer.ds.IElementDS

    getName, getPresentationStyles

    Methods inherited from interface com.aquima.interactions.foundation.report.IReportingDS

    addMessage

  • Method Details

    • getContentStyle

      String getContentStyle()

      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.

      Returns:
      the content style that should be used when including the element that is referred to.

    • getTypeName

      String getTypeName()
      This method returns the type name of the container.
      Returns:
      the type name of the container.

    • isDynamic

      boolean isDynamic()
      This method indicated if the container is a dynamic container.
      Returns:
      boolean indicating if the container is a dynamic container.

    • isContextImmutable

      boolean isContextImmutable()
      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.
      Returns:
      Boolean indicating if the container considers the context read-only.

    • getAllowedChannels

      String[] getAllowedChannels()
      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.
      Returns:
      Array containing all the channels for which the container is available.

    • getAllowedRoles

      String[] getAllowedRoles()
      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.
      Returns:
      Array containing all the roles for which the container is available.

    • getDisplayText

      IMultilingualText getDisplayText()
      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.
      Returns:
      the text object that should be used as the display text for the container.

    • iterateContents

      void iterateContents(IContainmentVisitor visitor)
      This method should iterate over all the content of this container, and invoke the visitor to add the content.
      Parameters:
      visitor - The visitor that should be used to add the content to.
      Throws:
      InitializationException - This exception is thrown when the content could not be added.

    • iterateProperties

      void iterateProperties(IPropertyVisitor visitor)
      This method should iterate over all the properties of the container, and invoke the visitor to add the property.
      Parameters:
      visitor - The visitor that should be used to add the properties to.
      Throws:
      InitializationException - This exception is thrown when the properties could not be added.

    • getExitEvents

      String[] getExitEvents()
      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.
      Returns:
      the possible exit events, can be null.

    • iterateExitEvents

      void iterateExitEvents(IContainerExitEventVisitor visitor)
      This method should iterate over all the mapped exit events of the container, and invoke the visitor to add the mapping.
      Parameters:
      visitor - The visitor that should be used to add the events to.
      Throws:
      InitializationException - This exception is thrown when the event mappings could not be added.
      Since:
      9.0