Package com.saperion.intf

Interface SaFieldDescription

All Superinterfaces:
Serializable
public interface SaFieldDescription extends Serializable
Interface for field descriptions.
Describes a field in a database definition (DDC).

  • Method Details

    • getFieldType

      int getFieldType()
      Reads the fieldtype.
      Returns:
      Returns the fieldType.

    • getSaFieldType

      SaConstants.SaFieldType getSaFieldType()
      Reads the SAPERION fieldtype.
      Returns:
      Fieldtype enumeration

    • getIndexFieldKind

      com.saperion.jna.applsrv.m2j.natives.IndexFieldKind getIndexFieldKind()
      Returns:
      the field type as IndexFieldKind

    • isHasLookupTable

      boolean isHasLookupTable()
      Test, if this field has a lookup table.
      Returns:
      Returns the hasLookupTable.

    • isIndex

      boolean isIndex()
      Tests, if this field is an index field.
      Returns:
      Returns the isIndex.

    • isMandatory

      boolean isMandatory()
      Checks, if this field is mandatory.
      Returns:
      Returns the isMandatory.

    • isMultiValue

      boolean isMultiValue()
      Checks, if this field is multivalued.
      Returns:
      Returns the isMultiValue.

    • isUnique

      boolean isUnique()
      Checks, if this field is unique.
      Returns:
      Returns the isUnique.

    • getLength

      int getLength()
      Reads the length if this field.
      Returns:
      Returns the length.

    • getLookupTableDef

      String getLookupTableDef()
      Reads the definition of lookup table.
      Returns:
      Returns the lookupTableDef.

    • getLookupTableField

      String getLookupTableField()
      Reads the field in the lookup table.
      Returns:
      Returns the lookupTableField.

    • isLookupTableIsDirect

      boolean isLookupTableIsDirect()
      Reads the value for lookupTableIsDirect.
      Returns:
      Returns the lookupTableIsDirect.

    • getMultiValueSeparators

      String getMultiValueSeparators()
      Reads the multivalue separators.
      Returns:
      Returns the multiValueSeparators.

    • getName

      String getName()
      Reads the name of this field.
      Returns:
      Returns the name.

    • getDbName

      String getDbName()
      Reads the real database name of this field.
      Returns:
      the dbName

    • toString

      String toString()
      Returns the string representation.
      Overrides:
      toString in class Object
      Returns:
      String representation "Name" / "DBName" type:"Fieldtype"
      See Also:

    • isNonSystemField

      boolean isNonSystemField()
      Checks whether this object's name is a non-system DDC field name.
      Returns:
      True if name denotes a non-system field

    • isStringFieldType

      boolean isStringFieldType()
      Checks if this object is a string type.
      Returns:
      True if fieldType is a string type

    • getCurrency

      String getCurrency()
      Returns the currency symbol for currency type fields.
      Returns:
      symbol or empty string if not available

    • getPostDigits

      int getPostDigits()
      Returns the number of fraction digits for currency type fields.
      Returns:
      fraction digits or 0 if not available

    • isMultiSelect

      boolean isMultiSelect()
      Returns:
      true if the multiselect option is enabled

    • setMultiSelect

      void setMultiSelect(boolean multiSelect)
      Enables or disables the multiselect option.
      Parameters:
      multiSelect - multiSelect option

    • getMultivalueTableName

      String getMultivalueTableName()
      Returns:
      name of the associated multivalue table or null if this is not a multivalue field

    • setMultivalueTableName

      void setMultivalueTableName(String tableName)
      Parameters:
      tableName - the name of the associated multivalue table for this field

    • getProtoField

      default String getProtoField()

    • setProtoField

      default void setProtoField(String protoField)