com.cerner.ccl.j4ccl.impl.commands.util

Class ScriptExecutionBuilder

java.lang.Object

com.cerner.ccl.j4ccl.impl.commands.util.ScriptExecutionBuilder

public class ScriptExecutionBuilder
extends Object

A class to construct a step to execute a script.

Author:

Joshua Hyde

Method Summary

Modifier and Type	Method and Description
void	addWithReplace(String recordName, com.cerner.ccl.j4ccl.record.Record record) Add a record structure to be referenced by the script.
Collection<String>	build() Construct a set of commands that can be used to execute a given script.
static ScriptExecutionBuilder	getBuilder(String scriptName) Get a builder that can be used to execute a CCL script.
String	getScriptName() Get the name of the script to be executed.
ScriptExecutionBuilder	withArguments(List<com.cerner.ccl.j4ccl.adders.arguments.Argument> arguments) Create a builder that uses the given arguments.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getBuilder

public static ScriptExecutionBuilder getBuilder(String scriptName)

Get a builder that can be used to execute a CCL script.

Parameters:

scriptName - The name of the script to be executed.

Returns:

A ScriptExecutionBuilder object that can be used to execute a CCL script on a server.

Throws:

IllegalArgumentException - If the given script name is blank.

NullPointerException - If the given script name is null.

addWithReplace

public void addWithReplace(String recordName,
                           com.cerner.ccl.j4ccl.record.Record record)

Add a record structure to be referenced by the script.

Parameters:

recordName - The name of the record structure.

record - A Record object representing the record structure to be used.

Throws:

IllegalArgumentException - If the given record structure name is blank.

NullPointerException - If the given record name is null or the record structure reference is null.

build

public Collection<String> build()

Construct a set of commands that can be used to execute a given script.

Returns:

A Collection of String objects representing the commands needed to execute the script with the appropriate record structure references.

getScriptName

public String getScriptName()

Get the name of the script to be executed.

Returns:

The name of the script to be executed.

withArguments

public ScriptExecutionBuilder withArguments(List<com.cerner.ccl.j4ccl.adders.arguments.Argument> arguments)

Create a builder that uses the given arguments.

Parameters:

arguments - A List of Argument objects representing the arguments to be used in the script execution.

Returns:

This builder.

Throws:

NullPointerException - If the given list of arguments is null.