Allgemeine API-Aufrufe

Dieser Artikel listet die Grundbausteine zum Erstellen von Hooks auf.

Jeder API-Aufruf wird zunächst in VBScript und anschließend in Perl dargestellt. In der Syntax wird das Format <objekt.><methode> verwendet.

In Perl werden die aktuellen Objekte Entity und Session als entity und session (in Kleinbuchstaben) vordefiniert. In VBScript wird das aktuelle Objekt Entity vorausgesetzt, d. h., Sie müssen dieses Objekt beim Aufrufen der dazugehörigen Methoden nicht explizit identifizieren.

Weitere Informationen finden Sie in der Veröffentlichung IBM Rational ClearQuest API-Referenz.

API-Aufruf (VBScript/Perl)
Funktion
[entity.]GetSession $entity->GetSession
Ruft die Sitzung ab (eine Voraussetzung für viele andere API-Aufrufe).
session.OutputDebugString $session->OutputDebugString
Gibt Informationen an den Fehlerbehebungsdatenstrom aus, die für die Fehlerbehebung in Ihrem Hook-Code oder Ihrer externen Anwendung verwendet werden können.
session.GetEntity $session->GetEntity
Ruft einen Datensatz aus der Datenbank ab.
session.EditEntity $session->EditEntity
Bearbeitet einen Datensatz, der aus der Datenbank abgerufen wurde.
[entity.]SetFieldValue $entity->SetFieldValue
Weist einem Feld einen Wert zu.
[entity.]Validate $entity->Validate
Stellt sicher, dass die Daten in einem Datensatz gültig sind, bevor der Datensatz in der Datenbank gespeichert wird.
[entity.]Commit $entity->Commit
Schreibt den Datensatz mit allen vorgenommenen Bearbeitungen in der Datenbank fest.
[entity.]Revert $entity->Revert
Widerruft die Änderungen. Eine hilfreiche Methode, wenn die Validierung fehlschlägt und keine Festschreibung erfolgt.
[entity.]GetFieldValue $entity->GetFieldValue
Ruft das Infoobjekt für das angegebene Feld ab.
FieldInfo.GetValue $FieldInfo->GetValue
Ruft die Werte eines Felds ab.
session.BuildQuery $session->BuildQuery
Erstellt eine Abfrage.
QueryDef.BuildField $QueryDef->BuildField
Schließt ein Feld in die Liste der Abfrageergebnisse ein.
QueryDef.BuildFilterOperator QueryFilterNode.BuildFilterOperator $QueryDef->BuildFilterOperator $QueryFilterNode->BuildFilter Operator
Erstellt einen Filteroperator für eine Abfrage wie "gleich" oder "größer als".
QueryFilterNode.BuildFilter $QueryFilterNode->BuildFilter
Erstellt Unterstützung für eine komplexe Abfrage.
session.BuildResultSet $session->BuildResultSet
Erstellt das zum Ausführen einer Abfrage erforderliche Objekt "ResultSet".
ResultSet.Execute $ResultSet->Execute
Führt die Abfrage mit dem aktuellen Objekt "ResultSet" aus.
ResultSet.MoveNext $ResultSet->MoveNext
Versetzt den Cursor in den nächsten Datensatz innerhalb der Datenmenge.
ResultSet.GetColumnValue $ResultSet->GetColumnValue
Ruft den Wert für die aktuelle Zeile in der von Ihnen angegebenen Spalte ab.
session.GetUserLoginName $session->GetUserLoginName
Ruft die Anmelde-ID des Benutzers ab.
entity.Revert $entity->Revert
Löscht Änderungen, die am Objekt "Entity" vorgenommen wurden. Verwenden Sie den API-Aufruf "Revert" nicht, um die aktuelle Aktion innerhalb eines Hooks zu stoppen. Mit dieser API kann nur eine Aktion zurückgesetzt werden, die in einem Hook oder Script explizit gestartet wurde. Zum Abbrechen der aktuellen Aktion können Sie mit den Ausnahmemechanismen der Scripting-Sprache eine Ausnahmebedingung auslösen oder vom Hook für Aktionsvalidierung den Wert "false" zurückgeben lassen.

Feedback