Package ch.ivyteam.ivy.workflow.custom.field

Interface ICustomFieldMeta

public interface ICustomFieldMeta
Meta information about a custom field
Since:
9.4
API:
This is a public API.

  • Field Details

    • BY_NAME

      static final Comparator<ICustomFieldMeta> BY_NAME
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • BY_LABEL

      static final Comparator<ICustomFieldMeta> BY_LABEL
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

  • Method Details

    • name

      String name()
      The technical name of the custom field. The technical name should not be shown to the end user. Use label(), description() and category() instead.
      Returns:
      name
      See Also:
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • label

      String label()
      The label to display to the end user for the custom field. The label can be configured in different language in the CMS at /CustomFields/(Tasks|Cases|Starts)/%name%/Label
      Returns:
      label
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • description

      String description()
      The description to display to the end user for the custom field. The description can be configured in different language in the CMS at /CustomFields/(Tasks|Cases|Starts)/%name%/Description
      Returns:
      description
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • category

      String category()
      The category to display to the end user for the custom field. The category can be configured in different language in the CMS at /CustomFields/Categories/%category%
      Returns:
      category
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • type

      CustomFieldType type()
      The type of the custom field
      Returns:
      type
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • isHidden

      boolean isHidden()
      Do not show hidden custom fields to the end users. Hidden custom fields holds technical information that are not though to be visible to the end user.
      Returns:
      true if hidden, otherwise false
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • attribute

      String attribute(String attributeName)
      Get the value of an additional meta attribute
      Parameters:
      attributeName - the name of the additional meta attribute
      Returns:
      value or null if value is not defined
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • attributeNames

      Iterable<String> attributeNames()
      Get the names of all attributes that are defined
      Returns:
      attribute names
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • tasks

      static Set<ICustomFieldMeta> tasks()
      Gets all meta information statically defined in projects of the current workflow context for task custom fields
      Returns:
      set of meta information
      See Also:
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • cases

      static Set<ICustomFieldMeta> cases()
      Gets all meta information statically defined in projects of the current workflow context for case custom fields
      Returns:
      set of meta information
      See Also:
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • starts

      static Set<ICustomFieldMeta> starts()
      Gets all meta information statically defined in projects of the current workflow context for start custom fields
      Returns:
      set of meta information
      See Also:
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.