Package com.piketec.tpt.api

Interface TestSetOrGroup

All Superinterfaces:

IdentifiableRemote, NamedObject, java.rmi.Remote, TptRemote, UUIDObject

All Known Subinterfaces:

TestSet, TestSetGroup

public interface TestSetOrGroup
extends IdentifiableRemote, NamedObject, UUIDObject

An object representing either a TestSet or a group of test sets (TestSetGroup). These objects can build up a tree where both, test sets and test set groups, could be leaf nodes.

Author:

Copyright (c) 2014-2024 Piketec GmbH - MIT License (MIT) - All rights reserved

Method Summary

Modifier and Type	Method	Description
ResultAndLogs<TestSetOrGroup>	copy(TestSetOwner targetGroup, int targetIndex)	Copies this into the given targetGroup that can be from a different Project that is opened in the same TPT instance.
TestSetGroup	getGroup()	Get the parent test set group or null if this object resides on the top level (meaning directly below the Project).
boolean	isGroup()	Returns true if this is a TestSetGroup, false otherwise.
void	move(TestSetGroup newParent, int index)	Moves this TestSetOrGroup to a new position in the test set tree.

Methods inherited from interface com.piketec.tpt.api.IdentifiableRemote

getIdentifier

Methods inherited from interface com.piketec.tpt.api.NamedObject

getName, setName

Methods inherited from interface com.piketec.tpt.api.util.UUIDObject

getUUID

Method Detail

getGroup

TestSetGroup getGroup()
               throws java.rmi.RemoteException

Get the parent test set group or null if this object resides on the top level (meaning directly below the Project).

Returns:

parent test set group or null

Throws:

java.rmi.RemoteException - remote communication problem

isGroup

boolean isGroup()
         throws java.rmi.RemoteException

Returns true if this is a TestSetGroup, false otherwise.

Returns:

true if this is a TestSetGroup, false otherwise

Throws:

java.rmi.RemoteException - remote communication problem

move

void move(TestSetGroup newParent,
          int index)
   throws ApiException,
          java.rmi.RemoteException

Moves this TestSetOrGroup to a new position in the test set tree.

Parameters:

newParent - the new parent TestSetGroup or null to move it to top level.

index - the new position under the new parent.

Throws:

ApiException - If the new parent is invalid.

java.rmi.RemoteException - remote communication problem

copy

ResultAndLogs<TestSetOrGroup> copy(TestSetOwner targetGroup,
                                   int targetIndex)
                            throws ApiException,
                                   java.rmi.RemoteException

Copies this into the given targetGroup that can be from a different Project that is opened in the same TPT instance. If the targetGroup already contains an element with the same name a new one will be generated.

Parameters:

targetGroup - The group to copy this into. Can be from another Project.

targetIndex - The index where the copy will be inserted. Use Integer.MAX_VALUE to append the copy at the end.

Returns:

The copy of this and all log messages that occured during copying.

Throws:

ApiException - If targetGroup is null or copying failed.

java.rmi.RemoteException - remote communication problem