com.rational.test.ft.script

Interface IClipboard

public interface IClipboard

Defines the set of methods exposed for a clipboard. The primary clipboard supported is the system clipboard availble from RationalTestScript.

Since:

RFT2.1

Method Summary

Modifier and Type	Method and Description
java.lang.String	getText() Returns a copy of the text from this clipboard.
boolean	performTest(IFtVerificationPoint baseline) Captures, compares and logs active clipboard text against the supplied baseline data.
boolean	performTest(IFtVerificationPoint baseline, boolean compareTrueEqualsPass) Captures, compares and logs active clipboard text against the supplied baseline data.
boolean	performTest(IFtVerificationPoint baseline, double delayBetweenRetries, double maximumTestTime) Captures, compares and logs active clipboard text against the supplied baseline data.
boolean	performTest(IFtVerificationPoint baseline, double delayBetweenRetries, double maximumTestTime, boolean compareTrueEqualsPass) Captures, compares and logs clipboard text against the supplied baseline data.
void	setText(java.lang.String text) Copy the supplied text value to this clipboard.

Method Detail

getText

java.lang.String getText()

Returns a copy of the text from this clipboard. A null value is returned if no data has been copied to the clipboard or the clipboard contains a non-text based value (such as an image).

Returns:

the text copied to the clipboard or null.

setText

void setText(java.lang.String text)

Copy the supplied text value to this clipboard.

Parameters:

text -

performTest

boolean performTest(IFtVerificationPoint baseline)

Captures, compares and logs active clipboard text against the supplied baseline data.

Parameters:

baseline - the baseline to compare the active data against.

Returns:

A true value is returned if the passing result is logged, otherwise false is returned.

Since:

RFT2.1

See Also:

performTest(IFtVerificationPoint,boolean), performTest(IFtVerificationPoint,double,double), performTest(IFtVerificationPoint,double,double,boolean)

performTest

boolean performTest(IFtVerificationPoint baseline,
                    boolean compareTrueEqualsPass)

Captures, compares and logs active clipboard text against the supplied baseline data. Allows failing verification points to return and log a passing result.

Parameters:

baseline - the baseline to compare the active data against.

compareTrueEqualsPass - If true the expected and actual data must match to get a passing result. If false the expected and actual data must NOT match to get a passing result.

Returns:

A true value is returned if the passing result is logged, false is returned for a failing result.

Since:

RFT2.1

See Also:

performTest(IFtVerificationPoint), performTest(IFtVerificationPoint,double,double), performTest(IFtVerificationPoint,double,double,boolean)

performTest

boolean performTest(IFtVerificationPoint baseline,
                    double delayBetweenRetries,
                    double maximumTestTime)

Captures, compares and logs active clipboard text against the supplied baseline data. Allows failing verification points to retry until a passing result can be returned or the retry timeout is reached.

Parameters:

baseline - the baseline to compare the active data against.

delayBetweenRetries - the delay in seconds after a failed result is recaptured and retested.

maximumTestTime - the maximum time in seconds spent attempting to receive a passing result. Note that at least one attempt will be made to return a failed result, even if this value is a zero or negative value.

Returns:

A true value is returned if the passing result is logged, false is returned for a failing result.

Since:

RFT2.1

See Also:

performTest(IFtVerificationPoint), performTest(IFtVerificationPoint,boolean), performTest(IFtVerificationPoint,double,double,boolean)

performTest

boolean performTest(IFtVerificationPoint baseline,
                    double delayBetweenRetries,
                    double maximumTestTime,
                    boolean compareTrueEqualsPass)

Captures, compares and logs clipboard text against the supplied baseline data. Allows failing verification points to retry until a passing result can be returned or the retry timeout is reached. Also allows failing verification points to return and log a passing result.

Parameters:

baseline - the baseline to compare the active data against.

delayBetweenRetries - the delay in seconds after a failed result is recaptured and retested.

maximumTestTime - the maximum time in seconds spent attempting to receive a passing result. Note that at least one attempt will be made to return a failed result, even if this value is a zero or negative value.

compareTrueEqualsPass - If true the expected and actual data must match to get a passing result. If false the expected and actual data must NOT match to get a passing result.

Returns:

A true value is returned if the passing result is logged, false is returned for a failing result.

Since:

RFT2.1

See Also:

performTest(IFtVerificationPoint), performTest(IFtVerificationPoint,boolean), performTest(IFtVerificationPoint,double,double)