Req 对象

Req 对象代表需求。

您可以从 ReqFactory 对象获取 Req 对象。

公用方法

此对象支持以下方法。

方法 描述
AddCoverage

分配测试以覆盖当前需求。

语法: AddCoverage(testId)

参数:

  • testId。表示为了覆盖需求而分配的测试 ID 的数字。
AddCoverageEx

分配指定测试文件夹中的所有测试以覆盖当前需求。

语法: AddCoverage(subjectId)

参数:

  • subjectId。表示测试文件夹 ID 的数字。
GetCoverageTestConfigs

返回测试配置的列表，这些配置覆盖当前需求，还可以覆盖与需求筛选匹配的子需求。

语法: GetCoverageTestConfigs(recursive)

参数:

  • recursive。一个布尔值，指示是否检查此需求的子需求的覆盖率。如果为 true，则返回覆盖当前需求及其子需求的测试配置。如果为 false，则仅返回覆盖当前需求的测试配置。
GetCoverageTestConfigsByTestIds

返回测试配置的列表，这些配置覆盖已筛选测试的当前需求，还可以覆盖与需求筛选匹配的子需求。

语法: GetCoverageTestConfigs(testId, recursive)

参数:

  • testId。表示测试 ID 列表的字符串，以逗号分隔。

  • recursive。一个布尔值，指示是否检查此需求的子需求的覆盖率。如果为 true，则返回覆盖当前需求及其子需求的筛选测试配置。如果为 false，则仅返回覆盖当前需求的已筛选测试配置。
GetCoverageTestsByReqFilter

返回测试的列表，这些测试覆盖当前需求，还可以覆盖与需求筛选匹配的子需求。

语法: GetCoverageTestsByReqFilter(reqFilter, recursive)

参数:

  • reqFilter。TDFilter.Text 字符串，用于指定要包含哪些子需求。要检索覆盖此需求的所有测试，请将筛选设置为空字符串，或者使用 GetCoverList 方法。

  • recursive。一个布尔值，指示是否检查此需求的子需求的覆盖率。如果为 true，则筛选应用于此需求及其子需求。如果为 false，则筛选仅应用于此需求。
GetCoverList

获取覆盖此需求的测试列表。

语法: GetCoverList(recursive)

参数:

  • recursive。一个布尔值，指示是否检查此需求的子需求的覆盖率。如果为 true，则此方法返回覆盖此需求及其子需求的测试列表。如果为 false，则仅返回覆盖此需求的测试。
GetCoverListByFilter

获取覆盖当前需求且匹配筛选的所有测试的列表。

语法: GetCoverList(testFilter, recursive)

参数:

  • testFilter。TDFilter.Text 字符串，用于指定要包含哪些测试。

  • recursive。一个布尔值，指示是否检查此需求的子需求的覆盖率。如果为 true，则此方法返回覆盖此需求及其子需求的已筛选测试列表。如果为 false，则仅返回覆盖此需求的已筛选测试。

LockObject

锁定对象。如果对象在服务器上已被更改，则返回 True。

有关详细信息，请参阅LockObject。
Mail

发送项列表的邮件。

有关详细信息，请参阅Mail。

Move

将需求移动为需求树中指定父需求的子需求。

语法: Move(newFatherId, newOrder)

参数:

  • newFatherId。表示指定新父需求的 ID 的数字。

  • newOrder。表示需求在新父需求下的位置的数字。接受的值包括:

    • 表示位置的数字。

    • tagTDAPI_POS_ORDER.TDPOSITION_LAST - 表示该需求最后插入。

除了移动需求之外，如果需求设置为自动解锁，则 Move 属性还会解锁需求。

PopulateTargetCycleToChildren

将需求的目标周期分配为所有子需求的目标周期，沿文件夹树向下递归。

语法: PopulateTargetCycleToChildren()

PopulateTargetReleaseToChildren

将需求的目标发布分配为所有子需求的目标发布，沿文件夹树向下递归。

语法: PopulateTargetReleaseToChildren()

