Package step.repository.alm.v16.otaclient

Interface IReq

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int addCoverage​(int testId, int order)
      Assigns a test to cover this requirement.
      int addCoverageByFilter​(int subjectId, int order, java.lang.String testFilter)
      Adds the tests from the specified subject that match the input filter to the list of tests that cover the current requirement.
      int addCoverageEx​(int subjectId, int order)
      Assigns all the tests in the specified subject folder to cover this current requirement.
      java.lang.String author()
      The name of the requirement author.
      void author​(java.lang.String pVal)
      The name of the requirement author.
      java.lang.String comment()
      The comment associated with this requirement.
      void comment​(java.lang.String pVal)
      The comment associated with this requirement.
      int count()
      The number of direct children.
      IList getCoverList​(boolean recursive)
      Gets a list of the tests that cover this requirement.
      IList getCoverListByFilter​(java.lang.String testFilter, boolean recursive)
      Gets the list of all tests that cover the current requirement and match the filter.
      boolean hasCoverage()
      The requirement is covered by at least one test.
      boolean isFolder()
      No longer in use.
      void isFolder​(boolean pVal)
      No longer in use.
      void move​(int newFatherId, int newOrder)
      Moves a requirement to being a child of a specified father in the requirements tree.
      java.lang.String name()
      The Requirement name as seen in the tree.
      void name​(java.lang.String pVal)
      The Requirement name as seen in the tree.
      java.lang.String paragraph()
      The paragraph number or numeration of the requirement.
      java.lang.String path()
      The path of the node containing this requirement.
      java.lang.String priority()
      The requirement priority.
      void priority​(java.lang.String pVal)
      The requirement priority.
      java.lang.String product()
      The product name for which the requirement is set.
      void product​(java.lang.String pVal)
      The product name for which the requirement is set.
      void removeCoverage​(java.lang.Object vTest, boolean recursive)
      Removes a test from the list of tests that cover this requirement.
      com4j.Com4jObject reqCoverageStatus()
      For HP use.
      com4j.Com4jObject reqSummaryStatus()
      For HP use.
      java.lang.String reviewed()
      The review status.
      void reviewed​(java.lang.String pVal)
      The review status.
      java.lang.String status()
      The status of the tests that cover this requirement.
      java.lang.String type()
      The name of the requirement type.
      void type​(java.lang.String pVal)
      The name of the requirement type.

      • Methods inherited from interface com4j.Com4jObject

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

    • Method Detail

      • name

        java.lang.String name()

        The Requirement name as seen in the tree.

        Getter method for the COM property "Name"

        Returns:
        Returns a value of type java.lang.String

      • name

        void name​(java.lang.String pVal)

        The Requirement name as seen in the tree.

        Setter method for the COM property "Name"

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

      • comment

        java.lang.String comment()

        The comment associated with this requirement.

        Getter method for the COM property "Comment"

        Returns:
        Returns a value of type java.lang.String

      • comment

        void comment​(java.lang.String pVal)

        The comment associated with this requirement.

        Setter method for the COM property "Comment"

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

      • product

        java.lang.String product()

        The product name for which the requirement is set.

        Getter method for the COM property "Product"

        Returns:
        Returns a value of type java.lang.String

      • product

        void product​(java.lang.String pVal)

        The product name for which the requirement is set.

        Setter method for the COM property "Product"

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

      • type

        java.lang.String type()

        The name of the requirement type.

        Getter method for the COM property "Type"

        Returns:
        Returns a value of type java.lang.String

      • type

        void type​(java.lang.String pVal)

        The name of the requirement type.

        Setter method for the COM property "Type"

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

      • author

        java.lang.String author()

        The name of the requirement author.

        Getter method for the COM property "Author"

        Returns:
        Returns a value of type java.lang.String

      • author

        void author​(java.lang.String pVal)

        The name of the requirement author.

        Setter method for the COM property "Author"

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

      • count

        int count()

        The number of direct children.

        Getter method for the COM property "Count"

        Returns:
        Returns a value of type int

      • priority

        java.lang.String priority()

        The requirement priority.

        Getter method for the COM property "Priority"

        Returns:
        Returns a value of type java.lang.String

      • priority

        void priority​(java.lang.String pVal)

        The requirement priority.

        Setter method for the COM property "Priority"

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

      • status

        java.lang.String status()

        The status of the tests that cover this requirement.

        Getter method for the COM property "Status"

        Returns:
        Returns a value of type java.lang.String

      • reviewed

        java.lang.String reviewed()

        The review status.

        Getter method for the COM property "Reviewed"

        Returns:
        Returns a value of type java.lang.String

      • reviewed

        void reviewed​(java.lang.String pVal)

        The review status.

        Setter method for the COM property "Reviewed"

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

      • addCoverage

        int addCoverage​(int testId,
                int order)

        Assigns a test to cover this requirement.

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

      • addCoverageEx

        int addCoverageEx​(int subjectId,
                  int order)

        Assigns all the tests in the specified subject folder to cover this current requirement.

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

      • removeCoverage

        void removeCoverage​(java.lang.Object vTest,
                    @DefaultValue("0")
                    boolean recursive)

        Removes a test from the list of tests that cover this requirement.

        Parameters:
        vTest - Mandatory java.lang.Object parameter.
        recursive - Optional parameter. Default value is false

      • getCoverList

        IList getCoverList​(@DefaultValue("0")
                   boolean recursive)

        Gets a list of the tests that cover this requirement.

        Parameters:
        recursive - Optional parameter. Default value is false
        Returns:
        Returns a value of type step.repository.alm.v16.otaclient.IList

      • paragraph

        java.lang.String paragraph()

        The paragraph number or numeration of the requirement.

        Getter method for the COM property "Paragraph"

        Returns:
        Returns a value of type java.lang.String

      • path

        java.lang.String path()

        The path of the node containing this requirement.

        Getter method for the COM property "Path"

        Returns:
        Returns a value of type java.lang.String

      • hasCoverage

        boolean hasCoverage()

        The requirement is covered by at least one test.

        Getter method for the COM property "HasCoverage"

        Returns:
        Returns a value of type boolean

      • move

        void move​(int newFatherId,
          int newOrder)

        Moves a requirement to being a child of a specified father in the requirements tree.

        Parameters:
        newFatherId - Mandatory int parameter.
        newOrder - Mandatory int parameter.

      • isFolder

        boolean isFolder()

        No longer in use.

        Getter method for the COM property "IsFolder"

        Returns:
        Returns a value of type boolean

      • isFolder

        void isFolder​(boolean pVal)

        No longer in use.

        Setter method for the COM property "IsFolder"

        Parameters:
        pVal - Mandatory boolean parameter.

      • reqSummaryStatus

        com4j.Com4jObject reqSummaryStatus()

        For HP use. The ReqSummaryStatus object.

        Getter method for the COM property "ReqSummaryStatus"

        Returns:
        Returns a value of type com4j.Com4jObject

      • reqCoverageStatus

        com4j.Com4jObject reqCoverageStatus()

        For HP use. The requirement coverage.

        Getter method for the COM property "ReqCoverageStatus"

        Returns:
        Returns a value of type com4j.Com4jObject

      • addCoverageByFilter

        int addCoverageByFilter​(int subjectId,
                        int order,
                        java.lang.String testFilter)

        Adds the tests from the specified subject that match the input filter to the list of tests that cover the current requirement.

        Parameters:
        subjectId - Mandatory int parameter.
        order - Mandatory int parameter.
        testFilter - Mandatory java.lang.String parameter.
        Returns:
        Returns a value of type int

      • getCoverListByFilter

        IList getCoverListByFilter​(java.lang.String testFilter,
                           @DefaultValue("0")
                           boolean recursive)

        Gets the list of all tests that cover the current requirement and match the filter.

        Parameters:
        testFilter - Mandatory java.lang.String parameter.
        recursive - Optional parameter. Default value is false
        Returns:
        Returns a value of type step.repository.alm.v16.otaclient.IList