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 anExecutionConfiguration
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-2022 Piketec GmbH - MIT License (MIT) - All rights reserved
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ResultAndLogs<ExecutionConfigurationOrGroup>
copy(ExecutionConfigurationOwner targetGroup, int targetIndex)
Copiesthis
into the giventargetGroup
that can be from a differentProject
that is opened in the same TPT instance.ExecutionConfigurationGroup
getGroup()
Get the parent execution configuration group ornull
if this object resides on the top level (meaning directly below theProject
).boolean
isGroup()
void
move(ExecutionConfigurationGroup newParent, int index)
Moves thisExecutionConfigurationOrGroup
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 ornull
if this object resides on the top level (meaning directly below theProject
).- Returns:
- the parent group or
null
- Throws:
java.rmi.RemoteException
- remote communication problem
-
isGroup
boolean isGroup() throws java.rmi.RemoteException
- Returns:
true
if this is aExecutionConfigurationGroup
,false
otherwise.- Throws:
java.rmi.RemoteException
- remote communication problem
-
move
void move(ExecutionConfigurationGroup newParent, int index) throws ApiException, java.rmi.RemoteException
Moves thisExecutionConfigurationOrGroup
to a new position in the execution configuration tree.- Parameters:
newParent
- the new parent node ornull
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
Copiesthis
into the giventargetGroup
that can be from a differentProject
that is opened in the same TPT instance. If thetargetGroup
already contains an element with the same name a new one will be generated.- Parameters:
targetGroup
- The group to copythis
into. Can be from anotherProject
.targetIndex
- The index where the copy will be inserted. UseInteger.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 isnull
or copying failed.java.rmi.RemoteException
- remote communication problem
-
-