step.repository.alm.otaclient

Interface IBusinessProcess

All Superinterfaces:

com4j.Com4jObject, IBaseField, IBaseFieldEx, IBaseFieldExMail, IObjectLockingSupport, ITest

All Known Subinterfaces:

IBusinessProcess2, IBusinessProcess3

public interface IBusinessProcess
extends ITest

Represents a single Business Process Test.

Method Summary

Modifier and Type	Method and Description
com4j.Com4jObject	addBPComponent(com4j.Com4jObject pComponent) Adds the specified Component to the test.
com4j.Com4jObject	addGroup() Adds an empty group of components to the test.
com4j.Com4jObject	addRTParam() Adds a runtime parameter to the test.
com4j.Com4jObject	bpComponentByID(int nCompID) Gets a BPComponent from the test by its ID.
IList	bpComponents() The list of BPComponents that belong to the test.
Object	bpComponents(int index)
com4j.Com4jObject	bptHistory() The test's history object.
void	cancelDownloadPictures() Cancels the download of the test component's pictures.
void	deleteBPComponent(com4j.Com4jObject pBPComponent) Delete the specified BPComponent from the test.
void	deleteGroup(com4j.Com4jObject pBPGroup) Delete the specified BPGroup from the test.
void	deleteRTParam(com4j.Com4jObject pRTParam) Delete the given RTParam from the test.
void	downloadPictures() Download the snapshots attached to the components of the test to the clients cache.
void	downloadPicturesProgress(com4j.Holder<Integer> total, com4j.Holder<Integer> current) Reports the status of DownloadPictures.
com4j.Com4jObject	groupByID(int nGroupID) Gets a BPGroup from the test by its ID.
String	htmlScript() Not implemented.
void	load() Loads the BusinessProcess object and all of its dependencies into memory.
IList	rtParameters() The list of run time parameters for the test.
Object	rtParameters(int index)
void	save() Saves the BusinessProcess object and all of its dependencies.

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

checkoutPathIfExist, coverRequirement, designStepFactory, desStepsNum, execDate, execStatus, extendedStorage, fullPath, fullPathEx, getCoverList, getCoverList, hasCoverage, hasParam, ignoreDataHiding, ignoreDataHiding, lastRun, name, name, params, removeCoverage, templateTest, templateTest, type, type, vcs

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

mail

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

attachments, hasAttachment, history

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

autoPost, autoPost, field, field, id, modified, post, refresh, undo, virtual

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

isLocked, lockObject, unLockObject

Methods inherited from interface com4j.Com4jObject

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

Method Detail

load

void load()

Loads the BusinessProcess object and all of its dependencies into memory.

save

void save()

Saves the BusinessProcess object and all of its dependencies.

rtParameters

IList rtParameters()

The list of run time parameters for the test.

Getter method for the COM property "RTParameters"

Returns:

Returns a value of type otaclient.IList

rtParameters

Object rtParameters(int index)

addRTParam

com4j.Com4jObject addRTParam()

Adds a runtime parameter to the test.

Returns:

Returns a value of type com4j.Com4jObject

deleteRTParam

void deleteRTParam(com4j.Com4jObject pRTParam)

Delete the given RTParam from the test.

Parameters:

pRTParam - Mandatory com4j.Com4jObject parameter.

bpComponents

IList bpComponents()

The list of BPComponents that belong to the test.

Getter method for the COM property "BPComponents"

Returns:

Returns a value of type otaclient.IList

bpComponents

Object bpComponents(int index)

addBPComponent

com4j.Com4jObject addBPComponent(com4j.Com4jObject pComponent)

Adds the specified Component to the test.

Parameters:

pComponent - Mandatory com4j.Com4jObject parameter.

Returns:

Returns a value of type com4j.Com4jObject

deleteBPComponent

void deleteBPComponent(com4j.Com4jObject pBPComponent)

Delete the specified BPComponent from the test.

Parameters:

pBPComponent - Mandatory com4j.Com4jObject parameter.

addGroup

com4j.Com4jObject addGroup()

Adds an empty group of components to the test.

Returns:

Returns a value of type com4j.Com4jObject

deleteGroup

void deleteGroup(com4j.Com4jObject pBPGroup)

Delete the specified BPGroup from the test.

Parameters:

pBPGroup - Mandatory com4j.Com4jObject parameter.

groupByID

com4j.Com4jObject groupByID(int nGroupID)

Gets a BPGroup from the test by its ID.

Getter method for the COM property "GroupByID"

Parameters:

nGroupID - Mandatory int parameter.

Returns:

Returns a value of type com4j.Com4jObject

downloadPictures

void downloadPictures()

Download the snapshots attached to the components of the test to the clients cache.

downloadPicturesProgress

void downloadPicturesProgress(com4j.Holder<Integer> total,
                              com4j.Holder<Integer> current)

Reports the status of DownloadPictures.

Parameters:

total - Mandatory Holder parameter.

current - Mandatory Holder parameter.

cancelDownloadPictures

void cancelDownloadPictures()

Cancels the download of the test component's pictures.

htmlScript

String htmlScript()

Not implemented.

Getter method for the COM property "HtmlScript"

Returns:

Returns a value of type java.lang.String

bptHistory

com4j.Com4jObject bptHistory()

The test's history object.

Getter method for the COM property "BPTHistory"

Returns:

Returns a value of type com4j.Com4jObject

bpComponentByID

com4j.Com4jObject bpComponentByID(int nCompID)

Gets a BPComponent from the test by its ID.

Getter method for the COM property "BPComponentByID"

Parameters:

nCompID - Mandatory int parameter.

Returns:

Returns a value of type com4j.Com4jObject