step.repository.alm.otaclient

Interface ITDConnection4

All Superinterfaces:

com4j.Com4jObject, ITDConnection, ITDConnection2, ITDConnection3

public interface ITDConnection4
extends ITDConnection3

Represents a single server connection.

Method Summary

Modifier and Type	Method and Description
com4j.Com4jObject	analysisItemFactory() For HP use.
com4j.Com4jObject	analysisItemFolderFactory() For HP use.
com4j.Com4jObject	assetRelationFactory() The AssetsRelationFactory object for this connection.
com4j.Com4jObject	assetRepositoryItemFactory() The AssetRepositoryItemFactory object for this connection.
com4j.Com4jObject	baselineFactory() For HP use.
void	clientVersion(String newVal, String rhs) For HP use.
com4j.Com4jObject	comparisonFactory() For HP use.
com4j.Com4jObject	comparisonNodeFactory() For HP use.
com4j.Com4jObject	crossProjectAPI() For HP use.
com4j.Com4jObject	dashboardFolderFactory() For HP use.
com4j.Com4jObject	dashboardPageFactory() For HP use.
com4j.Com4jObject	dashboardPageItemFactory() For HP use.
com4j.Com4jObject	excelReportManager() For HP use.
IList	getAllVisibleProjectDescriptors() The list of project descriptors under all domains that the current logged in user is allowed to connect to.
Object	getAllVisibleProjectDescriptors(int index)
com4j.Com4jObject	getFavoriteFactory(boolean isPublic, String module) The factory that manages favorites for a specific module and public state.
com4j.Com4jObject	getFavoriteFolderFactory(boolean isPublic, String module) The factory that manages favorite folders for the specific module and public state.
com4j.Com4jObject	getRootsFavoriteFactory(boolean isPublic, String module) The factory that manages the root favorites for the specific module and public state.
com4j.Com4jObject	getRootsFavoriteFolderFactory(boolean isPublic, String module) The factory that manages the root favorite folders for the specific module and public state.
com4j.Com4jObject	libraryFactory() For HP use.
com4j.Com4jObject	libraryFolderFactory() For HP use.
com4j.Com4jObject	licenseManager() For HP use.
com4j.Com4jObject	policyStatus() The Policy Enforcement Status object of the connected project.
com4j.Com4jObject	qcResourceFactory() The QC resource factory object for this connection.
com4j.Com4jObject	qcResourceFolderFactory() The QC resource folder factory object for this connection.
void	refreshConnectionState() Refreshes the connection state: updates the Connected, LoggedIn, and ProjectConnected properties.
com4j.Com4jObject	rootsAnalysisItemFactory() For HP use.
com4j.Com4jObject	rootsAnalysisItemFolderFactory() For HP use.
com4j.Com4jObject	rootsDashboardFolderFactory() For HP use.
com4j.Com4jObject	rootsDashboardPageFactory() For HP use.
void	sendFramedMail(String sendTo, String sendFrom, String subject, String message, Object attachArray) Takes a simple text message and sends it as an HTML Mail using the Quality Center format.
com4j.Com4jObject	taskFactory() The TaskFactory object for this connection.
com4j.Com4jObject	taskLogFactory() The TaskLogFactory object for this connection.
com4j.Com4jObject	templateManager() The Template Manager object of the connected project.
com4j.Com4jObject	userAssetFactory() The UserAssetFactory object for this connection.

Methods inherited from interface step.repository.alm.otaclient.ITDConnection3

applicationConfigurationFactory, applicationEntityFactory, applicationEntityTreeManager, blueprintFactory, changeEntityFactory, changeEntityTreeManager, cycleFactory, extensionFactory, extensionsManager, getExtensions, getNonce, getTDParamsNames, getTDParamsNames, releaseFactory, releaseFolderFactory, serviceChangeFactory, serviceFactory, serviceFolderFactory, serviceGroupFactory, validate

Methods inherited from interface step.repository.alm.otaclient.ITDConnection2

auditPropertyFactory, auditRecordFactory, connect, disconnect, graphBuilder, isSearchSupported, loggedIn, login, logout, productInfo, tsTestFactory, visibleDomains, visibleDomains, visibleProjects

Methods inherited from interface step.repository.alm.otaclient.ITDConnection

