NAME

ApTest::Base::Parent - base class for connecting an object to its parent Suite object

AUTHOR

Shane P. McCarron <shane@aptest.com>

COPYRIGHT

Copyright 2001-2016 Applied Testing and Technology, Inc. All Rights Reserved.

SYNOPSIS

use ApTest::Base::Parent ;

use base qw( ApTest::Base::Parent ) ;

METHODS

parentSuite - accessor for a Suite object

$parent = $childObject->parentSuite( [ $ref ] ) ;

$ref is an optional reference to an existing suite object.

If no ref is provided, and one is not already created, and the current object has a Suite attribute, creates a suite object for that suite and associates it.

Returns a reference to a Suite object, or undef if no Suite object is available.

parentSuiteClear - clear the parent suite ref

$oldRef = $childObject->parentSuiteClear() ;

Clears out the parent suite reference. Used when serializing an object. Returns the previous value of the attribute.

parentSuiteRelease - release a parent suite if we acquired it

$childObject->parentSuiteRelease() ;

Releases the parent suite object if it was acquired by us.

haveParentSuite - detect if we are attached to a parent

$status = $ref->haveParentSuite ;

Returns true if this object is attached to a parent suite object.

reqDB - get a handle to the requirements database

$reqH = $ref->reqDB() ;

results - get a reference to a results object.

Returns a reference to a Results object from the parent Suite .

rfields - get a reference to a ReqFields object.

Returns a reference to a ReqFields object from the parent Suite.

schema - get a reference to a schema object

Returns a reference to a schema object from the parent suite.

suite - accessor for test suite attribute

$session->suite();
$session->suite(userName);

returns a string containing the name of the associated test suite.

suiteDB - accessor for suite's suiteDB object

$sdb = $ref->suiteDB();

Returns a handle to a suiteDB object.

testDB - accessor for suite's testDB object

$tdb = $ref->testDB() ;

Returns a handle to test database for the suite.

userHash - get a hash of user ids and fullnames

Returns a reference to a hash of fullnames by user id.

variables - get a variableSet object from the suite

Returns a handle to a variableSet object.

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