一般 API 呼叫

此主題列出了您可從中建立連結鉤的基本建置區塊。

每一個 API 呼叫會先以 VBScript 顯示,再以 Perl 顯示。語法是使用 <object.><method> 格式。

在 Perl 中,現行 Entity 物件和 Session 物件是預先定義為 entitysession(小寫)。至於 VBScript,會採用現行 Entity 物件,並且不需要明確識別它即可呼叫其方法。

如需相關資訊,請參閱《IBM Rational ClearQuest API 參考手冊》。

API 呼叫 (VBScript/Perl)
功能
[entity.]GetSession $entity->GetSession
取得階段作業,這是要呼叫許多其他 API 所需要的。
session.OutputDebugString $session->OutputDebugString
輸出至除錯串流資訊,您可用來除錯連結鉤程式碼或外部應用程式。
session.GetEntity $session->GetEntity
從資料庫中擷取記錄。
session.EditEntity $session->EditEntity
編輯從資料庫擷取的記錄。
[entity.]SetFieldValue $entity->SetFieldValue
指派欄位的值。
[entity.]Validate $entity->Validate
在記錄儲存至資料庫之前,確保記錄中的資料可被接受。
[entity.]Commit $entity->Commit
在資料庫中確定記錄,包括任何編輯在內。
[entity.]Revert $entity->Revert
取消變更。如果驗證失敗,且記錄未確定,則這是一個可用的好方法。
[entity.]GetFieldValue $entity->GetFieldValue
擷取指定欄位的欄位資訊物件。
FieldInfo.GetValue $FieldInfo->GetValue
擷取欄位的值。
session.BuildQuery $session->BuildQuery
建置查詢。
QueryDef.BuildField $QueryDef->BuildField
在查詢結果集內併入欄位。
QueryDef.BuildFilterOperator QueryFilterNode.BuildFilterOperator $QueryDef->BuildFilterOperator $QueryFilterNode->BuildFilter Operator
建置查詢的過濾器運算子,例如 "equal to" 或 "greater than"。
QueryFilterNode.BuildFilter $QueryFilterNode->BuildFilter
建立複式查詢的支援。
session.BuildResultSet $session->BuildResultSet
建立要執行查詢所需的 ResultSet 物件。
ResultSet.Execute $ResultSet->Execute
使用現行 ResultSet 物件執行查詢。
ResultSet.MoveNext $ResultSet->MoveNext
將游標移至資料集的下一筆記錄。
ResultSet.GetColumnValue $ResultSet->GetColumnValue
擷取現行列中您指定的直欄中的值。
session.GetUserLoginName $session->GetUserLoginName
取得使用者的登入 ID。
entity.Revert $entity->Revert
捨棄對 Entity 物件所做的任何變更。請勿使用 Revert API 來停止連結鉤內的現行動作。這個 API 只用來回復在連結鉤或 Script 內明確啟動的動作。如果您必須停止現行動作,請使用 Script 語言的異常機制以擲出異常,或使動作驗證連結鉤傳回 "false"。

意見