Package de.elo.ix.jscript.handler

Interface ISordUtilHandler

public interface ISordUtilHandler
Internally used interface. Class SordUtil forwards method calls to an implementation of this interface. The implementation is only available when we are running as a IX event script or plugin.

  • Method Summary

    Modifier and Type
    Method
    Description
    String[][]
    getAllObjKeyData(Sord sord, String groupName)
    Return all values of all index fields with the given group name.
    List<IndexValue>
    getIndexValues(Sord sord, String assocName, String lineKey)
    Helper function to easily extract index values from a sord's aspect objects.
    It collects for a given aspect association (which can have cardinality MANY) all index values corresponding to the given key of an aspect line.
    String[]
    getObjKeyData(Sord sord, String groupName)
    Returns the keywording data by given group name within a Sord-Object.
    String
    getObjKeyValue(Sord sord, String groupName)
    Returns the first value of keywording data by given group name within a Sord-Object.
    IndexValue
    getSingleIndexValue(Sord sord, String assocName, String lineKey, int ordinal)
    Helper function to easily extract a single index value from sord's aspect objects.
    It extracts a particular IndexValue object from the given sord for a given aspect association (which can have cardinality MANY), a given key of an aspect line and a given ordinal value.
    void
    setObjKeyData(Sord sord, String groupName, Object val)
    Sets the ObjKey data in a Sord by a given groupname

  • Method Details

    • getObjKeyData

      String[] getObjKeyData(Sord sord, String groupName)
      Returns the keywording data by given group name within a Sord-Object. WARNING: group name must be explicit within the mask otherwise the result might be false.
      Parameters:
      sord - Sord
      groupName - Index value group name
      Returns:
      Values

    • getObjKeyValue

      String getObjKeyValue(Sord sord, String groupName)
      Returns the first value of keywording data by given group name within a Sord-Object. WARNING: group name must be explicit within the mask otherwise the result might be false.
      Parameters:
      sord - Sord
      groupName - Index value group name
      Returns:
      First value

    • setObjKeyData

      void setObjKeyData(Sord sord, String groupName, Object val)
      Sets the ObjKey data in a Sord by a given groupname
      Parameters:
      sord - Sord
      groupName - Index value group name
      val - as String or String[]

    • getAllObjKeyData

      String[][] getAllObjKeyData(Sord sord, String groupName)
      Return all values of all index fields with the given group name.
      Parameters:
      groupName - Index value group name
      Returns:
      contents of DocMaskLines

    • getSingleIndexValue

      IndexValue getSingleIndexValue(Sord sord, String assocName, String lineKey, int ordinal)
      Helper function to easily extract a single index value from sord's aspect objects.
      It extracts a particular IndexValue object from the given sord for a given aspect association (which can have cardinality MANY), a given key of an aspect line and a given ordinal value.
      Parameters:
      sord - The sord to extract an index value from.
      assocName - The name of an aspect association for which an index value shall be extracted
      lineKey - The lineKey of the aspect line for which an index value shall be extracted
      ordinal - The ordinal value (usually 0) which can be greater than 0 if the given aspect association has cardinality MANY
      Returns:
      An IndexValue object. Returns null if the sord does not provide aspect objects at all or does not provide aspect objects for the given parameters.

    • getIndexValues

      List<IndexValue> getIndexValues(Sord sord, String assocName, String lineKey)
      Helper function to easily extract index values from a sord's aspect objects.
      It collects for a given aspect association (which can have cardinality MANY) all index values corresponding to the given key of an aspect line.
      Parameters:
      sord - The sord to extract index values from.
      assocName - The name of an aspect association for which index values shall be collected
      lineKey - The lineKey of the aspect line for which index values shall be collected
      Returns:
      A List of IndexValue objects. Returns null if the sord does not provide aspect objects at all or does not provide aspect objects for the given aspect association.