Package step.repository.alm.otaclient

Interface ITDConnection

    • 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

        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

        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

        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

        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 otaclient.IList

      • userGroupsList

        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()

        The Version Control System (VCS) object for this connection.

        Getter method for the COM property "VCS"

        Returns:
        Returns a value of type com4j.Com4jObject

      • initConnection

        void initConnection​(String serverName,
                    @DefaultValue("")
                    String domainName,
                    @DefaultValue("")
                    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()

        ReleaseConnection must be called for each call of an initialization method after finishing work with the Open Test Architecture API.

      • connectProject

        void connectProject​(String projectName,
                    String userName,
                    @DefaultValue("")
                    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 otaclient.IList

      • projectsList

        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​(String sendTo,
              @DefaultValue("")
              String sendFrom,
              @DefaultValue("")
              String subject,
              @DefaultValue("")
              String message,
              Object attachArray,
              @DefaultValue("")
              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

        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()

        For HP use. The project DBManager object for this connection.

        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​(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 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​(String oldPassword,
                    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 otaclient.IList

      • usersList

        Object usersList​(int index)

      • password

        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()

        Deprecated. Use the entity-level extended storage property.

        Getter method for the COM property "ExtendedStorage"

        Returns:
        Returns a value of type com4j.Com4jObject

      • directoryPath

        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()

        For HP use. The ChangeFactory object for this connection.

        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

        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​(String testSetFilter,
               int keepLast,
               Object dateUnit,
               int unitCount,
               boolean stepsOnly)

        Deletes the runs in this connection that match the input arguments.

        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<Integer> inUse,
                      com4j.Holder<Integer> max)

        The license status for the specified client type.

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

      • domainName

        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

        String tdParams​(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

        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

        String viewsRepository()

        Obsolete. Property ViewsRepository.

        Getter method for the COM property "ViewsRepository"

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

      • vcsDbRepository

        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​(String serverName)

        Initializes the connection.

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

      • projectsListEx

        IList projectsListEx​(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 otaclient.IList

      • connectProjectEx

        void connectProjectEx​(String domainName,
                      String projectName,
                      String userName,
                      @DefaultValue("")
                      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 otaclient.IList

      • domainsList

        Object domainsList​(int index)

      • connectToVCSAs

        void connectToVCSAs​(String userName,
                    String password,
                    String copyDesStep)

        Obsolete. Method ConnectToVCSAs.

        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<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

        String vmRepository()

        Obsolete. Property VMRepository.

        Getter method for the COM property "VMRepository"

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

      • dbName

        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​(String password)

        Obsolete: Sends all previously unsent followups.

        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

        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​(String newVal,
                @DefaultValue("")
                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()

        For HP use. 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<String> pbsMajorVersion,
                  com4j.Holder<String> pbsBuildNum)

        The major and minor versions of the OTA API.

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

      • serverURL

        String serverURL()

        The URL of the connected server.

        Getter method for the COM property "ServerURL"

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