Package step.repository.alm.v16.otaclient

Interface ITDConnection

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com4j.Com4jObject actionPermission()
      The ActionPermission object for this connection.
      com4j.Com4jObject alertManager()
      The AlertManager object for this connection.
      boolean allowReconnect()
      For HP use.
      void allowReconnect​(boolean pVal)
      For HP use.
      com4j.Com4jObject analysis()
      For HP use.
      com4j.Com4jObject bugFactory()
      The Bug Factory object for this connection.
      com4j.Com4jObject changeFactory()
      Obsolete.
      void changePassword​(java.lang.String oldPassword, java.lang.String newPassword)
      Changes the password for the currently logged in user.
      java.lang.String checkoutRepository()
      The path of the checkout repository.
      void clientType​(java.lang.String newVal, java.lang.String rhs)
      For HP use.
      com4j.Com4jObject command()
      The Command object for this connection.
      com4j.Com4jObject commonSettings()
      The Settings object for all users in this connection.
      com4j.Com4jObject componentFactory()
      For HP use.
      com4j.Com4jObject componentFolderFactory()
      The Component Folder Factory object for this connection.
      boolean connected()
      Checks if the Open Test Architecture API server connection is initialized.
      void connectProject​(java.lang.String projectName, java.lang.String userName, java.lang.String password)
      Connects to the specified project.
      void connectProjectEx​(java.lang.String domainName, java.lang.String projectName, java.lang.String userName, java.lang.String password)
      Connects to the specified project in the specified domain.
      void connectToVCSAs​(java.lang.String userName, java.lang.String password, java.lang.String copyDesStep)
      Obsolete.
      com4j.Com4jObject customization()
      The Customization object for this connection.
      com4j.Com4jObject dbManager()
      Obsolete.
      java.lang.String dbName()
      The name of the database.
      java.lang.String dbType()
      The database type.
      java.lang.String directoryPath​(int nType)
      The path of the server side repository directory for the database repository type.
      void disconnectProject()
      Disconnects from the project.
      java.lang.String domainName()
      The current domain.
      IList domainsList()
      The domain names for this site.
      java.lang.Object domainsList​(int index)  
      com4j.Com4jObject extendedStorage()
      Disabled by default security settings.
      IList fields​(java.lang.String dataType)
      A list of fields for the table specified in the DataType argument.
      void getLicense​(int licenseType)
      For HP use.
      void getLicenses​(int licensesType, com4j.Holder<java.lang.String> pVal)
      Allocates multiple licenses types according to the LicensesType parameter.
      void getLicenseStatus​(int clientType, com4j.Holder<java.lang.Integer> inUse, com4j.Holder<java.lang.Integer> max)
      The license status for the specified client type.
      void getTDVersion​(com4j.Holder<java.lang.String> pbsMajorVersion, com4j.Holder<java.lang.String> pbsBuildNum)
      The major and minor versions of the OTA API.
      com4j.Com4jObject hostFactory()
      The Hosts Factory object for this connection.
      com4j.Com4jObject hostGroupFactory()
      The HostGroupFactory object for this connection.
      boolean ignoreHtmlFormat()
      Indicates if formatted memo and description fields are returned as plain text without HTML tags.
      void ignoreHtmlFormat​(boolean pVal)
      Indicates if formatted memo and description fields are returned as plain text without HTML tags.
      void initConnection​(java.lang.String serverName, java.lang.String domainName, java.lang.String domainPswd)
      For HP use.
      void initConnectionEx​(java.lang.String serverName)
      Initializes the connection.
      boolean keepConnection()
      For HP use.
      void keepConnection​(boolean pVal)
      For HP use.
      com4j.Com4jObject mailConditions()
      The TDMailConditions object for this connection.
      boolean moduleVisible​(int moduleID)
      Checks if the specified module is visible to the connected user.
      java.lang.String password()
      For HP use.
      boolean projectConnected()
      Checks if the TDConnection is connected to a project.
      java.lang.String projectName()
      The name of the connected project.
      com4j.Com4jObject projectProperties()
      The ProjectProperties object for this connection.
      IList projectsList()
      The projects that are available in the domain to which Quality Center is connected.
      java.lang.Object projectsList​(int index)  
      IList projectsListEx​(java.lang.String domainName)
      The projects available within the specified domain.
      void purgeRuns​(java.lang.String testSetFilter, int keepLast, java.lang.Object dateUnit, int unitCount, boolean stepsOnly)
      Deletes the specified runs.
      void releaseConnection()
      Releases the COM pointer created when the connection is initialized.
      java.lang.String reportRole()
      The report role of the connected user.
      com4j.Com4jObject reqFactory()
      The ReqFactory object for this connection.
      com4j.Com4jObject rules()
      The RuleManager object for this connection.
      com4j.Com4jObject runFactory()
      The RunFactory object for this connection.
      void sendMail​(java.lang.String sendTo, java.lang.String sendFrom, java.lang.String subject, java.lang.String message, java.lang.Object attachArray, java.lang.String bsFormat)
      Sends Mail.
      java.lang.String serverName()
      The name of the connected Open Test Architecture API server.
      java.util.Date serverTime()
      The time and date of the application server.
      java.lang.String serverURL()
      The URL of the connected server.
      void synchronizeFollowUps​(java.lang.String password)
      Obsolete.
      java.lang.String tdParams​(java.lang.String request)
      Gets the value of the parameter whose name is specified by Request.
      com4j.Com4jObject tdSettings()
      For future use.
      com4j.Com4jObject testFactory()
      The Test Factory object for this connection.
      java.lang.String testRepository()
      The path of the tests directory of the connected project.
      com4j.Com4jObject testSetFactory()
      The Test Set Factory object for this connection.
      com4j.Com4jObject testSetTreeManager()
      The TestSetTreeManager object for this connection.
      com4j.Com4jObject textParam()
      The TextParser object.
      com4j.Com4jObject treeManager()
      The TreeManager object for the system tree.
      IList userGroupsList()
      The names of the user groups of the currently connected project.
      java.lang.Object userGroupsList​(int index)  
      java.lang.String userName()
      The user connected to the project.
      com4j.Com4jObject userSettings()
      The Settings object for the logged-on user.
      IList usersList()
      The names of the users of the currently connected project.
      java.lang.Object usersList​(int index)  
      boolean usingProgress()
      Indicates if a progress bar is displayed.
      void usingProgress​(boolean pVal)
      Indicates if a progress bar is displayed.
      com4j.Com4jObject vcs()
      Obsolete.
      java.lang.String vcsDbRepository()
      The path of the VCS database of the connected project.
      java.lang.String viewsRepository()
      Obsolete.
      java.lang.String vmRepository()
      Obsolete.

      • Methods inherited from interface com4j.Com4jObject

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

    • Method Detail

      • connected

        boolean connected()

        Checks if the Open Test Architecture API server connection is initialized.

        Getter method for the COM property "Connected"

        Returns:
        Returns a value of type boolean

      • projectConnected

        boolean projectConnected()

        Checks if the TDConnection is connected to a project.

        Getter method for the COM property "ProjectConnected"

        Returns:
        Returns a value of type boolean

      • serverName

        java.lang.String serverName()

        The name of the connected Open Test Architecture API server.

        Getter method for the COM property "ServerName"

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

      • projectName

        java.lang.String projectName()

        The name of the connected project.

        Getter method for the COM property "ProjectName"

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

      • testRepository

        java.lang.String testRepository()

        The path of the tests directory of the connected project.

        Getter method for the COM property "TestRepository"

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

      • userName

        java.lang.String userName()

        The user connected to the project.

        Getter method for the COM property "UserName"

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

      • testFactory

        com4j.Com4jObject testFactory()

        The Test Factory object for this connection.

        Getter method for the COM property "TestFactory"

        Returns:
        Returns a value of type com4j.Com4jObject

      • bugFactory

        com4j.Com4jObject bugFactory()

        The Bug Factory object for this connection.

        Getter method for the COM property "BugFactory"

        Returns:
        Returns a value of type com4j.Com4jObject

      • testSetFactory

        com4j.Com4jObject testSetFactory()

        The Test Set Factory object for this connection.

        Getter method for the COM property "TestSetFactory"

        Returns:
        Returns a value of type com4j.Com4jObject

      • userGroupsList

        IList userGroupsList()

        The names of the user groups of the currently connected project.

        Getter method for the COM property "UserGroupsList"

        Returns:
        Returns a value of type step.repository.alm.v16.otaclient.IList

      • userGroupsList

        java.lang.Object userGroupsList​(int index)

      • hostFactory

        com4j.Com4jObject hostFactory()

        The Hosts Factory object for this connection.

        Getter method for the COM property "HostFactory"

        Returns:
        Returns a value of type com4j.Com4jObject

      • vcs

        com4j.Com4jObject vcs()

        Obsolete. Accessing this property throws an exception.

        Getter method for the COM property "VCS"

        Returns:
        Returns a value of type com4j.Com4jObject

      • initConnection

        void initConnection​(java.lang.String serverName,
                    @DefaultValue("")
                    java.lang.String domainName,
                    @DefaultValue("")
                    java.lang.String domainPswd)

        For HP use. Initializes the Open Test Architecture API server connection for specified domain.

        Parameters:
        serverName - Mandatory java.lang.String parameter.
        domainName - Optional parameter. Default value is ""
        domainPswd - Optional parameter. Default value is ""

      • releaseConnection

        void releaseConnection()

        Releases the COM pointer created when the connection is initialized.

      • connectProject

        void connectProject​(java.lang.String projectName,
                    java.lang.String userName,
                    @DefaultValue("")
                    java.lang.String password)

        Connects to the specified project.

        Parameters:
        projectName - Mandatory java.lang.String parameter.
        userName - Mandatory java.lang.String parameter.
        password - Optional parameter. Default value is ""

      • disconnectProject

        void disconnectProject()

        Disconnects from the project.

      • projectsList

        IList projectsList()

        The projects that are available in the domain to which Quality Center is connected.

        Getter method for the COM property "ProjectsList"

        Returns:
        Returns a value of type step.repository.alm.v16.otaclient.IList

      • projectsList

        java.lang.Object projectsList​(int index)

      • command

        com4j.Com4jObject command()

        The Command object for this connection.

        Getter method for the COM property "Command"

        Returns:
        Returns a value of type com4j.Com4jObject

      • treeManager

        com4j.Com4jObject treeManager()

        The TreeManager object for the system tree.

        Getter method for the COM property "TreeManager"

        Returns:
        Returns a value of type com4j.Com4jObject

      • reqFactory

        com4j.Com4jObject reqFactory()

        The ReqFactory object for this connection.

        Getter method for the COM property "ReqFactory"

        Returns:
        Returns a value of type com4j.Com4jObject

      • actionPermission

        com4j.Com4jObject actionPermission()

        The ActionPermission object for this connection.

        Getter method for the COM property "ActionPermission"

        Returns:
        Returns a value of type com4j.Com4jObject

      • getLicense

        void getLicense​(int licenseType)

        For HP use. Allocates a license type according to the LicenseType parameter.

        Parameters:
        licenseType - Mandatory int parameter.

      • sendMail

        void sendMail​(java.lang.String sendTo,
              @DefaultValue("")
              java.lang.String sendFrom,
              @DefaultValue("")
              java.lang.String subject,
              @DefaultValue("")
              java.lang.String message,
              java.lang.Object attachArray,
              @DefaultValue("")
              java.lang.String bsFormat)

        Sends Mail.

        Parameters:
        sendTo - Mandatory java.lang.String parameter.
        sendFrom - Optional parameter. Default value is ""
        subject - Optional parameter. Default value is ""
        message - Optional parameter. Default value is ""
        attachArray - Optional parameter. Default value is com4j.Variant.getMissing()
        bsFormat - Optional parameter. Default value is ""

      • dbType

        java.lang.String dbType()

        The database type.

        Getter method for the COM property "DBType"

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

      • dbManager

        com4j.Com4jObject dbManager()

        Obsolete. Do not invoke.

        Getter method for the COM property "DBManager"

        Returns:
        Returns a value of type com4j.Com4jObject

      • customization

        com4j.Com4jObject customization()

        The Customization object for this connection.

        Getter method for the COM property "Customization"

        Returns:
        Returns a value of type com4j.Com4jObject

      • fields

        IList fields​(java.lang.String dataType)

        A list of fields for the table specified in the DataType argument.

        Getter method for the COM property "Fields"

        Parameters:
        dataType - Mandatory java.lang.String parameter.
        Returns:
        Returns a value of type step.repository.alm.v16.otaclient.IList

      • commonSettings

        com4j.Com4jObject commonSettings()

        The Settings object for all users in this connection.

        Getter method for the COM property "CommonSettings"

        Returns:
        Returns a value of type com4j.Com4jObject

      • userSettings

        com4j.Com4jObject userSettings()

        The Settings object for the logged-on user.

        Getter method for the COM property "UserSettings"

        Returns:
        Returns a value of type com4j.Com4jObject

      • hostGroupFactory

        com4j.Com4jObject hostGroupFactory()

        The HostGroupFactory object for this connection.

        Getter method for the COM property "HostGroupFactory"

        Returns:
        Returns a value of type com4j.Com4jObject

      • changePassword

        void changePassword​(java.lang.String oldPassword,
                    java.lang.String newPassword)

        Changes the password for the currently logged in user.

        Parameters:
        oldPassword - Mandatory java.lang.String parameter.
        newPassword - Mandatory java.lang.String parameter.

      • usersList

        IList usersList()

        The names of the users of the currently connected project.

        Getter method for the COM property "UsersList"

        Returns:
        Returns a value of type step.repository.alm.v16.otaclient.IList

      • usersList

        java.lang.Object usersList​(int index)

      • password

        java.lang.String password()

        For HP use. The password for the logged in user.

        Getter method for the COM property "Password"

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

      • extendedStorage

        com4j.Com4jObject extendedStorage()

        Disabled by default security settings. Use the entity-level extended storage property.

        Getter method for the COM property "ExtendedStorage"

        Returns:
        Returns a value of type com4j.Com4jObject

      • directoryPath

        java.lang.String directoryPath​(int nType)

        The path of the server side repository directory for the database repository type.

        Getter method for the COM property "DirectoryPath"

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

      • changeFactory

        com4j.Com4jObject changeFactory()

        Obsolete. Do not invoke.

        Getter method for the COM property "ChangeFactory"

        Returns:
        Returns a value of type com4j.Com4jObject

      • mailConditions

        com4j.Com4jObject mailConditions()

        The TDMailConditions object for this connection.

        Getter method for the COM property "MailConditions"

        Returns:
        Returns a value of type com4j.Com4jObject

      • serverTime

        java.util.Date serverTime()

        The time and date of the application server.

        Getter method for the COM property "ServerTime"

        Returns:
        Returns a value of type java.util.Date

      • tdSettings

        com4j.Com4jObject tdSettings()

        For future use. An ITDSettings reference.

        Getter method for the COM property "TDSettings"

        Returns:
        Returns a value of type com4j.Com4jObject

      • purgeRuns

        void purgeRuns​(java.lang.String testSetFilter,
               int keepLast,
               java.lang.Object dateUnit,
               int unitCount,
               boolean stepsOnly)

        Deletes the specified runs.

        Parameters:
        testSetFilter - Mandatory java.lang.String parameter.
        keepLast - Mandatory int parameter.
        dateUnit - Mandatory java.lang.Object parameter.
        unitCount - Mandatory int parameter.
        stepsOnly - Mandatory boolean parameter.

      • projectProperties

        com4j.Com4jObject projectProperties()

        The ProjectProperties object for this connection.

        Getter method for the COM property "ProjectProperties"

        Returns:
        Returns a value of type com4j.Com4jObject

      • getLicenseStatus

        void getLicenseStatus​(int clientType,
                      com4j.Holder<java.lang.Integer> inUse,
                      com4j.Holder<java.lang.Integer> max)

        The license status for the specified client type.

        Parameters:
        clientType - Mandatory int parameter.
        inUse - Mandatory Holder parameter.
        max - Mandatory Holder parameter.

      • domainName

        java.lang.String domainName()

        The current domain.

        Getter method for the COM property "DomainName"

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

      • textParam

        com4j.Com4jObject textParam()

        The TextParser object.

        Getter method for the COM property "TextParam"

        Returns:
        Returns a value of type com4j.Com4jObject

      • tdParams

        java.lang.String tdParams​(java.lang.String request)

        Gets the value of the parameter whose name is specified by Request.

        Getter method for the COM property "TDParams"

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

      • usingProgress

        boolean usingProgress()

        Indicates if a progress bar is displayed.

        Getter method for the COM property "UsingProgress"

        Returns:
        Returns a value of type boolean

      • usingProgress

        void usingProgress​(boolean pVal)

        Indicates if a progress bar is displayed.

        Setter method for the COM property "UsingProgress"

        Parameters:
        pVal - Mandatory boolean parameter.

      • checkoutRepository

        java.lang.String checkoutRepository()

        The path of the checkout repository.

        Getter method for the COM property "CheckoutRepository"

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

      • viewsRepository

        java.lang.String viewsRepository()

        Obsolete. Do not invoke.

        Getter method for the COM property "ViewsRepository"

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

      • vcsDbRepository

        java.lang.String vcsDbRepository()

        The path of the VCS database of the connected project.

        Getter method for the COM property "VcsDbRepository"

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

      • runFactory

        com4j.Com4jObject runFactory()

        The RunFactory object for this connection.

        Getter method for the COM property "RunFactory"

        Returns:
        Returns a value of type com4j.Com4jObject

      • moduleVisible

        boolean moduleVisible​(int moduleID)

        Checks if the specified module is visible to the connected user. This property is used for Quality Center UI programming and has no function in third-party applications.

        Getter method for the COM property "ModuleVisible"

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

      • initConnectionEx

        void initConnectionEx​(java.lang.String serverName)

        Initializes the connection.

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

      • projectsListEx

        IList projectsListEx​(java.lang.String domainName)

        The projects available within the specified domain.

        Getter method for the COM property "ProjectsListEx"

        Parameters:
        domainName - Mandatory java.lang.String parameter.
        Returns:
        Returns a value of type step.repository.alm.v16.otaclient.IList

      • connectProjectEx

        void connectProjectEx​(java.lang.String domainName,
                      java.lang.String projectName,
                      java.lang.String userName,
                      @DefaultValue("")
                      java.lang.String password)

        Connects to the specified project in the specified domain.

        Parameters:
        domainName - Mandatory java.lang.String parameter.
        projectName - Mandatory java.lang.String parameter.
        userName - Mandatory java.lang.String parameter.
        password - Optional parameter. Default value is ""

      • domainsList

        IList domainsList()

        The domain names for this site.

        Getter method for the COM property "DomainsList"

        Returns:
        Returns a value of type step.repository.alm.v16.otaclient.IList

      • domainsList

        java.lang.Object domainsList​(int index)

      • connectToVCSAs

        void connectToVCSAs​(java.lang.String userName,
                    java.lang.String password,
                    java.lang.String copyDesStep)

        Obsolete. Do not invoke.

        Parameters:
        userName - Mandatory java.lang.String parameter.
        password - Mandatory java.lang.String parameter.
        copyDesStep - Mandatory java.lang.String parameter.

      • getLicenses

        void getLicenses​(int licensesType,
                 com4j.Holder<java.lang.String> pVal)

        Allocates multiple licenses types according to the LicensesType parameter.

        Parameters:
        licensesType - Mandatory int parameter.
        pVal - Mandatory Holder parameter.

      • analysis

        com4j.Com4jObject analysis()

        For HP use. Property Analysis.

        Getter method for the COM property "Analysis"

        Returns:
        Returns a value of type com4j.Com4jObject

      • vmRepository

        java.lang.String vmRepository()

        Obsolete. Do not invoke.

        Getter method for the COM property "VMRepository"

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

      • dbName

        java.lang.String dbName()

        The name of the database.

        Getter method for the COM property "DBName"

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

      • rules

        com4j.Com4jObject rules()

        The RuleManager object for this connection.

        Getter method for the COM property "Rules"

        Returns:
        Returns a value of type com4j.Com4jObject

      • testSetTreeManager

        com4j.Com4jObject testSetTreeManager()

        The TestSetTreeManager object for this connection.

        Getter method for the COM property "TestSetTreeManager"

        Returns:
        Returns a value of type com4j.Com4jObject

      • alertManager

        com4j.Com4jObject alertManager()

        The AlertManager object for this connection.

        Getter method for the COM property "AlertManager"

        Returns:
        Returns a value of type com4j.Com4jObject

      • allowReconnect

        boolean allowReconnect()

        For HP use. Allows repeat call to InitConnection,ReleaseConnection, ConnectProject and DisconnectProject.

        Getter method for the COM property "AllowReconnect"

        Returns:
        Returns a value of type boolean

      • allowReconnect

        void allowReconnect​(boolean pVal)

        For HP use. Allows repeat call to InitConnection,ReleaseConnection, ConnectProject and DisconnectProject.

        Setter method for the COM property "AllowReconnect"

        Parameters:
        pVal - Mandatory boolean parameter.

      • synchronizeFollowUps

        void synchronizeFollowUps​(java.lang.String password)

        Obsolete. Do not invoke.

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

      • keepConnection

        boolean keepConnection()

        For HP use. Prevents automatic disconnect by server on timeout.

        Getter method for the COM property "KeepConnection"

        Returns:
        Returns a value of type boolean

      • keepConnection

        void keepConnection​(boolean pVal)

        For HP use. Prevents automatic disconnect by server on timeout.

        Setter method for the COM property "KeepConnection"

        Parameters:
        pVal - Mandatory boolean parameter.

      • ignoreHtmlFormat

        boolean ignoreHtmlFormat()

        Indicates if formatted memo and description fields are returned as plain text without HTML tags.

        Getter method for the COM property "IgnoreHtmlFormat"

        Returns:
        Returns a value of type boolean

      • ignoreHtmlFormat

        void ignoreHtmlFormat​(boolean pVal)

        Indicates if formatted memo and description fields are returned as plain text without HTML tags.

        Setter method for the COM property "IgnoreHtmlFormat"

        Parameters:
        pVal - Mandatory boolean parameter.

      • reportRole

        java.lang.String reportRole()

        The report role of the connected user.

        Getter method for the COM property "ReportRole"

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

      • clientType

        void clientType​(java.lang.String newVal,
                @DefaultValue("")
                java.lang.String rhs)

        For HP use. Sets the Client type.

        Setter method for the COM property "ClientType"

        Parameters:
        newVal - Mandatory java.lang.String parameter.
        rhs - Optional parameter. Default value is ""

      • componentFactory

        com4j.Com4jObject componentFactory()

        For HP use. The Component Factory object for this connection.

        Getter method for the COM property "ComponentFactory"

        Returns:
        Returns a value of type com4j.Com4jObject

      • componentFolderFactory

        com4j.Com4jObject componentFolderFactory()

        The Component Folder Factory object for this connection.

        Getter method for the COM property "ComponentFolderFactory"

        Returns:
        Returns a value of type com4j.Com4jObject

      • getTDVersion

        void getTDVersion​(com4j.Holder<java.lang.String> pbsMajorVersion,
                  com4j.Holder<java.lang.String> pbsBuildNum)

        The major and minor versions of the OTA API.

        Parameters:
        pbsMajorVersion - Mandatory Holder parameter.
        pbsBuildNum - Mandatory Holder parameter.

      • serverURL

        java.lang.String serverURL()

        The URL of the connected server.

        Getter method for the COM property "ServerURL"

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