public interface ITDConnection
extends com4j.Com4jObject
Modifier and Type | Method and 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()
For HP use.
|
void |
changePassword(String oldPassword,
String newPassword)
Changes the password for the currently logged in user.
|
String |
checkoutRepository()
The path of the checkout repository.
|
void |
clientType(String newVal,
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()
For HP use.
|
boolean |
connected()
Checks if the Open Test Architecture API server connection is initialized.
|
void |
connectProject(String projectName,
String userName,
String password)
Connects to the specified project.
|
void |
connectProjectEx(String domainName,
String projectName,
String userName,
String password)
Connects to the specified project in the specified domain.
|
void |
connectToVCSAs(String userName,
String password,
String copyDesStep)
Obsolete.
|
com4j.Com4jObject |
customization()
The Customization object for this connection.
|
com4j.Com4jObject |
dbManager()
For HP use.
|
String |
dbName()
The name of the database.
|
String |
dbType()
The database type.
|
String |
directoryPath(int nType)
The path of the server side repository directory for the database repository type.
|
void |
disconnectProject()
Disconnects from the project.
|
String |
domainName()
The current domain.
|
IList |
domainsList()
The domain names for this site.
|
Object |
domainsList(int index) |
com4j.Com4jObject |
extendedStorage()
Deprecated.
|
IList |
fields(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<String> pVal)
Allocates multiple licenses types according to the LicensesType parameter.
|
void |
getLicenseStatus(int clientType,
com4j.Holder<Integer> inUse,
com4j.Holder<Integer> max)
The license status for the specified client type.
|
void |
getTDVersion(com4j.Holder<String> pbsMajorVersion,
com4j.Holder<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(String serverName,
String domainName,
String domainPswd)
For HP use.
|
void |
initConnectionEx(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.
|
String |
password()
For HP use.
|
boolean |
projectConnected()
Checks if the TDConnection is connected to a project.
|
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.
|
Object |
projectsList(int index) |
IList |
projectsListEx(String domainName)
The projects available within the specified domain.
|
void |
purgeRuns(String testSetFilter,
int keepLast,
Object dateUnit,
int unitCount,
boolean stepsOnly)
Deletes the runs in this connection that match the input arguments.
|
void |
releaseConnection()
ReleaseConnection must be called for each call of an initialization method after finishing work with the Open Test Architecture API.
|
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(String sendTo,
String sendFrom,
String subject,
String message,
Object attachArray,
String bsFormat)
Sends Mail.
|
String |
serverName()
The name of the connected Open Test Architecture API server.
|
Date |
serverTime()
The time and date of the application server.
|
String |
serverURL()
The URL of the connected server.
|
void |
synchronizeFollowUps(String password)
Obsolete: Sends all previously unsent followups.
|
String |
tdParams(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.
|
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.
|
Object |
userGroupsList(int index) |
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.
|
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()
The Version Control System (VCS) object for this connection.
|
String |
vcsDbRepository()
The path of the VCS database of the connected project.
|
String |
viewsRepository()
Obsolete.
|
String |
vmRepository()
Obsolete.
|
boolean connected()
Checks if the Open Test Architecture API server connection is initialized.
Getter method for the COM property "Connected"
boolean projectConnected()
Checks if the TDConnection is connected to a project.
Getter method for the COM property "ProjectConnected"
String serverName()
The name of the connected Open Test Architecture API server.
Getter method for the COM property "ServerName"
String projectName()
The name of the connected project.
Getter method for the COM property "ProjectName"
String testRepository()
The path of the tests directory of the connected project.
Getter method for the COM property "TestRepository"
String userName()
The user connected to the project.
Getter method for the COM property "UserName"
com4j.Com4jObject testFactory()
The Test Factory object for this connection.
Getter method for the COM property "TestFactory"
com4j.Com4jObject bugFactory()
The Bug Factory object for this connection.
Getter method for the COM property "BugFactory"
com4j.Com4jObject testSetFactory()
The Test Set Factory object for this connection.
Getter method for the COM property "TestSetFactory"
IList userGroupsList()
The names of the user groups of the currently connected project.
Getter method for the COM property "UserGroupsList"
Object userGroupsList(int index)
com4j.Com4jObject hostFactory()
The Hosts Factory object for this connection.
Getter method for the COM property "HostFactory"
com4j.Com4jObject vcs()
The Version Control System (VCS) object for this connection.
Getter method for the COM property "VCS"
void initConnection(String serverName, @DefaultValue(value="") String domainName, @DefaultValue(value="") String domainPswd)
For HP use. Initializes the Open Test Architecture API server connection for specified domain.
serverName
- Mandatory java.lang.String parameter.domainName
- Optional parameter. Default value is ""domainPswd
- Optional parameter. Default value is ""void releaseConnection()
ReleaseConnection must be called for each call of an initialization method after finishing work with the Open Test Architecture API.
void connectProject(String projectName, String userName, @DefaultValue(value="") String password)
Connects to the specified project.
projectName
- Mandatory java.lang.String parameter.userName
- Mandatory java.lang.String parameter.password
- Optional parameter. Default value is ""void disconnectProject()
Disconnects from the project.
IList projectsList()
The projects that are available in the domain to which Quality Center is connected.
Getter method for the COM property "ProjectsList"
Object projectsList(int index)
com4j.Com4jObject command()
The Command object for this connection.
Getter method for the COM property "Command"
com4j.Com4jObject treeManager()
The TreeManager object for the system tree.
Getter method for the COM property "TreeManager"
com4j.Com4jObject reqFactory()
The ReqFactory object for this connection.
Getter method for the COM property "ReqFactory"
com4j.Com4jObject actionPermission()
The ActionPermission object for this connection.
Getter method for the COM property "ActionPermission"
void getLicense(int licenseType)
For HP use. Allocates a license type according to the LicenseType parameter
licenseType
- Mandatory int parameter.void sendMail(String sendTo, @DefaultValue(value="") String sendFrom, @DefaultValue(value="") String subject, @DefaultValue(value="") String message, Object attachArray, @DefaultValue(value="") String bsFormat)
Sends Mail.
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 ""String dbType()
The database type.
Getter method for the COM property "DBType"
com4j.Com4jObject dbManager()
For HP use. The project DBManager object for this connection.
Getter method for the COM property "DBManager"
com4j.Com4jObject customization()
The Customization object for this connection.
Getter method for the COM property "Customization"
IList fields(String dataType)
A list of fields for the table specified in the DataType argument.
Getter method for the COM property "Fields"
dataType
- Mandatory java.lang.String parameter.com4j.Com4jObject commonSettings()
The Settings object for all users in this connection.
Getter method for the COM property "CommonSettings"
com4j.Com4jObject userSettings()
The Settings object for the logged-on user.
Getter method for the COM property "UserSettings"
com4j.Com4jObject hostGroupFactory()
The HostGroupFactory object for this connection.
Getter method for the COM property "HostGroupFactory"
void changePassword(String oldPassword, String newPassword)
Changes the password for the currently logged in user.
oldPassword
- Mandatory java.lang.String parameter.newPassword
- Mandatory java.lang.String parameter.IList usersList()
The names of the users of the currently connected project.
Getter method for the COM property "UsersList"
Object usersList(int index)
String password()
For HP use. The password for the logged in user.
Getter method for the COM property "Password"
com4j.Com4jObject extendedStorage()
Deprecated. Use the entity-level extended storage property.
Getter method for the COM property "ExtendedStorage"
String directoryPath(int nType)
The path of the server side repository directory for the database repository type.
Getter method for the COM property "DirectoryPath"
nType
- Mandatory int parameter.com4j.Com4jObject changeFactory()
For HP use. The ChangeFactory object for this connection.
Getter method for the COM property "ChangeFactory"
com4j.Com4jObject mailConditions()
The TDMailConditions object for this connection.
Getter method for the COM property "MailConditions"
Date serverTime()
The time and date of the application server.
Getter method for the COM property "ServerTime"
com4j.Com4jObject tdSettings()
For future use. An ITDSettings reference.
Getter method for the COM property "TDSettings"
void purgeRuns(String testSetFilter, int keepLast, Object dateUnit, int unitCount, boolean stepsOnly)
Deletes the runs in this connection that match the input arguments.
testSetFilter
- Mandatory java.lang.String parameter.keepLast
- Mandatory int parameter.dateUnit
- Mandatory java.lang.Object parameter.unitCount
- Mandatory int parameter.stepsOnly
- Mandatory boolean parameter.com4j.Com4jObject projectProperties()
The ProjectProperties object for this connection.
Getter method for the COM property "ProjectProperties"
void getLicenseStatus(int clientType, com4j.Holder<Integer> inUse, com4j.Holder<Integer> max)
The license status for the specified client type.
clientType
- Mandatory int parameter.inUse
- Mandatory Holdermax
- Mandatory HolderString domainName()
The current domain.
Getter method for the COM property "DomainName"
com4j.Com4jObject textParam()
The TextParser object.
Getter method for the COM property "TextParam"
String tdParams(String request)
Gets the value of the parameter whose name is specified by Request.
Getter method for the COM property "TDParams"
request
- Mandatory java.lang.String parameter.boolean usingProgress()
Indicates if a progress bar is displayed.
Getter method for the COM property "UsingProgress"
void usingProgress(boolean pVal)
Indicates if a progress bar is displayed.
Setter method for the COM property "UsingProgress"
pVal
- Mandatory boolean parameter.String checkoutRepository()
The path of the checkout repository.
Getter method for the COM property "CheckoutRepository"
String viewsRepository()
Obsolete. Property ViewsRepository.
Getter method for the COM property "ViewsRepository"
String vcsDbRepository()
The path of the VCS database of the connected project.
Getter method for the COM property "VcsDbRepository"
com4j.Com4jObject runFactory()
The RunFactory object for this connection.
Getter method for the COM property "RunFactory"
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"
moduleID
- Mandatory int parameter.void initConnectionEx(String serverName)
Initializes the connection.
serverName
- Mandatory java.lang.String parameter.IList projectsListEx(String domainName)
The projects available within the specified domain.
Getter method for the COM property "ProjectsListEx"
domainName
- Mandatory java.lang.String parameter.void connectProjectEx(String domainName, String projectName, String userName, @DefaultValue(value="") String password)
Connects to the specified project in the specified domain.
domainName
- Mandatory java.lang.String parameter.projectName
- Mandatory java.lang.String parameter.userName
- Mandatory java.lang.String parameter.password
- Optional parameter. Default value is ""IList domainsList()
The domain names for this site.
Getter method for the COM property "DomainsList"
Object domainsList(int index)
void connectToVCSAs(String userName, String password, String copyDesStep)
Obsolete. Method ConnectToVCSAs.
userName
- Mandatory java.lang.String parameter.password
- Mandatory java.lang.String parameter.copyDesStep
- Mandatory java.lang.String parameter.void getLicenses(int licensesType, com4j.Holder<String> pVal)
Allocates multiple licenses types according to the LicensesType parameter.
licensesType
- Mandatory int parameter.pVal
- Mandatory Holdercom4j.Com4jObject analysis()
For HP use. Property Analysis.
Getter method for the COM property "Analysis"
String vmRepository()
Obsolete. Property VMRepository.
Getter method for the COM property "VMRepository"
String dbName()
The name of the database.
Getter method for the COM property "DBName"
com4j.Com4jObject rules()
The RuleManager object for this connection.
Getter method for the COM property "Rules"
com4j.Com4jObject testSetTreeManager()
The TestSetTreeManager object for this connection.
Getter method for the COM property "TestSetTreeManager"
com4j.Com4jObject alertManager()
The AlertManager object for this connection.
Getter method for the COM property "AlertManager"
boolean allowReconnect()
For HP use. Allows repeat call to InitConnection,ReleaseConnection, ConnectProject and DisconnectProject.
Getter method for the COM property "AllowReconnect"
void allowReconnect(boolean pVal)
For HP use. Allows repeat call to InitConnection,ReleaseConnection, ConnectProject and DisconnectProject.
Setter method for the COM property "AllowReconnect"
pVal
- Mandatory boolean parameter.void synchronizeFollowUps(String password)
Obsolete: Sends all previously unsent followups.
password
- Mandatory java.lang.String parameter.boolean keepConnection()
For HP use. Prevents automatic disconnect by server on timeout.
Getter method for the COM property "KeepConnection"
void keepConnection(boolean pVal)
For HP use. Prevents automatic disconnect by server on timeout.
Setter method for the COM property "KeepConnection"
pVal
- Mandatory boolean parameter.boolean ignoreHtmlFormat()
Indicates if formatted memo and description fields are returned as plain text without HTML tags.
Getter method for the COM property "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"
pVal
- Mandatory boolean parameter.String reportRole()
The report role of the connected user.
Getter method for the COM property "ReportRole"
void clientType(String newVal, @DefaultValue(value="") String rhs)
For HP use. Sets the Client type.
Setter method for the COM property "ClientType"
newVal
- Mandatory java.lang.String parameter.rhs
- Optional parameter. Default value is ""com4j.Com4jObject componentFactory()
For HP use. The Component Factory object for this connection.
Getter method for the COM property "ComponentFactory"
com4j.Com4jObject componentFolderFactory()
For HP use. The Component Folder Factory object for this connection.
Getter method for the COM property "ComponentFolderFactory"
void getTDVersion(com4j.Holder<String> pbsMajorVersion, com4j.Holder<String> pbsBuildNum)
The major and minor versions of the OTA API.
pbsMajorVersion
- Mandatory HolderpbsBuildNum
- Mandatory HolderString serverURL()
The URL of the connected server.
Getter method for the COM property "ServerURL"
Copyright © 2020. All rights reserved.