step.repository.alm.otaclient

Interface ITestSetFolder

All Superinterfaces:

com4j.Com4jObject, ISysTreeNode

All Known Subinterfaces:

ITestSetFolder2, ITestSetFolder3, ITestSetFolder4

public interface ITestSetFolder
extends ISysTreeNode

Manages the tests and test sets included in one test set folder.

Method Summary

Modifier and Type	Method and Description
com4j.Com4jObject	addNodeDisp(String nodeName) Adds a new child node.
com4j.Com4jObject	attachments() The folder's AttachmentFactory object.
String	description() The test set folder description.
void	description(String pVal) The test set folder description.
com4j.Com4jObject	fatherDisp() The parent node.
int	fatherID() The unique parent ID.
IList	findTestSets(String pattern, boolean matchCase, String filter) Gets the list of test sets contained in the folder that match the specified pattern.
boolean	hasAttachment() Checks if this folder has at least one attachment.
void	move(Object father) Moves folder node under new father.
void	removeNodeEx(Object node, boolean deleteTestSets) Deletes a test set folder node.
IList	subNodes() The list of child nodes.
Object	subNodes(int index)
com4j.Com4jObject	testSetFactory() Gets the TestSetFactory for the folder.
int	viewOrder() The index of this folder in its parent's list of sub-nodes.
void	viewOrder(int pVal) The index of this folder in its parent's list of sub-nodes.

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

addNode, attribute, child, count, depthType, father, findChildNode, findChildren, name, name, newList, newList, nodeID, path, post, refresh, removeNode

Methods inherited from interface com4j.Com4jObject

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

Method Detail

description

String description()

The test set folder description.

Getter method for the COM property "Description"

Returns:

Returns a value of type java.lang.String

description

void description(String pVal)

The test set folder description.

Setter method for the COM property "Description"

Parameters:

pVal - Mandatory java.lang.String parameter.

fatherID

int fatherID()

The unique parent ID.

Getter method for the COM property "FatherID"

Returns:

Returns a value of type int

fatherDisp

com4j.Com4jObject fatherDisp()

The parent node.

Getter method for the COM property "FatherDisp"

Returns:

Returns a value of type com4j.Com4jObject

viewOrder

int viewOrder()

The index of this folder in its parent's list of sub-nodes.

Getter method for the COM property "ViewOrder"

Returns:

Returns a value of type int

viewOrder

void viewOrder(int pVal)

The index of this folder in its parent's list of sub-nodes.

Setter method for the COM property "ViewOrder"

Parameters:

pVal - Mandatory int parameter.

subNodes

IList subNodes()

The list of child nodes.

Getter method for the COM property "SubNodes"

Returns:

Returns a value of type otaclient.IList

subNodes

Object subNodes(int index)

addNodeDisp

com4j.Com4jObject addNodeDisp(String nodeName)

Adds a new child node.

Parameters:

nodeName - Mandatory java.lang.String parameter.

Returns:

Returns a value of type com4j.Com4jObject

removeNodeEx

void removeNodeEx(Object node,
                  @DefaultValue(value="0")
                  boolean deleteTestSets)

Deletes a test set folder node.

Parameters:

node - Mandatory java.lang.Object parameter.

deleteTestSets - Optional parameter. Default value is false

move

void move(Object father)

Moves folder node under new father.

Parameters:

father - Mandatory java.lang.Object parameter.

testSetFactory

com4j.Com4jObject testSetFactory()

Gets the TestSetFactory for the folder.

Getter method for the COM property "TestSetFactory"

Returns:

Returns a value of type com4j.Com4jObject

hasAttachment

boolean hasAttachment()

Checks if this folder has at least one attachment.

Getter method for the COM property "HasAttachment"

Returns:

Returns a value of type boolean

attachments

com4j.Com4jObject attachments()

The folder's AttachmentFactory object.

Getter method for the COM property "Attachments"

Returns:

Returns a value of type com4j.Com4jObject

findTestSets

IList findTestSets(String pattern,
                   @DefaultValue(value="0")
                   boolean matchCase,
                   @DefaultValue(value="")
                   String filter)

Gets the list of test sets contained in the folder that match the specified pattern.

Parameters:

pattern - Mandatory java.lang.String parameter.

matchCase - Optional parameter. Default value is false

filter - Optional parameter. Default value is ""

Returns:

Returns a value of type otaclient.IList