Package com.aquima.interactions.project

Interface IPortalMessageDefinition

All Superinterfaces:
Serializable
All Known Implementing Classes:
PortalMessageDefinition
public interface IPortalMessageDefinition extends Serializable
This interface represents the definition of a portal message
Since:
9.2
Author:
m.mahabiersing

  • Method Summary

    Modifier and Type
    Method
    Description
    IPortalMessageFieldDefinition
    getField(String name)
    This method returns the definition of the data field.
    String[]
    getFieldNames()
    This method returns the names of the data fields, may not be null.
    String
    getName()
    This method returns the name of the message, may not be null.

  • Method Details

    • getName

      String getName()
      This method returns the name of the message, may not be null.
      Returns:
      The name of the event, never null.

    • getFieldNames

      String[] getFieldNames()
      This method returns the names of the data fields, may not be null. s
      Returns:
      The names of the data fields, never null.

    • getField

      IPortalMessageFieldDefinition getField(String name)
      This method returns the definition of the data field.
      Parameters:
      name - The name of the data field, not null.
      Returns:
      The definition of the data field.
      Throws:
      UnknownPortalMessageFieldException - when the definition cannot be found