Interface JCoParameterList

All Superinterfaces:
Cloneable, Iterable<JCoField>, JCoRecord, Serializable
All Known Subinterfaces:
JCoRequest, JCoResponse

public interface JCoParameterList extends JCoRecord
A class that encapsulates a parameter list used to pass on data to a function.
See Also:
  • Method Details

    • getListMetaData

      JCoListMetaData getListMetaData()
      returns the appropriated metadata object, that was used for creation of this record.
      Returns:
      MetaData instance of the appropriated metadata object
    • getParameterFieldIterator

      JCoParameterFieldIterator getParameterFieldIterator()
      Returns an iterator over JCoParameterField.
      Returns:
      JCoParameterFieldIterator instance
      See Also:
    • isActive

      boolean isActive(int index)
      Checks whether the specified field is active.
      Parameters:
      index - the index of the field
      Returns:
      true if the specified field is an activated parameter, false otherwise
      Throws:
      IndexOutOfBoundsException - in case if index is negative or out of range
    • isActive

      boolean isActive(String field_name)
      Checks whether the specified field is active.
      Parameters:
      field_name - the name of the field
      Returns:
      true if the specified field is an activated parameter, false otherwise
      Throws:
      JCoRuntimeException - thrown if a field with the specified name does not exist
    • setActive

      void setActive(int index, boolean active)
      Sets the marshall/unmarshall behavior of a parameter. If set to false the parameter will never be sent or fetched from the remote system. The default value is true, i.e. always get and send the parameter contents.
      Parameters:
      index - the index of the parameter
      active - true if the parameter should be sent or fetched during a JCO call, false if not.
    • setActive

      void setActive(String name, boolean active)
      Sets the marshall/unmarshall behavior of a parameter. If set to false the parameter will never be sent or fetched from the remote system. The default value is true, i.e. always get and send the parameter contents.
      Parameters:
      name - the name of the parameter
      active - true if the parameter should be sent or fetched during a JCO call, false if not.