Package com.mks.tm.api

Interface ITestResultDelta

public interface ITestResultDelta
A record of the modifications that will be made to a test result.

  • Method Details

    • getTestSessionID

      int getTestSessionID()
      The ID of the test session.
      Returns:
      The ID of the test session.

    • getTestCaseID

      int getTestCaseID()
      The ID of the test case.
      Returns:
      The ID of the test case.

    • addAttachment

      ITestResultAttachmentDelta addAttachment(File file, String name, String summary) throws TMAPIException
      Add an attachment to a test result.
      Parameters:
      file - The local file that contains the content.
      name - The name for the attachment.
      summary - The summary for the attachment.
      Returns:
      The attachment delta which records the addition of the attachment.
      Throws:
      TMAPIException - Reserved exception.

    • getAddedAttachments

      Collection<ITestResultAttachmentDelta> getAddedAttachments() throws TMAPIException
      Get the collection of attachment deltas for the attachments that will be added to the test result.
      Returns:
      The collection of attachment deltas for the attachments that will be added to the test result.
      Throws:
      TMAPIException - Reserved exception.

    • removeAttachment

      ITestResultAttachmentDelta removeAttachment(String name) throws TMAPIException
      Remove an attachment from a test result.
      Parameters:
      name - The name of the attachment to remove from the test result.
      Returns:
      The attachment delta which records the removal of the attachment.
      Throws:
      TMAPIException - Reserved exception.

    • getRemovedAttachments

      Collection<ITestResultAttachmentDelta> getRemovedAttachments() throws TMAPIException
      Get the collection of attachment names for the attachments that will be removed from the test result.
      Returns:
      The collection of attachment deltas for the attachments that will be removed from the test result.
      Throws:
      TMAPIException - Reserved exception.

    • addRelatedItem

      void addRelatedItem(int itemID) throws TMAPIException
      Add a relationship from the test result.
      Parameters:
      itemID - The ID of the item to add as a relationship for the test result.
      Throws:
      TMAPIException - Reserved exception.

    • getAddedRelatedItems

      Collection<Integer> getAddedRelatedItems() throws TMAPIException
      Get the collection of related item IDs that will be added to the test result.
      Returns:
      The collection of related item IDs that will be added to the test result.
      Throws:
      TMAPIException - Reserved exception.

    • removeRelatedItem

      void removeRelatedItem(int itemID) throws TMAPIException
      Remove a relationship from the test result.
      Parameters:
      itemID - The ID of the item to remove from the test result.
      Throws:
      TMAPIException - Reserved exception.

    • getRemovedRelatedItems

      Collection<Integer> getRemovedRelatedItems() throws TMAPIException
      Get the collection of related item IDs that will be removed from the test result.
      Returns:
      The collection of related item IDs that will be removed from the test result.
      Throws:
      TMAPIException - Reserved exception.

    • setAnnotation

      void setAnnotation(String annotation) throws TMAPIException
      Set the annotation for the test result.
      Parameters:
      annotation - The annotation for the test result.
      Throws:
      TMAPIException - Reserved exception.

    • getAnnotation

      String getAnnotation() throws TMAPIException
      Get the annotation for the test result.
      Returns:
      The annotation for the test result.
      Throws:
      TMAPIException - Reserved exception.

    • setVerdict

      void setVerdict(String verdict) throws TMAPIException
      Set the verdict for the test result.
      Parameters:
      verdict - The verdict for the test result.
      Throws:
      TMAPIException - Reserved exception.

    • getVerdict

      String getVerdict() throws TMAPIException
      Get the verdict for the test result.
      Returns:
      The verdict for the test result.
      Throws:
      TMAPIException - Reserved exception.