Appels d'API courants

Cette section répertorie les principaux blocs de construction que vous pouvez utiliser pour créer des points d'ancrage. Chaque appel d'API s'affiche d'abord en VBScript puis en langage Perl. La syntaxe utilise le format <objet.><méthode>.

En langage Perl, les objets Entity et Session en cours sont prédéfinis comme entity et session (en minuscules). En VBScript, l'objet Entity en cours est pris en compte et vous n'avez pas besoin de l'identifier de manière explicite lors de l'appel des méthodes correspondantes.

Pour plus d'informations, voir IBM Rational ClearQuest - Référence de l'API .

Appel d'API (VBScript/Perl)
Fonction
[entity.]GetSession $entity->GetSession
Obtient la session (obligatoire pour l'appel de nombreuses autres API).
session.OutputDebugString $session->OutputDebugString
Génère les informations du flux de débogage, qui peuvent être utilisées pour déboguer le code d'un point d'ancrage ou une application externe.
session.GetEntity $session->GetEntity
Récupère un enregistrement de la base de données.
session.EditEntity $session->EditEntity
Edite un enregistrement extrait de la base de données.
[entity.]SetFieldValue $entity->SetFieldValue
Attribue une valeur à une zone.
[entity.]Validate $entity->Validate
Vérifie que les données d'un enregistrement sont acceptables avant que l'enregistrement ne soit sauvegardé dans la base de données.
[entity.]Commit $entity->Commit
Valide l'enregistrement dans la base de données, modifications comprises.
[entity.]Revert $entity->Revert
Annule les changements. Cette méthode est très utile si la validation échoue et si l'enregistrement n'est pas validé.
[entity.]GetFieldValue $entity->GetFieldValue
Récupère l'objet info d'une zone donnée.
FieldInfo.GetValue $FieldInfo->GetValue
Extrait les valeurs d'une zone.
session.BuildQuery $session->BuildQuery
Génère une requête.
QueryDef.BuildField $QueryDef->BuildField
Inclut une zone dans un ensemble de résultats de requête.
QueryDef.BuildFilterOperator QueryFilterNode.BuildFilterOperator $QueryDef->BuildFilterOperator $QueryFilterNode->BuildFilter Operator
Génère un opérateur de filtre pour une requête (égal à, supérieur à, etc.).
QueryFilterNode.BuildFilter $QueryFilterNode->BuildFilter
Permet la prise en charge d'une requête complexe.
session.BuildResultSet $session->BuildResultSet
Crée l'objet ResultSet nécessaire à l'exécution d'une requête.
ResultSet.Execute $ResultSet->Execute
Exécute la requête avec l'objet ResultSet en cours.
ResultSet.MoveNext $ResultSet->MoveNext
Déplace le curseur sur l'enregistrement suivant de l'ensemble de données.
ResultSet.GetColumnValue $ResultSet->GetColumnValue
Extrait la valeur de la colonne indiquée pour la ligne en cours.
session.GetUserLoginName $session->GetUserLoginName
Obtient l'ID de connexion de l'utilisateur.
entity.Revert $entity->Revert
Supprime tout changement apporté à l'objet Entity. N'utilisez pas cette API pour arrêter l'action en cours à partir d'un point d'ancrage. Elle permet uniquement d'annuler une action démarrée explicitement à partir d'un point d'ancrage ou d'un script. Pour arrêter l'action en cours, utilisez les mécanismes fournis par le langage de script pour générer une exception ou bien faites en sorte que le point d'ancrage d'action-validation renvoie la valeur "false".

Retour d'informations