Package de.espirit.firstspirit.access.store.templatestore

Interface Script

All Superinterfaces:
ChannelSourceProvider, Comparable<StoreElement>, GomSourceProvider, HistoryProvider, IDProvider, PackagePoolItem, Referenceable, RulesetContainer, RulesetContainer, StoreElement, TemplateStoreElement, Workflowable
public interface Script extends Referenceable, GomSourceProvider, ChannelSourceProvider, PackagePoolItem, TemplateStoreElement, RulesetContainer
This interface provides methods to handle the scripts in the TemplateStore
Since:
3.0
See Also:

  • Field Details

    • TEMPLATE

      static final int TEMPLATE
      Applicable for template use.
      Since:
      2.3.10
      See Also:

    • CONTEXT_MENUE

      static final int CONTEXT_MENUE
      Applicable for context menu use.
      Since:
      2.3.10
      See Also:

    • UNINTERPRETED

      @Deprecated static final int UNINTERPRETED
      Deprecated.
      since 5.0.39 - use FormatTemplate instead
      Not applicable for scripting.
      Since:
      2.3.11
      See Also:

    • CONTENT_CREATOR

      static final int CONTENT_CREATOR
      Type used for scripts which can be used in the ContentCreator
      Since:
      5.2.211103
      See Also:

    • UID_TYPE

      static final IDProvider.UidType UID_TYPE
      The script UID type.
      Since:
      4.0.18

  • Method Details

    • getName

      @NotNull @NotNull String getName()
      Provides the name of the script.
      Specified by:
      getName in interface StoreElement
      Returns:
      The script's name.
      Since:
      3.0

    • setName

      void setName(String name)
      Defines the name of the script.
      Parameters:
      name - The script's name.
      Since:
      3.0

    • getDescription

      String getDescription()
      Provides a description of this script.
      Returns:
      The script's description.
      Since:
      3.0

    • setDescription

      void setDescription(String description)
      Defines the description of this script.
      Parameters:
      description - The script's description.
      Since:
      3.0

    • getComment

      String getComment()
      Provides the comment set for this script.
      Returns:
      The comment.
      Since:
      3.0

    • setComment

      void setComment(String comment)
      Defines the comment for this script.
      Parameters:
      comment - The comment.
      Since:
      3.0

    • getType

      int getType()
      Returns the type of this script. One of TEMPLATE, MENUE, CONTEXT_MENUE, UNINTERPRETED
      Returns:
      type of the script. One of TEMPLATE, MENUE, CONTEXT_MENUE, UNINTERPRETED
      Since:
      3.0

    • setType

      void setType(int type)
      Sets the type of the script. One of TEMPLATE, MENUE, CONTEXT_MENUE, UNINTERPRETED
      Parameters:
      type - One of TEMPLATE, MENUE, CONTEXT_MENUE, UNINTERPRETED
      Since:
      3.0

    • isAlwaysActive

      boolean isAlwaysActive()
      Indicates whether this script is always active or not. If this method delivers false the related view script will be executed to evaluate the visibility state of the script.
      Returns:
      true if this script is always active, false otherwise
      Since:
      4.2.474
      See Also:

    • setAlwaysActive

      void setAlwaysActive(boolean alwaysActive)
      Sets the always active flag for this script. If always active is set to false the related view script will be executed to evaluate the visibility state.
      Since:
      3.0
      See Also:

    • getViewScript

      @NotNull @NotNull String getViewScript()
      Returns the view script defined for this script or an empty string.
      Since:
      3.0
      See Also:

    • getViewScriptExecutable

      Executable getViewScriptExecutable()
      Delivers an executable of the related view script. This view script will be executed if this script is not defined as always active to evaluate the visibility state of this script. The script should return a boolean value to define visibility. Since 5.0 the usage of setProperty with property visible in the context is deprecated.
      Since:
      4.0.120
      See Also:

    • setViewScript

      void setViewScript(String script)
      Defines the view script of this script. The given script will be executed if this script is not defined as always active to evaluate the visibility state of this script. The given script should return a boolean value to define visibility. Since 5.0 the usage of setProperty with property visible in the context is deprecated.
      Since:
      3.0
      See Also:

    • getExecutable

      Executable getExecutable(TemplateSet templateSet)
      Provides an executable based on the requested template set.
      Returns:
      The fitting executable or null.
      Since:
      4.0.120

    • getUidType

      @NotNull @NotNull IDProvider.UidType getUidType()
      Returns the value of UID_TYPE.
      Specified by:
      getUidType in interface IDProvider
      Returns:
      the unique identifier
      Since:
      4.0
      See Also: