Interface IPromptReference

All Superinterfaces:
Serializable
public interface IPromptReference extends Serializable
A reference to a prompt object, such as a prompt connection or prompt query. See also IPromptReferenceLocator, which can locate such references to prompt objects. Each reference must have a localizable name and contain the logic for cascading changes to the object being referenced.
Since:
8.5.0

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    displayName(Locale locale)
    Gets the localized name of the reference, such as the name of the object that holds the reference.
    Object
    id()
    Gets the unique identifier of this type() of reference, such as a UUID or database ID.
    Object
    type()
    Gets the type of the reference, such as a type string or Class.

  • Method Details

    • displayName

      String displayName(Locale locale)
      Gets the localized name of the reference, such as the name of the object that holds the reference. For example, when a workflow action holds a reference to a prompt query, this could be the name of that workflow action, possibly together with the tenant or project that contains the action.
      Parameters:
      locale - The locale to use for localizing the name.
      Returns:
      The localized name of the reference.

    • id

      Object id()
      Gets the unique identifier of this type() of reference, such as a UUID or database ID.
      Returns:
      The unique identifier of the reference.

    • type

      Object type()
      Gets the type of the reference, such as a type string or Class.
      Returns:
      The type of the reference.