Package step.repository.alm.otaclient

Interface IStepParams

  • All Superinterfaces:
    com4j.Com4jObject
    public interface IStepParams
extends com4j.Com4jObject
    Deprecated. Use ParameterValue and ParameterValueFactory. A collection of test parameters.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addParam​(java.lang.String paramName, java.lang.String paramType)
      Adds a new parameter to the object.
      java.lang.String baseValue​(java.lang.Object vParam, com4j.Holder<java.lang.Boolean> hasBaseValue)
      For HP use.
      void clearParam​(java.lang.Object vParam)
      Clears the parameter value by setting it to null.
      int count()
      The number of parameters for the object.
      void deleteParam​(java.lang.String paramName)
      Deletes the specified parameter.
      boolean paramExist​(java.lang.String paramName)
      Checks if a parameter of this name exists.
      java.lang.String paramName​(int nPosition)
      The name of the parameter in the specified position in the StepParams collection (zero-based).
      java.lang.String paramType​(java.lang.Object vParam)
      For HP use.
      void paramType​(java.lang.Object vParam, java.lang.String pVal)
      For HP use.
      java.lang.String paramValue​(java.lang.Object vParam)
      The value of the specified parameter.
      void paramValue​(java.lang.Object vParam, java.lang.String pVal)
      The value of the specified parameter.
      void refresh()
      Refreshes the data from the database, discarding changes.
      void save()
      Uploads the parameter definitions to the database.
      int type​(java.lang.Object vParam)
      Gets the parameter type: predefined, null, or regular.

      • Methods inherited from interface com4j.Com4jObject

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

    • Method Detail

      • count

        int count()

        The number of parameters for the object.

        Getter method for the COM property "Count"

        Returns:
        Returns a value of type int

      • paramValue

        java.lang.String paramValue​(java.lang.Object vParam)

        The value of the specified parameter.

        Getter method for the COM property "ParamValue"

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

      • paramValue

        void paramValue​(java.lang.Object vParam,
                java.lang.String pVal)

        The value of the specified parameter.

        Setter method for the COM property "ParamValue"

        Parameters:
        vParam - Mandatory java.lang.Object parameter.
        pVal - Mandatory java.lang.String parameter.

      • clearParam

        void clearParam​(java.lang.Object vParam)

        Clears the parameter value by setting it to null.

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

      • paramType

        java.lang.String paramType​(java.lang.Object vParam)

        For HP use. Gets Parameter Type - such as defined by user.

        Getter method for the COM property "ParamType"

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

      • paramType

        void paramType​(java.lang.Object vParam,
               java.lang.String pVal)

        For HP use. Gets Parameter Type - such as defined by user.

        Setter method for the COM property "ParamType"

        Parameters:
        vParam - Mandatory java.lang.Object parameter.
        pVal - Mandatory java.lang.String parameter.

      • paramExist

        boolean paramExist​(java.lang.String paramName)

        Checks if a parameter of this name exists.

        Getter method for the COM property "ParamExist"

        Parameters:
        paramName - Mandatory java.lang.String parameter.
        Returns:
        Returns a value of type boolean

      • baseValue

        java.lang.String baseValue​(java.lang.Object vParam,
                           com4j.Holder<java.lang.Boolean> hasBaseValue)

        For HP use. Gets a more basic value of the parameter - some default.

        Getter method for the COM property "BaseValue"

        Parameters:
        vParam - Mandatory java.lang.Object parameter.
        hasBaseValue - Mandatory Holder parameter.
        Returns:
        Returns a value of type java.lang.String

      • paramName

        java.lang.String paramName​(int nPosition)

        The name of the parameter in the specified position in the StepParams collection (zero-based).

        Getter method for the COM property "ParamName"

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

      • type

        int type​(java.lang.Object vParam)

        Gets the parameter type: predefined, null, or regular.

        Getter method for the COM property "Type"

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

      • save

        void save()

        Uploads the parameter definitions to the database.

      • refresh

        void refresh()

        Refreshes the data from the database, discarding changes.

      • addParam

        void addParam​(java.lang.String paramName,
              java.lang.String paramType)

        Adds a new parameter to the object.

        Parameters:
        paramName - Mandatory java.lang.String parameter.
        paramType - Mandatory java.lang.String parameter.

      • deleteParam

        void deleteParam​(java.lang.String paramName)

        Deletes the specified parameter.

        Parameters:
        paramName - Mandatory java.lang.String parameter.