Package com.polarion.subterra.base.data.model

Interface ICustomField

public interface ICustomField
Custom field prototype.
Version:
$Revision$ $Date$
Author:
Jiri Walek, Polarion Software

  • Method Details

    • getId

      String getId()

    • getType

      IType getType()
      Returns type of this field - can be one of the following types:

    • getName

      String getName()

    • getDescription

      String getDescription()

    • isRequired

      boolean isRequired()

    • isMulti

      boolean isMulti()
      Shortcut for getType() instanceof IListType.

    • isReference

      boolean isReference()
      Shortcut for getType() instanceof IReferenceType.

    • getDefaultValue

      Object getDefaultValue()

    • getDependsOn

      @Nullable String getDependsOn()
      Returns:
      id of custom field on what this custom field depends (can be null)
      Since:
      3.8.1

    • getDependentFieldIds

      @NotNull Collection<String> getDependentFieldIds()
      Returns:
      custom field ids what depends on this custom field (not null)
      Since:
      3.8.1

    • getDependencyMapping

      @Nullable IRelationMapping getDependencyMapping()
      Returns:
      dependency mapping as relation between values of current custom field and the one what depends on (can be null)
      Since:
      3.8.1

    • getParameters

      @NotNull Map<String,Map<String,String>> getParameters()
      Returns:
      map of additional custom field parameters from configuration e.g. definition of columns for table custom field (not null)
      Since:
      3.20.2