CoverageEntity object

A CoverageEntity object represents the association between a requirement and another entity that covers it.

You get a CoverageEntity object from a CoverageFactory object or a ReqCoverageFactory object.

Public methods

This object supports the following methods.

Method Description

Post

Posts all changed values into database.

For details, see  Post.

Refresh

Reads saved values, overwriting values in memory.

For details, see  Refresh.

Undo

Undoes changes to field values that have not been posted.

For details, see  Undo.

Public properties

This object supports the following properties.

Property R/W Type Description

AutoPost

R/W Boolean

If true, the database is updated immediately when the field value changes.

Syntax: coverageEntity.AutoPost

CoverageType

R String

The coverage type. For example, Test.

Syntax: coverageEntity.CoverageType

Field

R/W Any

The value of the specified field.

Syntax: coverageEntity.Field[fieldName]

Parameter:

  • fieldName. A string that represents the name of the field in the project database. Use all upper case.

FieldMultiValue

R/W Object

The MultiValue object of the specified field. See MultiValue object.

Syntax: coverageEntity.FieldMultiValue[fieldName]

Parameter:

  • fieldName. A string that represents the name of the field in the project database. Use all upper case.

ID

R Number

The item ID.

Syntax: coverageEntity.ID

Modified

R Boolean

Checks if the item has been modified since last refresh or post operation. If true, the field properties on the server side are not up to date.

Syntax: coverageEntity.Modified

Name

R String

Depending how you get the object:

Syntax: coverageEntity.Name

RequirementEntity

R Object

The Req object being covered.

Syntax: coverageEntity.RequirementEntity

RequirementName R String

Name of the requirement that is being covered.

Syntax: coverageEntity.RequirementName

Status

R String

The execution result status of the TargetEntity.

Syntax: coverageEntity.Status

TargetEntity

R Object

The TestEntity that covers the requirement.

Syntax: coverageEntity.TargetEntity

TestEntity R Objecy

The Test object that covers the requirement.

Syntax: coverageEntity.TestEntity

TestName R String

Name of the test that covers the requirement.

Syntax: coverageEntity.TestName

 TypeName

R String

The field's type.

Syntax: coverageEntity.TypeName

 Virtual

R Boolean

Checks if this is a virtual item, that is, an item that does not have a corresponding database record.

Syntax: coverageEntity.Virtual

Back to top