Package step.repository.alm.v16.otaclient

Interface ICustomizationFields

  • All Superinterfaces:
    com4j.Com4jObject
    All Known Subinterfaces:
    ICustomizationFields2, ICustomizationFields3
    public interface ICustomizationFields
extends com4j.Com4jObject
    Services for managing the collection of all CustomizationField objects in the project.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com4j.Com4jObject addActiveField​(java.lang.String tableName)
      Finds the first free, inactive field in the specified table, signs the field as active, and returns the CustomizationFields object representing the field.
      com4j.Com4jObject addActiveMemoField​(java.lang.String tableName)
      Creates a new memo field in a table.
      com4j.Com4jObject field​(java.lang.String tableName, java.lang.String fieldName)
      The customization field object for the specified database table and field.
      boolean fieldExists​(java.lang.String tableName, java.lang.String fieldName)
      Checks if the specified database field exists.
      IList fields​(java.lang.String tableName)
      A list of all fields in the specified table.

      • Methods inherited from interface com4j.Com4jObject

        advise, dispose, equals, getComThread, getIUnknownPointer, getPointer, getPtr, hashCode, is, queryInterface, setName, toString

    • Method Detail

      • field

        com4j.Com4jObject field​(java.lang.String tableName,
                        java.lang.String fieldName)

        The customization field object for the specified database table and field.

        Getter method for the COM property "Field"

        Parameters:
        tableName - Mandatory java.lang.String parameter.
        fieldName - Mandatory java.lang.String parameter.
        Returns:
        Returns a value of type com4j.Com4jObject

      • fields

        IList fields​(@DefaultValue("")
             java.lang.String tableName)

        A list of all fields in the specified table.

        Getter method for the COM property "Fields"

        Parameters:
        tableName - Optional parameter. Default value is ""
        Returns:
        Returns a value of type step.repository.alm.v16.otaclient.IList

      • addActiveField

        com4j.Com4jObject addActiveField​(java.lang.String tableName)

        Finds the first free, inactive field in the specified table, signs the field as active, and returns the CustomizationFields object representing the field.

        Parameters:
        tableName - Mandatory java.lang.String parameter.
        Returns:
        Returns a value of type com4j.Com4jObject

      • fieldExists

        boolean fieldExists​(java.lang.String tableName,
                    java.lang.String fieldName)

        Checks if the specified database field exists.

        Getter method for the COM property "FieldExists"

        Parameters:
        tableName - Mandatory java.lang.String parameter.
        fieldName - Mandatory java.lang.String parameter.
        Returns:
        Returns a value of type boolean

      • addActiveMemoField

        com4j.Com4jObject addActiveMemoField​(java.lang.String tableName)

        Creates a new memo field in a table.

        Parameters:
        tableName - Mandatory java.lang.String parameter.
        Returns:
        Returns a value of type com4j.Com4jObject