Richiami API comuni

Questa sezione elenca i blocchi di creazione di base per cui è possibile creare hook. Ciascun richiamo API è riportato prima in VBScript e poi in Perl. La sintassi utilizza un formato <oggetto.><metodo>.

in Perl, l'oggetto Entity corrente e l'oggetto Session sono predefiniti come entity e session (minuscolo). Per VBScript, si presuppone l'esistenza dell'oggetto Entity corrente e non è necessario identificarlo esplicitamente durante il richiamo dei metodi.

Per ulteriori informazioni, consultare Riferimento API IBM Rational ClearQuest.

Richiamo API (VBScript/Perl)
Funzione
[entity.]GetSession $entity->GetSession
Ottiene la sessione, necessaria per richiamare molte altre API.
session.OutputDebugString $session->OutputDebugString
Viene emesso sulle informazioni del flusso di debug che è possibile utilizzare per il debug del codice hook o dell'applicazione esterna.
session.GetEntity $session->GetEntity
Richiama un record dal database.
session.EditEntity $session->EditEntity
Modifica un record richiamato dal database.
[entity.]SetFieldValue $entity->SetFieldValue
Assegna un valore ad un campo.
[entity.]Validate $entity->Validate
Verifica che i dati di un record siano validi prima di salvare il record sul database.
[entity.]Commit $entity->Commit
Esegue il commit del record, incluse le modifiche al database.
[entity.]Revert $entity->Revert
Annulla le modifiche. Un ottimo metodo da utilizzare se la convalida ha esito negativo e il record non viene sottoposto a commit.
[entity.]GetFieldValue $entity->GetFieldValue
Richiama l'oggetto informativo del campo per il campo specificato.
FieldInfo.GetValue $FieldInfo->GetValue
Richiama i valori di un campo.
session.BuildQuery $session->BuildQuery
Crea una query.
QueryDef.BuildField $QueryDef->BuildField
Include un campo in una serie di risultati della query.
QueryDef.BuildFilterOperator QueryFilterNode.BuildFilterOperator $QueryDef->BuildFilterOperator $QueryFilterNode->BuildFilter Operator
Crea un operatore di filtro per una query, ad esempio "uguale a" o "maggior di".
QueryFilterNode.BuildFilter $QueryFilterNode->BuildFilter
Crea il supporto per una query complessa.
session.BuildResultSet $session->BuildResultSet
Crea l'oggetto serie di risultati necessario per eseguire una query.
ResultSet.Execute $ResultSet->Execute
Esegue la query con l'oggetto serie di risultati corrente.
ResultSet.MoveNext $ResultSet->MoveNext
Sposta il cursore al record successivo nel dataset.
ResultSet.GetColumnValue $ResultSet->GetColumnValue
Richiama il valore nella colonna specifica della riga corrente.
session.GetUserLoginName $session->GetUserLoginName
Ottiene l'ID di accesso dell'utente.
entity.Revert $entity->Revert
Elimina le modifiche apportate all'oggetto Entity. Non utilizzare l'API Revert per interrompere l'azione in corso all'interno di un hook. Questa API è solo per annullare un'azione avviata esplicitamente in un hook o script. Se è necessario interrompere l'azione corrente, utilizzare i meccanismi di eccezione del linguaggio di script per rilevare un'eccezione o far sì che l'hook convalida-azione restituisca "false."

Feedback