Package com.piketec.tpt.api

Interface ExecutionConfigurationOrGroup

All Superinterfaces:

IdentifiableRemote, NamedObject, java.rmi.Remote, TptRemote

All Known Subinterfaces:

ExecutionConfiguration, ExecutionConfigurationGroup

public interface ExecutionConfigurationOrGroup
extends NamedObject, IdentifiableRemote

An object representing either an ExecutionConfiguration or a group of execution configurations (ExecutionConfigurationGroup). These objects can build up a tree where both, execution configurations and execution configuration groups, could be leaf nodes.

Author:

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

Method Summary

Modifier and Type	Method	Description
ResultAndLogs<ExecutionConfigurationOrGroup>	copy(ExecutionConfigurationOwner targetGroup, int targetIndex)	Copies this into the given targetGroup that can be from a different Project that is opened in the same TPT instance.
ExecutionConfigurationGroup	getGroup()	Get the parent execution configuration group or null if this object resides on the top level (meaning directly below the Project).
void	move(ExecutionConfigurationGroup newParent, int index)	Moves this ExecutionConfigurationOrGroup to a new position in the execution configuration tree.

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

getIdentifier

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

getName, setName

Method Detail

getGroup

ExecutionConfigurationGroup getGroup()
                              throws java.rmi.RemoteException

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

Returns:

the parent group or null

Throws:

java.rmi.RemoteException - remote communication problem

move

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

Moves this ExecutionConfigurationOrGroup to a new position in the execution configuration tree.

Parameters:

newParent - the new parent node 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<ExecutionConfigurationOrGroup> copy(ExecutionConfigurationOwner 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 occurred during copying.

Throws:

ApiException - If targetGroup is null or copying failed.

java.rmi.RemoteException - remote communication problem