actionPermission, alertManager, allowReconnect, allowReconnect, analysis, bugFactory, changeFactory, changePassword, checkoutRepository, clientType, command, commonSettings, componentFactory, componentFolderFactory, connected, connectProject, connectProjectEx, connectToVCSAs, customization, dbManager, dbName, dbType, directoryPath, disconnectProject, domainName, domainsList, domainsList, extendedStorage, fields, getLicense, getLicenses, getLicenseStatus, getTDVersion, hostFactory, hostGroupFactory, ignoreHtmlFormat, ignoreHtmlFormat, initConnection, initConnectionEx, keepConnection, keepConnection, mailConditions, moduleVisible, password, projectConnected, projectName, projectProperties, projectsList, projectsList, projectsListEx, purgeRuns, releaseConnection, reportRole, reqFactory, rules, runFactory, sendMail, serverName, serverTime, serverURL, synchronizeFollowUps, tdParams, tdSettings, testFactory, testRepository, testSetFactory, testSetTreeManager, textParam, treeManager, userGroupsList, userGroupsList, userName, userSettings, usersList, usersList, usingProgress, usingProgress, vcs, vcsDbRepository, viewsRepository, vmRepository

Methods inherited from interface com4j.Com4jObject

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

Method Detail

getFavoriteFolderFactory

com4j.Com4jObject getFavoriteFolderFactory(boolean isPublic,
                                           String module)

The factory that manages favorite folders for the specific module and public state.

Parameters:

isPublic - Mandatory boolean parameter.

module - Mandatory java.lang.String parameter.

Returns:

Returns a value of type com4j.Com4jObject

getFavoriteFactory

com4j.Com4jObject getFavoriteFactory(boolean isPublic,
                                     String module)

The factory that manages favorites for a specific module and public state.

Parameters:

isPublic - Mandatory boolean parameter.

module - Mandatory java.lang.String parameter.

Returns:

Returns a value of type com4j.Com4jObject

getRootsFavoriteFolderFactory

com4j.Com4jObject getRootsFavoriteFolderFactory(boolean isPublic,
                                                String module)

The factory that manages the root favorite folders for the specific module and public state.

Parameters:

isPublic - Mandatory boolean parameter.

module - Mandatory java.lang.String parameter.

Returns:

Returns a value of type com4j.Com4jObject

getRootsFavoriteFactory

com4j.Com4jObject getRootsFavoriteFactory(boolean isPublic,
                                          String module)

The factory that manages the root favorites for the specific module and public state.

Parameters:

isPublic - Mandatory boolean parameter.

module - Mandatory java.lang.String parameter.

Returns:

Returns a value of type com4j.Com4jObject

libraryFolderFactory

com4j.Com4jObject libraryFolderFactory()

For HP use. The factory that manages library folders.

Getter method for the COM property "LibraryFolderFactory"

Returns:

Returns a value of type com4j.Com4jObject

libraryFactory

com4j.Com4jObject libraryFactory()

For HP use. The factory that manages libraries.

Getter method for the COM property "LibraryFactory"

Returns:

Returns a value of type com4j.Com4jObject

baselineFactory

com4j.Com4jObject baselineFactory()

For HP use. The factory that manages baselines.

Getter method for the COM property "BaselineFactory"

Returns:

Returns a value of type com4j.Com4jObject

policyStatus

com4j.Com4jObject policyStatus()

The Policy Enforcement Status object of the connected project.

Getter method for the COM property "PolicyStatus"

Returns:

Returns a value of type com4j.Com4jObject

templateManager

com4j.Com4jObject templateManager()

The Template Manager object of the connected project.

Getter method for the COM property "TemplateManager"

Returns:

Returns a value of type com4j.Com4jObject

analysisItemFolderFactory

com4j.Com4jObject analysisItemFolderFactory()

For HP use. Gets the factory that manages analysis item folders.

Getter method for the COM property "AnalysisItemFolderFactory"

Returns:

Returns a value of type com4j.Com4jObject

analysisItemFactory

com4j.Com4jObject analysisItemFactory()

For HP use. The factory that manages analysis items.

Getter method for the COM property "AnalysisItemFactory"

Returns:

Returns a value of type com4j.Com4jObject

rootsAnalysisItemFolderFactory

com4j.Com4jObject rootsAnalysisItemFolderFactory()

For HP use. The factory that manages the root analysis item folders.

Getter method for the COM property "RootsAnalysisItemFolderFactory"

Returns:

Returns a value of type com4j.Com4jObject

rootsAnalysisItemFactory

com4j.Com4jObject rootsAnalysisItemFactory()

For HP use. The factory that manages the root analysis items.

Getter method for the COM property "RootsAnalysisItemFactory"

Returns:

Returns a value of type com4j.Com4jObject

qcResourceFactory

com4j.Com4jObject qcResourceFactory()

The QC resource factory object for this connection.

Getter method for the COM property "QCResourceFactory"

Returns:

Returns a value of type com4j.Com4jObject

qcResourceFolderFactory

com4j.Com4jObject qcResourceFolderFactory()

