Package com.activeviam.copper

Interface IDatabaseHelper

  • All Known Implementing Classes:
    DatabaseHelper
    @Deprecated(since="6.0.7",
            forRemoval=true)
public interface IDatabaseHelper
    Deprecated, for removal: This API element is subject to removal in a future version.
    Helper object for the Copper context, containing information about the underlying database.
    Author:
    ActiveViam

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      void ensureFieldExists​(ReachableField field)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Ensures the given field exists.
      Object getDefaultValue​(ReachableField field)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the default value of the given field.
      Collection<String> getKeyFields​(String store)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the key fields of a given store.
      int getType​(ReachableField field)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets the type of the given field.
      Collection<String> getUnicityFields​(String store)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the minimal list of fields that grant the uniqueness of a record when requesting data on given store.

    • Method Detail

      • ensureFieldExists

        void ensureFieldExists​(ReachableField field)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Ensures the given field exists.
        Parameters:
        field - the field to check

      • getType

        int getType​(ReachableField field)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Gets the type of the given field.
        Parameters:
        field - a field
        Returns:
        the field's type

      • getDefaultValue

        Object getDefaultValue​(ReachableField field)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Returns the default value of the given field.
        Parameters:
        field - a field
        Returns:
        the field's type

      • getUnicityFields

        Collection<String> getUnicityFields​(String store)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Returns the minimal list of fields that grant the uniqueness of a record when requesting data on given store.

        For stores having at least one key Field in their description, this list corresponds to the list of key fields. For key-less stores, this list will contains all the store fields.

        Parameters:
        store - the store name
        Returns:
        The unicity fields of the given store

      • getKeyFields

        Collection<String> getKeyFields​(String store)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Returns the key fields of a given store.
        Parameters:
        store - the store name
        Returns:
        The key fields of the given store