Interface IPlaceholderProvideContext

All Superinterfaces:
Serializable
public interface IPlaceholderProvideContext extends Serializable
Context for providing various information needed for providing placeholders.
Since:
8.4.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • getUserContext

      @NotNull @NotNull UserContext getUserContext()
      Returns:
      The user context for accessing the database.

    • getClient

      @Nullable Mandant getClient()
      Returns:
      The client for which the placeholders are being updated.

    • getFormVersion

      @Nullable FormVersion getFormVersion()
      Returns the workflow version for which the placeholders are being updated. May be null if the context does not provide a workflow version (e.g. when inside the inbox). If a form version is given then the project is assumed to be the owner of the form version.
      Returns:
      The workflow version for which the placeholders are being updated.

    • getLocale

      Locale getLocale()
      Returns:
      The locale for which the placeholders are being updated.

    • getProject

      @Nullable Projekt getProject()
      Returns the project for which the placeholders are being updated. May be null if the context does not provide a project (e.g. when inside the inbox).
      Returns:
      The project for which the placeholders are being updated.

    • getVariables

      @Nullable List<FormVariable> getVariables()
      Returns the variables for which the placeholders are being updated. May be null if the context does not provide variables (e.g. when inside the inbox).
      Returns:
      The variables for which the placeholders are being updated.

    • getXItems

      @Nullable Collection<XItem> getXItems()
      Returns the XItems for which the placeholders are being updated. May be null if the context does not provide items (e.g. when inside the inbox).
      Returns:
      The XItems for which the placeholders are being updated.