Skip navigation links

oracle.wcps.conductor.scenario.syntax
Interface IStatement

All Known Subinterfaces:

ICatchStatement, ICompoundStatement, IConditionalStatement, IConditionalStatements, IErrorHandler, IExecutableExpressionStatement, IForEachStatement, IInvokeInputParameter, IInvokeProviderStatement, IInvokeScenarioStatement, IIteratingStatement, IOtherwiseStatement, IRaiseErrorStatement, IReturnStatement, IScenarioStatement, IScriptStatement, ITransactionStatement, ITryStatement, IVariableAssignmentStatement, IWhileStatement

public interface IStatement

Base interface for all scenario statements.

Nested Class Summary

static class

IStatement.ErrorLevel Enumerated type for specified error levels.

Method Summary

java.lang.String	getComments() Gets/sets comments for the current statement
IScenarioStatement	getContainerScenario() Returns the scenario containing this statement.
IStatement.ErrorLevel	getErrorLevel() Returns the error level of the current statement, if any.
java.lang.String	getErrorMessage() Returns the error message of the current statement, if any.
java.lang.String	getId() Gets/sets an id for this statement implementation.
java.lang.String	getLabel() Gets/sets a label for the current statement.
java.lang.String	getNodeName() Gets the name of the scenario node, as in a GUI tool, such as scenario or return (this is a read-only attribute)
ICompoundStatement	getParentStatement() Returns the parent container/body statement of the current statement.
java.lang.StringBuilder	getScenarioStatementIndex(java.lang.StringBuilder builder)
java.lang.String	getStatementIndex() Gets the current statement's index identifier.
void	raiseError(IStatement.ErrorLevel errorLevel, java.lang.String msg) Method to raise an error for the current statement.
void	setComments(java.lang.String comments)
void	setId(java.lang.String id)
void	setLabel(java.lang.String label)

Method Detail

getId

java.lang.String getId()

Gets/sets an id for this statement implementation.

This is used primarily for diagram and tooling, and can be null.

setId

void setId(java.lang.String id)

getNodeName

java.lang.String getNodeName()

Gets the name of the scenario node, as in a GUI tool, such as scenario or return (this is a read-only attribute)

Returns:

getLabel

java.lang.String getLabel()

Gets/sets a label for the current statement.

Also designed for tooling for tooltip hovering.

setLabel

void setLabel(java.lang.String label)

getComments

java.lang.String getComments()

Gets/sets comments for the current statement

setComments

void setComments(java.lang.String comments)

getContainerScenario

IScenarioStatement getContainerScenario()

Returns the scenario containing this statement. If the statement has not been added to a scenario yet, null will be returned.

raiseError

void raiseError(IStatement.ErrorLevel errorLevel,
                java.lang.String msg)

Method to raise an error for the current statement.

getErrorLevel

IStatement.ErrorLevel getErrorLevel()

Returns the error level of the current statement, if any.

getErrorMessage

java.lang.String getErrorMessage()

Returns the error message of the current statement, if any.

getParentStatement

ICompoundStatement getParentStatement()

Returns the parent container/body statement of the current statement.

Will return null if the current statement is IScenarioStatement.

getStatementIndex

java.lang.String getStatementIndex()

Gets the current statement's index identifier.

See Also:

ICompoundStatement.getStatementByIndex(String)

getScenarioStatementIndex

java.lang.StringBuilder getScenarioStatementIndex(java.lang.StringBuilder builder)

Skip navigation links