org.safs.model

Interface TestRecordParametersInterface

All Known Implementing Classes:

AbstractCommand, AbstractTestRecord, AbstractTestTable, AlternateLoginTests, BlockID, Breakpoint, Command, ComponentFunction, CycleTestTable, DriverCommand, EngineCommand, LoginWinTests, Logon, ProjectCommand, Regression, Skipped, StepTestTable, SuiteTestTable

public interface TestRecordParametersInterface

Define the minimal interface needed to identify an item that can export a newline-terminated String that is the test record needed to invoke its functionality. That is, it returns the line used to invoke it.

Example: There may be a pre-defined "Logon" StepTestTable that takes two parameters; userid and password. To invoke this StepTestTable will require a test record line like:

T, Logon, , ^userid="userid", ^password="password"

This interface defines the method needed to get that line from the StepTestTable instance. The same interface is used for commands, as well.

Author:

Carl Nagle

Method Summary

Modifier and Type	Method and Description
void	addParameter(java.lang.String parameter) Add a parameter to be used with this test record.
void	addParameters(java.lang.String[] parameters) Add an array of parameters to be used with this test record.
java.lang.StringBuffer	appendParametersToTestRecord(java.lang.StringBuffer buffer, java.lang.String fieldSeparator) Append the stored test record parameters during an export operation.
java.lang.String	exportTestRecord(java.lang.String fieldSeparator) Export a properly formatted test record.
java.util.List	getParameters() Return the list of parameters for this test record.

Method Detail

exportTestRecord

java.lang.String exportTestRecord(java.lang.String fieldSeparator)

Export a properly formatted test record. Use the provided separator to delimit fields in the record.

Parameters:

fieldSeparator - -- separates fields in the test record

Returns:

String test record

getParameters

java.util.List getParameters()

Return the list of parameters for this test record.

Returns:

List of parameters for the test record (if any). Should return a zero-length array if there are no parameters.

addParameter

void addParameter(java.lang.String parameter)

Add a parameter to be used with this test record.

Parameters:

parameter - -- might be null or zero-length

addParameters

void addParameters(java.lang.String[] parameters)

Add an array of parameters to be used with this test record.

Parameters:

parameters - -- non-null array of parameters to be added

appendParametersToTestRecord

java.lang.StringBuffer appendParametersToTestRecord(java.lang.StringBuffer buffer,
                                                    java.lang.String fieldSeparator)

Append the stored test record parameters during an export operation. This is called by the export mechanism and is not normally called by the user.

Parameters:

buffer - -- StringBuffer holding the test record being exported

fieldSeparator - -- separator used to delimit parameters

Returns:

buffer with our test record parameters appended