Package step.repository.alm.otaclient

Interface IParam

  • All Superinterfaces:
    com4j.Com4jObject
    All Known Subinterfaces:
    ICommand, ICommand2
    public interface IParam
extends com4j.Com4jObject
    Services for managing parameters for a Command object.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addParam​(String name, Object initialValue)
      Adds new parameter to Command object.
      int count()
      Number of parameters in current command.
      void deleteParam​(Object key)
      Deletes the specified parameter from Command object.
      void deleteParams()
      Deletes all parameters from Command object.
      int paramIndex​(String name)
      The parameter index by parameter name.
      String paramName​(int index)
      The parameter name by parameter index.
      int paramType​(int index)
      The data type of the specified parameter.
      Object paramValue​(Object key)
      The parameter value.
      void paramValue​(Object key, Object pVal)
      The parameter value.

      • Methods inherited from interface com4j.Com4jObject

        advise, dispose, equals, getComThread, getIUnknownPointer, getPointer, getPtr, hashCode, is, queryInterface, setName, toString

    • Method Detail

      • count

        int count()

        Number of parameters in current command.

        Getter method for the COM property "Count"

        Returns:
        Returns a value of type int

      • paramValue

        Object paramValue​(Object key)

        The parameter value.

        Getter method for the COM property "ParamValue"

        Parameters:
        key - Mandatory java.lang.Object parameter.
        Returns:
        Returns a value of type java.lang.Object

      • paramValue

        void paramValue​(Object key,
                Object pVal)

        The parameter value.

        Setter method for the COM property "ParamValue"

        Parameters:
        key - Mandatory java.lang.Object parameter.
        pVal - Mandatory java.lang.Object parameter.

      • paramName

        String paramName​(int index)

        The parameter name by parameter index. The index is 0-based.

        Getter method for the COM property "ParamName"

        Parameters:
        index - Mandatory int parameter.
        Returns:
        Returns a value of type java.lang.String

      • paramIndex

        int paramIndex​(String name)

        The parameter index by parameter name.

        Getter method for the COM property "ParamIndex"

        Parameters:
        name - Mandatory java.lang.String parameter.
        Returns:
        Returns a value of type int

      • addParam

        void addParam​(String name,
              Object initialValue)

        Adds new parameter to Command object.

        Parameters:
        name - Mandatory java.lang.String parameter.
        initialValue - Mandatory java.lang.Object parameter.

      • deleteParam

        void deleteParam​(Object key)

        Deletes the specified parameter from Command object.

        Parameters:
        key - Mandatory java.lang.Object parameter.

      • deleteParams

        void deleteParams()

        Deletes all parameters from Command object.

      • paramType

        int paramType​(int index)

        The data type of the specified parameter. The index is 0-based.

        Getter method for the COM property "ParamType"

        Parameters:
        index - Mandatory int parameter.
        Returns:
        Returns a value of type int