Skip navigation links

oracle.wcps.conductor.scenario.syntax
Interface IScenarioStatement

All Superinterfaces:

ICompoundStatement, IStatement

public interface IScenarioStatement

extends ICompoundStatement

Represents the scenario definition.

Nested Class Summary

static class

IScenarioStatement.ScenarioStatus

Nested classes/interfaces inherited from interface oracle.wcps.conductor.scenario.syntax.IStatement

IStatement.ErrorLevel

Field Summary

Fields inherited from interface oracle.wcps.conductor.scenario.syntax.ICompoundStatement

INDEX_SEPARATOR, INDEX_SEPARATOR_REGEX

Method Summary

ICommonInputParameter	addInputParameter(java.lang.String paramName, boolean required) Adds and returns a scenario input parameter to this scenario definition.
java.lang.String	getCreatedAuthor()
java.util.Date	getCreatedDateTime()
java.lang.String	getDisplayName()
java.util.List<ICommonInputParameter>	getInputParameters() Gets/Defines input parameters that may be required to execute the document.
java.lang.String	getName() Get/Set name of the scenario.
IScenarioStatement.ScenarioStatus	getStatus()
java.util.List<java.lang.String>	getTags() Get/Set tags of the scenario.
java.lang.String	getUpdatedAuthor()
java.util.Date	getUpdatedDateTime()
boolean	hasErrors() Returns true if the scenario definition has compile time errors.
boolean	isValidated() Returns true if the scenario has already been validated.
void	setCreatedAuthor(java.lang.String author)
void	setCreatedDateTime(java.util.Date date)
void	setDisplayName(java.lang.String displayName)
void	setInputParameters(java.util.List<ICommonInputParameter> parameters)
void	setName(java.lang.String name)
void	setStatus(IScenarioStatement.ScenarioStatus status)
void	setTags(java.util.List<java.lang.String> tags)
void	setUpdatedAuthor(java.lang.String author)
void	setUpdatedDateTime(java.util.Date date)
java.lang.String	toString() Returns the scenario in string (pretty XML) format.
java.lang.String	toString(boolean pretty) Returns the scenario in string (XML) format.

Methods inherited from interface oracle.wcps.conductor.scenario.syntax.ICompoundStatement

addStatement, addStatement, afterUnmarshalJson, deleteStatement, getBodyStatements, getFirstErrorMessage, getStatement, getStatementByIndex, indexOfStatement, raiseError, setBodyStatements

Methods inherited from interface oracle.wcps.conductor.scenario.syntax.IStatement

getComments, getContainerScenario, getErrorLevel, getErrorMessage, getId, getLabel, getNodeName, getParentStatement, getScenarioStatementIndex, getStatementIndex, raiseError, setComments, setId, setLabel

Method Detail

getName

java.lang.String getName()

Get/Set name of the scenario.

setName

void setName(java.lang.String name)

getTags

java.util.List<java.lang.String> getTags()

Get/Set tags of the scenario.

setTags

void setTags(java.util.List<java.lang.String> tags)

getInputParameters

java.util.List<ICommonInputParameter> getInputParameters()

Gets/Defines input parameters that may be required to execute the document.

This is for metadata purposes. Parameters marked as "required" will cause an exception if the document is attempted to be executed without specifying the input parameter.

setInputParameters

void setInputParameters(java.util.List<ICommonInputParameter> parameters)

addInputParameter

ICommonInputParameter addInputParameter(java.lang.String paramName,
                                        boolean required)

Adds and returns a scenario input parameter to this scenario definition.

This is a convenience method to construct an input parameter for the scenario.

hasErrors

boolean hasErrors()

Returns true if the scenario definition has compile time errors.

isValidated

boolean isValidated()

Returns true if the scenario has already been validated.

toString

java.lang.String toString()

Returns the scenario in string (pretty XML) format.

Overrides:

toString in class java.lang.Object

toString

java.lang.String toString(boolean pretty)

Returns the scenario in string (XML) format.

Parameters:

pretty - if true, the scenario will be formatted.

Returns:

the scenario in string format.

getStatus

IScenarioStatement.ScenarioStatus getStatus()

Returns:

setStatus

void setStatus(IScenarioStatement.ScenarioStatus status)

Parameters:

status -

getCreatedAuthor

java.lang.String getCreatedAuthor()

Returns:

setCreatedAuthor

void setCreatedAuthor(java.lang.String author)

Parameters:

author -

getCreatedDateTime

java.util.Date getCreatedDateTime()

Returns:

setCreatedDateTime

void setCreatedDateTime(java.util.Date date)

Parameters:

date -

getUpdatedAuthor

java.lang.String getUpdatedAuthor()

Returns:

setUpdatedAuthor

void setUpdatedAuthor(java.lang.String author)

Parameters:

author -

getUpdatedDateTime

java.util.Date getUpdatedDateTime()

Returns:

setUpdatedDateTime

void setUpdatedDateTime(java.util.Date date)

Parameters:

date -

getDisplayName

java.lang.String getDisplayName()

setDisplayName

void setDisplayName(java.lang.String displayName)

Skip navigation links