CQCC::CQuest - Base class to manage communications with ClearQuest
This class provides an abstract base class for all ClearQuest interfaces. It handles user logon information and storage, defining class parameters such as query definitions, and provides standard unit tests. A subclass such as CQCC::CQWeb must implement methods to logon, post commands, format queries and modify entity data.
SUPPORT POLICY: See TriggerCQCC.pm for the Rational Support Policy.
ClassInit()
USER
REPLICA_NAME
ClearQuestInterface
CQCC_DATABASE
CQCC_ENTITY
CQCC_MULTISITE
CQCC_REPLICA_NAME
ClassTest(@args)
IOClassFactory()
to get an instance of the desired subclass;
and invokes the object's SelfTest method for testing.
Connect($return)
EditAssocs($VOList, $addAssocs, $delAssocs)
The VOList is expected to be a string with a comma separated list of pathname, vobid, objectID, and old objectID.
If the system fails to successfully make the new additions, they are all deleted to prepare for the trigger failing gracefully.
GetLogonParms()
new CQCC::CQuest()
PerformQuery(db, entity, schema, query, results, AllowCache,
{K=
V,...})>Note that one time queries and results lists are supported. The query can be either a named query in the schema or an array reference to one or more query clauses which will be translated using the schema information. The results argument can be either a named results set or an array containing a results list and a results format.
The AllowCache argument is either TRUE or FALSE - if enabled it will cache query results and return saved results when the same query is run.
The optional Key=>Value pairs allow for future expansion and include the following:
RETURN => STRING (default) or ARRAY: Controls the format of the data being returned.
If STRING, each record is returned as a formatted string based on the results format string and the results are sorted.
If ARRAY it is returned as an array reference for use with columnar output and the first record contains the column labels.
This frontend method will check and convert input before calling the interface specific _PerformQuery method to perform the query itself.
CheckRestrictions(AssocList)
Returns 0 if any items fail.
PrintChangeSets(dbid, entityName, @defectIds)
SelfTest(@args)
SetDatabase(databaseName)
ValidateDatabaseEntity()