Post

将所有已更改的值发布到数据库。

有关详细信息，请参阅 Post。

刷新

读取已保存的值，并覆盖内存中的值。

有关详细信息，请参阅 刷新。
RemoveCoverage

从覆盖此需求的测试列表中删除测试。

语法: RemoveCoverage(vTest, recursive)

参数:

  • recursive。一个布尔值，指示是否删除当前需求及其所有子需求的测试覆盖率。如果为 true，则删除所有子需求的测试覆盖率。如果为 false，则仅删除当前需求的测试覆盖率。

Undo

撤消对尚未发布的字段值所做的更改。

有关详细信息，请参阅 Undo。

UnLockObject

解锁对象。

有关详细信息，请参阅UnLockObject。

公用属性

此对象支持以下属性。

属性 读/写 类型 描述

附件

 读 对象

对象的附件工厂。请参阅AttachmentFactory 对象。

Author

 读/写 字符串

需求作者的姓名。

AutoPost

 读/写 布尔值

如果为 true，则当字段值更改时，数据库会立即更新。

AutoUnlock

 读/写 布尔值

指示在执行 Refresh 或 Post 操作后，是否自动将项设置为可供其他用户更改。

注释

 读/写 字符串

与此需求相关的注释。

Count

 读 数字

直系子级的数量。

字段

 读/写 Any

指定字段的值。

语法: Req.Field[fieldName]

其中 fieldName 是项目数据库中字段的名称。全部使用大写。

尝试获取或设置不适用于此需求类型的字段值会导致异常。

FieldMultiValue

 读/写 对象

指定字段的 MultiValue 对象。请参阅MultiValue 对象。

语法: Req.FieldMultiValue[fieldName]

其中 fieldName 是项目数据库中字段的名称。全部使用大写。

HasAttachment

 读 布尔值

检查对象是否有一个或多个附件。

HasCoverage

 读 布尔值

至少有一项测试覆盖此需求。

HasLinkage

 读 布尔值

检查当前对象是否至少有一个关联的 Bug。

HasRichContent

 读 布尔值

检查对象是否具有丰富的内容。

ID

 读 数字

项 ID。

IsLocked

 读 布尔值

检查对象是否被锁定以供编辑。

IsLocked 由 LockObject 方法设置，由 UnlockObject 方法重置。

如果对象具有 AutoUnlock 属性，且该属性设置为 True，则 IsLocked 也可通过 Post 或 Refresh 操作进行重置。

修改时间

 读 布尔值

检查自上次刷新或发布操作以来项是否已被修改。如果为 true，则表明服务器端的字段属性不是最新的。

Name

 读/写 字符串

树中显示的需求名称。

ParentId

 读/写 数字

需求的父 ID。

设置此属性可将需求置于层次结构中另一个需求之下。

默认值为 -1，表示顶级需求。

优先级

 读/写 字符串

需求优先级。

产品

 读/写 字符串

为其设置需求的产品名称。
ReqCoverageFactory 读 对象 获取 ReqCoverage 工厂对象。请参阅ReqCoverageFactory 对象。
RequirementType 读 对象 获取需求类型。请参阅ReqType 对象。

已审核

 读/写 字符串

审核状态。

审核状态可以是项目中配置的任意值。典型的示例为“已更改”、“未审核”和“已审核”。

RnDEstimatedEffortInHours

 读/写 数字

研发工作。

状态

 读 字符串

覆盖此需求的测试的状态。

覆盖测试的状态为: “失败”、“未运行”、“未完成”或“通过”。

如果没有测试覆盖此需求，则值为“未覆盖”。

它也可以是项目管理员定义的任何自定义状态。
Type 读/写 字符串 需求类型的名称。

TypeId

 读/写 字符串

需求的类型 ID。

TypeName

 读 字符串

字段的类型。

Virtual

 读 布尔值

检查是否为虚拟项，即没有相应数据库记录的项。

示例

示例: 移动需求

示例: 获取尚未运行的覆盖率测试

返回页首