ApTest Manager documentation: API: Result

Result

NAME

Result - result definition class

AUTHOR

Shane P. McCarron <shane@aptest.com>

COPYRIGHT

Copyright 1999-2006 Applied Testing and Technology, Inc. All Rights Reserved.

SYNOPSIS

use Results;

# create a schema object
my $results = new Results(suiteName);

# get a description associated with a result
$desc = $results->description($res)

METHODS

new - open the Results file

$results = new Results(suite[, profName [, resPath ] ] );

Creates a new results object.

suite
the name of a test suite to access.
profName
the name of the profile to manipulate.
resPath
a path to a results file (for testing).

returns a reference to the results object.

as_popup - emit the selection list of results as a popup list

$output = $results->as_popup(varname, current, fn);

varname is the name of the HTML variable to use

current is the currently selected item.

fn is a function to invoke on change.

Returns a select and option set that uses the name varname, with the item current selected (if defined).

as_radio - emit the selection list of results as a radio button set

$output = $results->as_radio(varname, current, fn);

varname is the name of the HTML variable to use

current is the currently selected item.

fn is a function to call on change.

Returns a set of radio buttons that use the name varname, with the item current selected (if defined).

as_html - emit a result as HTML

$output = $results->as_html(result);

Returns the HTML version of the result, including appropriate colors.

description - get the description for a result name

$desc = $results->description();

rlist - retrieve an ordered list of results

@list = $results->rlist();

numResults - accessor for the number of defined results

$results->numResults();

returns the number of results defined for the suite

ordinal - returns the ordinal number of a result name in the result list

$ord = $results->ordinal(resName) ;

Returns the position of the result in the list, or undef if the result name is not defined.

release - release the object

Really a no-op, since this object does not have a database.

status - get the status code for a result name

$stat = $results->status();

Copyright © 2000-2006 Applied Testing and Technology, Inc. All rights reserved.