Package com.piketec.tpt.api

Interface TestCaseAttribute

  • All Superinterfaces:
    IdentifiableRemote, java.rmi.Remote, TptRemote
    public interface TestCaseAttribute
extends IdentifiableRemote
    A TestCaseAttribute represents a row in the Test Case Details view. It consists of a name and a type.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String STRING_TYPE
      Type String for String Test Case Attribute
      static java.lang.String URI_TYPE
      Deprecated.
      since TPT13 all attributes are strings.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getName()  
      java.lang.String getType()
      Returns the type of this attribute; currently it is always STRING_TYPE.
      boolean isCopyable()
      Indicates whether the value of a TestCaseAttribute will be copied with the test case it is assigned to.
      void setCopyable​(boolean on)
      Set a TestCaseAttribute to be "copyable".
      void setName​(java.lang.String newName)
      Set the name for this TestCaseAttribute

    • Field Detail

      • STRING_TYPE

        static final java.lang.String STRING_TYPE
        Type String for String Test Case Attribute
        See Also:
        Constant Field Values

      • URI_TYPE

        @Deprecated
static final java.lang.String URI_TYPE
        Deprecated.
        since TPT13 all attributes are strings. Will be removed in TPT-18.
        Type String for URI Test Case Attribute
        See Also:
        Constant Field Values

    • Method Detail

      • getType

        java.lang.String getType()
                  throws java.rmi.RemoteException
        Returns the type of this attribute; currently it is always STRING_TYPE.
        Returns:
        The type as a String (which contains the text 'String').
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getName

        java.lang.String getName()
                  throws java.rmi.RemoteException
        Returns:
        Returns the name of this TestCaseAttribute
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setName

        void setName​(java.lang.String newName)
      throws ApiException,
             java.rmi.RemoteException
        Set the name for this TestCaseAttribute
        Parameters:
        newName - The new name.
        Throws:
        ApiException - If newName==null or newName does already exist.
        java.rmi.RemoteException - remote communication problem

      • isCopyable

        boolean isCopyable()
            throws java.rmi.RemoteException
        Indicates whether the value of a TestCaseAttribute will be copied with the test case it is assigned to. In the TPT GUI this setting corresponds to the check box in the TestCaseAttribute definition dialog.
        Returns:
        true, if the TestCaseAttribute will be automatically copied
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setCopyable

        void setCopyable​(boolean on)
          throws java.rmi.RemoteException
        Set a TestCaseAttribute to be "copyable". The values of a "copyable" TestCaseAttribute are automatically copied into the new test case, when the corresponding test case is copied or duplicated.
        Parameters:
        on - true, if TestCaseAttribute should be "copyable".
        Throws:
        java.rmi.RemoteException - remote communication problem