Package com.aquima.interactions.portal

Interface IPortalMessageScope

All Superinterfaces:
IPortalScope, Serializable
All Known Subinterfaces:
IInternalSessionScope, IPageScope, ISessionScope
All Known Implementing Classes:
ConcurrentPageScope, ConcurrentPortalMessageScope, ConcurrentSessionScope, PageScope, PageScopeDelegate, PortalMessageScope, ProcessEnabledSessionScope, ReadonlySessionScope, SessionScope, SessionScopeDelegate, SessionScopeWrapper
public interface IPortalMessageScope extends IPortalScope
Scope interface for scopes containing PortalMessage mappings
Since:
9.2
Author:
A.Pragt

  • Method Details

    • getMappedPortalMessages

      String[] getMappedPortalMessages()
      Returns the portalMessages for which a mapping is defined.
      Returns:
      The names of the mapped portal messages, not null.

    • setPortalMessageAction

      void setPortalMessageAction(String portalMessage, PortalMessageAction action)
      Sets the action to the specified portal message.
      Parameters:
      portalMessage - The portal message to map, not null or empty.
      action - The action to perform on the message, not null.

    • clearPortalMessageAction

      void clearPortalMessageAction(String portalMessage)
      Clears the current action to the specified portal message.
      Parameters:
      portalMessage - The portal message to clear, not null or empty.

    • getPortalMessageAction

      PortalMessageAction getPortalMessageAction(String portalMessage)
      Returns the current action for the specified portal message.
      Parameters:
      portalMessage - The portal message to retrieve the action for, not null or empty.
      Returns:
      The current action.