The QC resource folder factory object for this connection.

Getter method for the COM property "QCResourceFolderFactory"

Returns:

Returns a value of type com4j.Com4jObject

dashboardFolderFactory

com4j.Com4jObject dashboardFolderFactory()

For HP use. The factory that manages dashboard folders.

Getter method for the COM property "DashboardFolderFactory"

Returns:

Returns a value of type com4j.Com4jObject

dashboardPageFactory

com4j.Com4jObject dashboardPageFactory()

For HP use. The factory that manages dashboard pages.

Getter method for the COM property "DashboardPageFactory"

Returns:

Returns a value of type com4j.Com4jObject

rootsDashboardFolderFactory

com4j.Com4jObject rootsDashboardFolderFactory()

For HP use. The factory that manages the root dashboard folders.

Getter method for the COM property "RootsDashboardFolderFactory"

Returns:

Returns a value of type com4j.Com4jObject

rootsDashboardPageFactory

com4j.Com4jObject rootsDashboardPageFactory()

For HP use. The factory that manages the root dashboard pages.

Getter method for the COM property "RootsDashboardPageFactory"

Returns:

Returns a value of type com4j.Com4jObject

comparisonFactory

com4j.Com4jObject comparisonFactory()

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

Getter method for the COM property "ComparisonFactory"

Returns:

Returns a value of type com4j.Com4jObject

comparisonNodeFactory

com4j.Com4jObject comparisonNodeFactory()

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

Getter method for the COM property "ComparisonNodeFactory"

Returns:

Returns a value of type com4j.Com4jObject

assetRelationFactory

com4j.Com4jObject assetRelationFactory()

The AssetsRelationFactory object for this connection.

Getter method for the COM property "AssetRelationFactory"

Returns:

Returns a value of type com4j.Com4jObject

userAssetFactory

com4j.Com4jObject userAssetFactory()

The UserAssetFactory object for this connection.

Getter method for the COM property "UserAssetFactory"

Returns:

Returns a value of type com4j.Com4jObject

assetRepositoryItemFactory

com4j.Com4jObject assetRepositoryItemFactory()

The AssetRepositoryItemFactory object for this connection.

Getter method for the COM property "AssetRepositoryItemFactory"

Returns:

Returns a value of type com4j.Com4jObject

crossProjectAPI

com4j.Com4jObject crossProjectAPI()

For HP use. Returns an instance of CrossProjectAPI for this connection.

Getter method for the COM property "CrossProjectAPI"

Returns:

Returns a value of type com4j.Com4jObject

taskFactory

com4j.Com4jObject taskFactory()

The TaskFactory object for this connection.

Getter method for the COM property "TaskFactory"

Returns:

Returns a value of type com4j.Com4jObject

taskLogFactory

com4j.Com4jObject taskLogFactory()

The TaskLogFactory object for this connection.

Getter method for the COM property "TaskLogFactory"

Returns:

Returns a value of type com4j.Com4jObject

sendFramedMail

void sendFramedMail(String sendTo,
                    @DefaultValue(value="")
                    String sendFrom,
                    @DefaultValue(value="")
                    String subject,
                    @DefaultValue(value="")
                    String message,
                    Object attachArray)

Takes a simple text message and sends it as an HTML Mail using the Quality Center format.

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

licenseManager

com4j.Com4jObject licenseManager()

For HP use. The License Manager object.

Getter method for the COM property "LicenseManager"

Returns:

Returns a value of type com4j.Com4jObject

dashboardPageItemFactory

com4j.Com4jObject dashboardPageItemFactory()

For HP use. The dashboard page item factory.

Getter method for the COM property "DashboardPageItemFactory"

Returns:

Returns a value of type com4j.Com4jObject

getAllVisibleProjectDescriptors

IList getAllVisibleProjectDescriptors()

The list of project descriptors under all domains that the current logged in user is allowed to connect to.

Returns:

Returns a value of type otaclient.IList

getAllVisibleProjectDescriptors

Object getAllVisibleProjectDescriptors(int index)

refreshConnectionState

void refreshConnectionState()

Refreshes the connection state: updates the Connected, LoggedIn, and ProjectConnected properties.

excelReportManager

com4j.Com4jObject excelReportManager()

For HP use. Excel Report Manager.

Getter method for the COM property "ExcelReportManager"

Returns:

Returns a value of type com4j.Com4jObject

clientVersion

void clientVersion(String newVal,
                   @DefaultValue(value="")
                   String rhs)

For HP use. Sets the Client type version.

Setter method for the COM property "ClientVersion"

Parameters:

newVal - Mandatory java.lang.String parameter.

rhs - Optional parameter. Default value is ""