org.safs.model

Class ComponentFunction

java.lang.Object

org.safs.model.AbstractTestRecord

org.safs.model.AbstractCommand

org.safs.model.ComponentFunction

All Implemented Interfaces:

TestRecordParametersInterface

public class ComponentFunction
extends AbstractCommand

Represents a ComponentFunction command. These are only allowed in Step tables.

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
ComponentFunction(java.lang.String functionName, java.lang.String windowName, java.lang.String componentName) Create an instance of a ComponentFunction command to act on a specific component.

Method Summary

Modifier and Type	Method and Description
protected java.lang.StringBuffer	appendCommandToTestRecord(java.lang.StringBuffer sb, java.lang.String fieldSeparator) Overrides superclass to append the windowname and componentname before invoking super.appendCommandToTestRecord to append the actual command.
java.lang.String	getComponentName() Retrieve the name of the component to act upon.
java.lang.String	getTestRecordID() Returns the string record type for this command.
java.lang.String	getWindowName() Retrieves the name of the window to act upon.
boolean	isFailureOK() Indicates if a failure is acceptable for this ComponentFunction.
boolean	isWarningOK() Indicates if a warning is acceptable for this ComponentFunction.
void	setFailureOK(boolean newValue) Sets whether a failure is acceptable for this ComponentFunction.
void	setWarningOK(boolean newValue) Sets whether a warning is acceptable for this ComponentFunction.

Methods inherited from class org.safs.model.AbstractCommand

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

ComponentFunction

public ComponentFunction(java.lang.String functionName,
                         java.lang.String windowName,
                         java.lang.String componentName)

Create an instance of a ComponentFunction command to act on a specific component. This is used by our org.safs.model.commands and is not normally used by the user unless they are trying to build a custom component function.

Parameters:

functionName - -- the action keyword ("Click", "Select", etc.)

windowName - -- the name of the Window on which to act

componentName - -- the name of the Component within the window to act upon

Throws:

java.lang.IllegalArgumentException - if these parameters are null or zero-length

Method Detail

getWindowName

public java.lang.String getWindowName()

Retrieves the name of the window to act upon.

Returns:

the name of the window to act upon.

getComponentName

public java.lang.String getComponentName()

Retrieve the name of the component to act upon.

Returns:

the name of the component to act upon.

appendCommandToTestRecord

protected java.lang.StringBuffer appendCommandToTestRecord(java.lang.StringBuffer sb,
                                                           java.lang.String fieldSeparator)

Overrides superclass to append the windowname and componentname before invoking super.appendCommandToTestRecord to append the actual command.

Overrides:

appendCommandToTestRecord in class AbstractCommand

Parameters:

sb - StringBuffer to append fields to

fieldSeparator - character to append in between fields

Returns:

sb StringBuffer appended as appropriate.

isWarningOK

public final boolean isWarningOK()

Indicates if a warning is acceptable for this ComponentFunction.

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

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

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

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 ComponentFunction commands are:

• "TF" - if failureOK is true
• "TW" - if warningOK is true
• "T" - if failureOK and warningOK are false

Overrides:

getTestRecordID in class AbstractCommand

Returns:

the record type of this command