Package com.piketec.tpt.api.diagram

Interface DiagramScenario

All Superinterfaces:

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

public interface DiagramScenario
extends Scenario

A DiagramScenario is a automaton. It specifies

• a path through the automaton given by a set of (active) Transitions
• a selected Variant (Scenario) for each Testlet in the path
• a selected TransitionSpec for each of the above Transitions

In TPT, it represents both the variants as well as the test cases. Create a new DiagramScenario via Testlet.createDiagVariant(String, ScenarioGroup)

See Also:

Testlet.createSLVariant(String, ScenarioGroup), Project.getTopLevelTestlet()

Method Summary

Modifier and Type	Method	Description
void	addTransitionToPath(Transition t)	Add a Transition to the list of selected Transitions for this DiagramScenario.
RemoteCollection<Transition>	getPath()
TransitionSpec	getSelectedTransitionSpec(Transition transition)	Get the currently selected transition specification for the given Transition or null.
Scenario	getSelectedVariant(Testlet state)	Get the Variant that is currently selected for a given state in this Variant or null.
void	setSelectedTransitionSpec(Transition transition, TransitionSpec transitionSpec)	Select a transition specification for the given Transition in the current Scenario.
void	setSelectedVariant(Testlet state, Scenario variant)	Set a given Variant for a given Testlet in the current Scenario.
StepListScenario	transformToStepList()	Transforms this DiagramScenario into an empty StepListScenario.

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.Scenario

checkForNewRevision, exportTestSpecification, getCompileError, getCurrentStatus, getLinkedRequirements, getStatusHistory, getTestDataDirectory, isStatusOutdated

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

copy, getDescription, getGroup, getId, getIdString, getInitialValue, getInitialValues, getTestCaseAttributeValue, getTestlet, isGroup, isTestcaseOrGroup, move, setDescription, setInitialValue, setStatus, setTestCaseAttributeValue

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

getUUID

Method Detail

getPath

RemoteCollection<Transition> getPath()
                              throws java.rmi.RemoteException

Returns:

The list of all selected Transitions for this variant.

Throws:

java.rmi.RemoteException - remote communication problem

addTransitionToPath

void addTransitionToPath(Transition t)
                  throws java.rmi.RemoteException

Add a Transition to the list of selected Transitions for this DiagramScenario. Conflicting Transitions are automatically removed from the list.

Parameters:

t - The Transition to add to the path in the scenario.

Throws:

java.rmi.RemoteException - If the given Transition object is not a RemoteObject or it does not originate from the TPT instance represented by this API object.

getSelectedVariant

Scenario getSelectedVariant(Testlet state)
                     throws java.rmi.RemoteException

Get the Variant that is currently selected for a given state in this Variant or null.

Parameters:

state - The State, for which the currently selected variant shall be examined.

Returns:

null if no Variant has been previously selected for this State in the current Scenario. The selected Variant otherwise.

Throws:

java.rmi.RemoteException - If the given State object is not a RemoteObject or it does not originate from the TPT instance represented by this API object.

setSelectedVariant

void setSelectedVariant(Testlet state,
                        Scenario variant)
                 throws java.rmi.RemoteException

Set a given Variant for a given Testlet in the current Scenario. If variant==null, the currently selected varant will be deleted.

Parameters:

state - Represents the State, for which a variant shall be set.

variant - A Variant to be set or null to reset the variant for this state.

Throws:

java.rmi.RemoteException - If the given state or variant objects are not a RemoteObject or they do not originate from the TPT instance represented by this API object.

getSelectedTransitionSpec

TransitionSpec getSelectedTransitionSpec(Transition transition)
                                  throws java.rmi.RemoteException

Get the currently selected transition specification for the given Transition or null.

Parameters:

transition - The Transition, for which the TransitionSpec shall be examined.

Returns:

The currently selected TransitionSpec or null if none has been selected so far.

Throws:

java.rmi.RemoteException - remote communication problem

setSelectedTransitionSpec

void setSelectedTransitionSpec(Transition transition,
                               TransitionSpec transitionSpec)
                        throws java.rmi.RemoteException

Select a transition specification for the given Transition in the current Scenario.

Parameters:

transition - The Transition, for which the new transition specification shall be set.

transitionSpec - The new transition specification or null to select none.

Throws:

java.rmi.RemoteException - If the given transition or transitionSpec objects are not a RemoteObject or they do not originate from the TPT instance represented by this API object.

transformToStepList

StepListScenario transformToStepList()
                              throws java.rmi.RemoteException

Transforms this DiagramScenario into an empty StepListScenario. All contents will be deleted, but the meta data like ids and attributes will be retained. Do not use this DiagramScenario afterwards.

Returns:

This DiagramScenario as an empty StepListScenario.

Throws:

java.rmi.RemoteException - remote communication problem