Package de.espirit.firstspirit.access.store

Interface Data

All Superinterfaces:
Iterable<DataValue>, MultiPageParamsProvider
@Deprecated public interface Data extends Iterable<DataValue>, MultiPageParamsProvider
Deprecated.
since 5.2.21 - use FormData as appropriate
This interface provides methods to handle Data containers.
Since:
2.3

  • Method Details

    • remove

      @Deprecated boolean remove(DataValue o)
      Deprecated.
      since 5.2.21 - see type
      Remove a single instance of the specified DataValue from the current Data-object
      Parameters:
      o - DataValue to be removed from the Data-object, if present
      Returns:
      true if the Data-object changed as a result of the call
      Since:
      2.3

    • createDataValue

      @Deprecated DataValue createDataValue(String name)
      Deprecated.
      since 5.2.21 - see type
      Create a new DataValue object for the given name.
      Parameters:
      name - name of the new DataValue
      Returns:
      new DataValue object
      Since:
      2.3

    • create

      @Deprecated DataValue create(String name, UserService userService, @Nullable @Nullable Element value) throws ClassCastException, InstantiationException, IllegalAccessException, ClassNotFoundException
      Deprecated.
      since 5.2.21 - see type
      Create a new DataValue instance as child of this data object initializing the child with the respective EditorValue.
      Parameters:
      name - The name of the value.
      userService - The user service to us.
      value - The parsed DataValue element (maybe null).
      Returns:
      The new child.
      Throws:
      ClassCastException - If creating the data value went wrong.
      ClassNotFoundException - If creating the data value went wrong.
      IllegalAccessException - If creating the data value went wrong.
      InstantiationException - If creating the data value went wrong.
      Since:
      4.0.17

    • get

      @Deprecated @Nullable @Nullable DataValue get(String name)
      Deprecated.
      since 5.2.21 - see type
      Get a data value object by its variable name.
      Parameters:
      name - the variable name
      Returns:
      the data value object or null if the variable name is unknown
      Since:
      2.3.24

    • toXml

      @Deprecated @NotNull @NotNull String toXml()
      Deprecated.
      since 5.2.21 - see type
      Get the XML-structure of the current Data-object
      Returns:
      XML-structure as a string
      Since:
      2.3

    • getGomProvider

      @Deprecated GomEditorProvider getGomProvider()
      Deprecated.
      since 5.2.21 - see type
      Get the provider of the GUI structure for this data object.
      Returns:
      The GUI provider.
      Since:
      4.0.17

    • getVariableNames

      @Deprecated List<String> getVariableNames()
      Deprecated.
      since 5.2.21 - see type
      Returns:
      a list of valid variable names or null
      Since:
      2.3.25

    • get

      @Deprecated DataValue get(int index) throws IndexOutOfBoundsException
      Deprecated.
      since 5.2.21 - see type
      Return DataValue specified by a index.
      Parameters:
      index - The index to look up.
      Returns:
      the data value
      Throws:
      IndexOutOfBoundsException - If the index is out of bounds.
      Since:
      3.0.115

    • indexOf

      @Deprecated int indexOf(String name)
      Deprecated.
      since 5.2.21 - see type
      Return index of a named variable.
      Parameters:
      name - the variable name
      Returns:
      index or -1 if unknown
      Since:
      3.0.115

    • iterator

      @Deprecated Iterator<DataValue> iterator()
      Deprecated.
      since 5.2.21 - see type
      Iterates over available DataValue's. The returned iterator does not support Iterator.remove()!
      Specified by:
      iterator in interface Iterable<DataValue>
      Returns:
      An Iterator.
      Since:
      2.3.24

    • getSize

      @Deprecated int getSize()
      Deprecated.
      since 5.2.21 - see type
      Get the number of available DataValue entries.
      Returns:
      The counted entries.
      Since:
      3.0.115

    • hasData

      @Deprecated boolean hasData()
      Deprecated.
      since 5.2.21 - see type
      Indicates that the data instance has any set value, i.e., there is at least one DataValue where DataValue.getEditor().isSet() evaluates to true.
      Returns:
      true, iff some value is set.
      Since:
      4.0.120

    • isRelease

      @Deprecated boolean isRelease()
      Deprecated.
      since 5.2.21 - see type
      Indicates the data's source is released.
      Returns:
      true, if released.
      Since:
      3.1.158

    • getReferences

      @Deprecated Reference[] getReferences()
      Deprecated.
      since 5.2.21 - see type
      Provides references within the data's values.
      Returns:
      The collected references.
      Since:
      3.1.158

    • isMeta

      @Deprecated boolean isMeta()
      Deprecated.
      since 5.2.21 - see type
      Indicates the data's source to represent meta information.
      Returns:
      true if the held data is meta data.
      Since:
      4.0.17

    • isDefault

      @Deprecated boolean isDefault()
      Deprecated.
      since 5.2.21 - see type
      Indicates, that this data object represents a default data container.
      Returns:
      true, iff the held data are default data.
      Since:
      4.0.17

    • isValid

      @Deprecated boolean isValid()
      Deprecated.
      since 5.2.21 - see type
      Indicates, whether the data values are valid wrt. its GOM, e.g., if all mandatory values are set.
      Returns:
      true, if valid.
      Since:
      3.1.358

    • getMultiPageParams

      @Nullable @Deprecated @Nullable MultiPageParams getMultiPageParams(@NotNull @NotNull Language language)
      Deprecated.
      Since 5.0.104, no replacement.
      Returns always null. The method and the inheritance of MultiPageParamsProvider will be removed in a future version.
      Specified by:
      getMultiPageParams in interface MultiPageParamsProvider
      Returns:
      null
      Since:
      4.0

    • getMonoglot

      @Nullable @Deprecated @Nullable Monoglot getMonoglot()
      Deprecated.
      since 5.2.510, no replacement
      Provides the monoglot object indicating that only a single language is to be edited in the data hierarchy from this point on. If the indicator provides a language, entries must no longer be polyglot.
      Returns:
      A monoglot indicator.
      Since:
      5.2.510