Package de.elo.ix.client

Class KeywordsDynamicInfo

java.lang.Object
byps.BValueClass
de.elo.ix.client.ValueClass
de.elo.ix.client.KeywordsDynamicInfo
All Implemented Interfaces:
Serializable
public class KeywordsDynamicInfo extends ValueClass implements Serializable
This Class contains parameters for the IX call IXServicePortIF.checkoutKeywordsDynamic(ClientInfo, KeywordsDynamicInfo) .

There are two ways to execute the script for dynamic keyword lists. According to the parameter in this class, the one way or the other is chosen. The first way is to specify sord and maskLineFocus. Then, the IX passes these parameters to the script via the script-function open(ec, sord, fieldName). The other parameters will be overwritten by null and completely ignored. The other way is to set the fields mapData, mapLineFocus and mapScriptName. In this case, the IX passes these parameters to the scripting function openMap(ec, data, fieldName). To achieve this, sord as well as maskLineFocus must be null.

Since:
9.00.000.001
See Also:

  • Field Details

    • sord

      protected Sord sord

      This value contains data gathered by the client. The contents of sord will be given to the script to execute.

    • maskLineFocus

      protected DocMaskLine maskLineFocus

      Only for sords with data organization based on objkeys. At the client, set this value to the mask line that currently has the focus. This value determines the server script to be executed. The server only reads the members maskId and id. For the server-side processing necessary residual values are read from the database.

      The focused mask line is passed to the script to execute. Ignoring this value in the script is a valid use case.

    • mapScriptName

      protected String mapScriptName
      Determines the script to execute.

      This value has only an effect if sord and maskLineFocus are set to null. Setting this value requires to set the values mapLineFocus and mapData also.

      Since:
      9.00.014.011

    • mapLineFocus

      protected String mapLineFocus
      Represents the id of a field in a form.
      Since:
      9.00.014.011
      See Also:

    • mapData

      protected Map<String,String> mapData
      Represents the input data of a form.

      The script to execute uses the values in this map to filter the resulting data set.

      Since:
      9.00.014.011
      See Also:

    • aspectAssocFocus

      protected AspectAssoc aspectAssocFocus

      Only for sords with data organization based on aspects. At the client, set this value to the aspect association being currently in focus. This value determines (together with field aspectLineFocus) the server script to be executed. The server only reads the members aspectId and name and determines the mask this aspect association is contained in. For the server-side processing necessary residual values are read from the database.

      The focused aspect association is passed to the script to execute. Ignoring this value in the script is a valid use case.

      Since:
      21.00.000.004

    • aspectLineFocus

      protected AspectLine aspectLineFocus

      Only for sords with data organization based on aspects. At the client, set this value to the aspect line being currently in focus. This value determines (together with field aspectAssocFocus) the server script to be executed. The server only reads the members aspectId and key. For the server-side processing necessary residual values are read from the database.

      The focused aspect line is passed to the script to execute. Ignoring this value in the script is a valid use case.

      Since:
      21.00.000.004

    • ordinalFocus

      protected int ordinalFocus

      Only for sords with data organization based on aspects. If aspectAssocFocus has a cardinality of Cardinality.MANDATORY_MANY or Cardinality.OPTIONAL_MANY, this value can optionally be given to set the focus to a particular number within the aspectObjects regarding to the index within the sords aspectObjectArray of the given aspect association.

      If this value is positive or equals to zero, this value is passed to the script to execute. Ignoring this value in the script is a valid use case. This value defaults to -1 which means "no focus on a particular number".

      Since:
      21.00.000.004

  • Constructor Details

    • KeywordsDynamicInfo

      public KeywordsDynamicInfo()

    • KeywordsDynamicInfo

      public KeywordsDynamicInfo(KeywordsDynamicInfo rhs)

  • Method Details

    • getSord

      public Sord getSord()

    • setSord

      public void setSord(Sord sord)

    • getMaskLineFocus

      public DocMaskLine getMaskLineFocus()

    • setMaskLineFocus

      public void setMaskLineFocus(DocMaskLine maskLineFocus)

    • getMapScriptName

      public String getMapScriptName()

    • setMapScriptName

      public void setMapScriptName(String mapScriptName)

    • getMapLineFocus

      public String getMapLineFocus()

    • setMapLineFocus

      public void setMapLineFocus(String mapLineFocus)

    • getMapData

      public Map<String,String> getMapData()

    • setMapData

      public void setMapData(Map<String,String> mapData)

    • getAspectAssocFocus

      public AspectAssoc getAspectAssocFocus()

    • setAspectAssocFocus

      public void setAspectAssocFocus(AspectAssoc aspectAssocFocus)

    • getAspectLineFocus

      public AspectLine getAspectLineFocus()

    • setAspectLineFocus

      public void setAspectLineFocus(AspectLine aspectLineFocus)

    • getOrdinalFocus

      public int getOrdinalFocus()

    • setOrdinalFocus

      public void setOrdinalFocus(int ordinalFocus)

    • toString

      public String toString()
      Overrides:
      toString in class Object