公共 API 调用

本主题列出了可创建挂钩的基本构建块。

每个 API 调用都是先以 VBScript 语言形式给出,然后以 Perl 语言形式给出。语法使用 <object.><method> 格式。

在 Perl 中,当前的 Entity 对象和 Session 对象被预定义为 entitysession(小写)。 对于 VBScript,缺省情况下会使用当前的 Entity 对象,因此,当调用其方法时,不必对其进行显式标识。

有关更多信息,请参阅 IBM Rational ClearQuest API Reference

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
获取用户的登录标识。
entity.Revert $entity->Revert
放弃对 Entity 对象所做的任何更改。请勿使用还原 API 来停止挂钩中的当前操作。 该 API 仅用于还原已在挂钩或脚本中显式启动的操作。如果必须停止当前操作,请使用脚本语言的异常机制以抛出异常,或者使“操作-验证”挂钩返回“false”。

反馈