org.safs.model

Class EngineCommand

java.lang.Object

org.safs.model.AbstractTestRecord

org.safs.model.AbstractCommand

org.safs.model.Command

org.safs.model.EngineCommand

All Implemented Interfaces:

TestRecordParametersInterface

public class EngineCommand
extends Command

Simple extension to handle Engine Commands of record type "E"

Field Summary

Fields inherited from class org.safs.model.AbstractTestRecord

_parameters, BLOCKID_RECORD_TYPE, BREAKPOINT_RECORD_TYPE, COMPONENT_FUNCTION_FAILOK_RECORD_TYPE, COMPONENT_FUNCTION_RECORD_TYPE, COMPONENT_FUNCTION_WARNOK_RECORD_TYPE, DRIVER_COMMAND_FAILOK_RECORD_TYPE, DRIVER_COMMAND_RECORD_TYPE, DRIVER_COMMAND_WARNOK_RECORD_TYPE, EMPTY_PARAMETER, ENGINE_COMMAND_FAILOK_RECORD_TYPE, ENGINE_COMMAND_RECORD_TYPE, ENGINE_COMMAND_WARNOK_RECORD_TYPE, PROJECT_COMMAND_RECORD_TYPE, SKIPPED_RECORD_TYPE

Constructor Summary

Constructors

Constructor and Description
EngineCommand(java.lang.String commandName) Create a Engine Command instance using the provided command name.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getTestRecordID() Returns the string record type for this command.
boolean	isFailureOK() Indicates if a failure is acceptable for this EngineCommand.
boolean	isWarningOK() Indicates if a warning is acceptable for this EngineCommand.
void	setFailureOK(boolean newValue) Sets whether a failure is acceptable for this EngineCommand.
void	setWarningOK(boolean newValue) Sets whether a warning is acceptable for this EngineCommand.

Methods inherited from class org.safs.model.AbstractCommand

appendCommandToTestRecord, exportTestRecord, getCommandName

Methods inherited from class org.safs.model.AbstractTestRecord

addParameter, addParameters, appendParametersToTestRecord, getParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

EngineCommand

public EngineCommand(java.lang.String commandName)

Create a Engine Command instance using the provided command name. This is used by the org.safs.model.commands classes and is not typically used by the user unless they are building a custom Engine Command.

Parameters:

commandName - -- cannot be null or zero-length

Throws:

java.lang.IllegalArgumentException - for null or zero-length command names

Method Detail

isWarningOK

public final boolean isWarningOK()

Indicates if a warning is acceptable for this EngineCommand.

Returns:

true if a warning is acceptable, otherwise false

See Also:

setWarningOK(boolean)

setWarningOK

public final void setWarningOK(boolean newValue)

Sets whether a warning is acceptable for this EngineCommand.

If a warning is set as acceptable, setFailureOK(false) is called to turn off failures.

Parameters:

newValue - true to indicate that warnings are acceptable, otherwise false

See Also:

isWarningOK()

isFailureOK

public final boolean isFailureOK()

Indicates if a failure is acceptable for this EngineCommand.

Returns:

true if a failure is acceptable, otherwise false

See Also:

setFailureOK(boolean)

setFailureOK

public final void setFailureOK(boolean newValue)

Sets whether a failure is acceptable for this EngineCommand.

If a failure is set as acceptable, setWarningOK(false) is called to turn off warnings.

Parameters:

newValue - true to indicate that failures are acceptable, otherwise false

See Also:

isFailureOK()

getTestRecordID

public java.lang.String getTestRecordID()

Returns the string record type for this command. The set of values for EngineCommand commands are:

• "EF" - if failureOK is true
• "EW" - if warningOK is true
• "E" - if failureOK and warningOK are false

Overrides:

getTestRecordID in class AbstractCommand

Returns:

the record type of this command