Req Object

Description

Represents a requirement for which testing must be performed.

Remarks

Get a Req object from the ReqFactory.

For version control, use the IVersionedEntity interface.

Interfaces

Implemented Interface	Description
IAlertable2	Services for managing auto-alerts.
IAlertable2Dispatch	Services for managing auto-alerts.
IBaseField2	Represents a basic data field or entity, such as an attachment.
IBaseField3	Represents a basic data field or entity, such as an attachment.
IBaseField4	Represents a basic data field or entity, such as an attachment.
ICoverableReq2	Represents a requirement that is covered by another entity.
IFollowUpManager	Manages the user-defined follow-ups.
ILinkable	Services for managing links.
IMailableEntity	Mail support for entities.
ISupportRBTAnalysisChild	Represents Risk-based Quality Management analysis capabilities for the Req coclass. This class provides services for handling the child requirements affected by the analysis.
ISupportRBTAnalysisParent2	Represents Risk-based Quality Management analysis capabilities for the Req coclass.
ISupportRBTAssessment2	Represents Risk-based Quality Management assessment capabilities for the Req coclass.
ISupportRichContent	Services for supporting rich content.
IVersionedEntity	Represents an entity that can have versions.

Public Methods

AddAlert	Adds a new alert to the specified entity.
AddConfigurationsToCoverage	Adds a list of test configurations to the coverage.
AddCoverage	Assigns a test to cover this requirement.
AddCoverageByFilter	Adds the tests from the specified subject that match the input filter to the list of tests that cover the current requirement.
AddCoverageEx	Assigns all the tests in the specified subject folder to cover this current requirement.
AddCriteriaToCoverage	Adds a list of test criteria to the coverage.
AddSubjectToCoverage	Adds the tests from the specified subject that match the input filter to the list of tests that cover the current requirement.
AddTestInstanceToCoverage	Adds the test instance to the list of test instances that cover the current requirement.
AddTestsFromTestSetToCoverage	Adds the test instances from the specified test set that match the input filter to the list of test instances that cover the current requirement.
AddTestToCoverage	Adds the test to the list of tests that cover the current requirement.
AnalyzeAndSave	Do analysis, create analysis results and save testing levels for all child Req objects.
AnalyzeButDontSave	Do analysis, create analysis results, but do not save testing levels in children yet.
ApplyPolicyOnResultMatix	Use current policy matrix and re-apply it on the aggregated counts matrix to calculate total analyzed requirements duration.
AssessBILevel	Assess the Business Criticality risk level for this requirement, according to the values provided.
AssessFCLevel	Assess the Functional Complexity risk level for this requirement, according to the values provided.
AssessFPLevel	Assess the Failure Probability risk level for this requirement, according to the values provided.
CancelFollowUp	Removes the current entity's follow-up.
CleanAllAlerts	Removes all current object alerts from the database.
DeleteAlert	Removes an alert or alerts associated with the current object from the database.
GenerateRichContentHTMLDocument	Generate HTML document of the rich content data.
get_Icon	Returns the bitmap stream for the requirement's type.
GetAlert	Gets the alert specified by the alert ID.
GetAlertList	Gets a list of all alerts associated with the object.
GetCoverageTestConfigs	Returns the list of test configurations that cover the current requirement and, optionally, cover those of its children that match the requirement filter.
GetCoverageTestConfigsByTestIds	Returns the list of test configurations that cover the current requirement with filtered tests, and optionally, cover those of its descendents that match the requirement filter.
GetCoverageTestsByReqFilter	Returns the list of tests that cover the current requirement and, optionally, cover those of its children that match the requirement filter.
GetCoverList	Gets a list of the tests that cover this requirement.
GetCoverListByFilter	Gets the list of all tests that cover the current requirement and match the filter.
GetFollowUp	Gets the date and description for the follow-up associated with the current object.
HasAlerts	Checks if any alerts are associated with the object.
HasFollowUp	Checks if the object has at least one follow-up associated with it.
HasNewAlerts	New, unread alerts are associated with the object.
IsFollowUpOverdue	Checks if the date of the unsent follow-up is earlier than the current database server date.
LoadRichContent	Downloads rich content files.
LockObject	Locks the object. Returns True if the object has been changed on the server.
Mail	Mails the IBaseFieldExMail field item.
MailEx	Mails the IMailableEntity field item.
Move	Moves a requirement to being a child of a specified father in the requirements tree.
PopulateTargetCycleToChildren	Assigns the target cycle of the requirement as the target cycle of all child requirements, recursively down the folder tree.
PopulateTargetReleaseToChildren	Assigns the target release of the requirement as the target release of all child requirements, recursively down the folder tree.
Post	Posts all changed values into database.
Refresh	Reads saved values, overwriting values in memory.
RemoveCoverage	Removes a test from the list of tests that cover this requirement.
ResetPolicyToDefaults	Copy the policy from customization.
SaveRichContent	Uploads rich content files.
SetFollowUp	Sets an alert for follow-up for the current object.
Undo	Undoes changes to field values that have not been posted.
UnLockObject	Unlocks the object.

Public Properties

AnalysisFilter	The filter used for the Analysis.
AnalysisResultAggregatedRNDEffortsInHours	Time it would take RnD to handle this requirement, as simple aggregative addition of RND efforts set in children that were visited in last analysis.
AnalysisResultAnalyzedDurationInHours	Time it would take to test the requirements without CustomTestingLevel. That is, with the regular analyzed requirements, with this policy set in the related Risk-based Quality Management Analysis setup.
AnalysisResultCountCustomizedRequirements	Count of all child requirements visited in last analysis that their Testing Efforts were customized (not set by analysis).
AnalysisResultCountIgnoredRequirements	Count of all child requirements ignored in last analysis.
AnalysisResultCountNonCustomizedRequirements	For each possible risk (pair of Risk and FC levels) - return the total Count of child requirements that were visited in last analysis and that are assessed to be in this Risk (Pair), and their Efforts were not customized.
AnalysisResultCountUnanalyzableRequirements	Count of all child requirements visited in last analysis that could not be analyzed due to missing Assessment or incomplete custom effort.
AnalysisResultCustomizedDurationInHours	Time it would take to test the requirements with CustomTestingLevel with this policy set in the related Risk-based Quality Management Analysis setup.
AnalysisResultLastAnalysisDate	The Date/Time of the last analysis done on this parent requirement.
AnalyzedTestingEffortInHours	The testing effort determined by the last analysis.
AnalyzedTestingLevel	The testing level determined by the last analysis, from 'RBT Testing Levels' in LISTS.
AssessedBILevel	Business Criticality risk level for this requirement, from the last time we called AssessBILevel.
AssessedFCLevel	Functional Complexity risk level for this requirement, from the last time we called AssessBILevel.
AssessedFPLevel	Failure Probability risk level for this requirement, from the last time we called AssessFPLevel.
Attachments	The Attachment factory for the object.
Author	The name of the requirement author.
AutoPost	If true, the database is updated immediately when the field value changes.
AutoUnlock	Indicates whether to make the item changeable to other users automatically after a Refresh or Post.
AvailableTimeInHours	Available time for this Risk-based Quality Management Analysis.
BIChosenAnswerForQuestion	The chosen value to this Business Criticality criterion for this requirement.
BugLinkFactory	The bug link factory that manages the links of the current object to its associated defects.
CalculatedRiskLevel	Calculated Risk level for this requirement.
Comment	The comment associated with this requirement.
Count	The number of direct children.
CustomBILevel	Custom Business Criticality level, overrides the assessed level.
CustomFCLevel	Custom Functional Complexity level, overrides the assessed level.
CustomFPLevel	Custom Failure Probability level, overrides the assessed level.
CustomRiskLevel	Custom Risk level, overrides the assessed level.
CustomTestingEffortInHours	The custom testing effort.
CustomTestingLevel	The custom testing level supplied, from 'RBT Testing Levels' in LISTS.
DiagramFactory	Returns a diagram factory
EffectiveBILevel	Effective Business Criticality level.
EffectiveFCLevel	Effective Functional Complexitylevel.
EffectiveFPLevel	Effective Failure Probability level.
EffectiveRiskLevel	Effective Risk level.
FCChosenAnswerForQuestion	The chosen value to this Functional Complexity criterion for this requirement.
Field	The value of the specified field.
FieldMultiValue	The MultiValue object of the specified field.
FPChosenAnswerForQuestion	The chosen value to this Failure Probability criterion for this requirement.
FPLevelTestingEffortInHours	Obsolete. Returns E_NOTIMPL.
HasAttachment	Checks if the object has one or more attachments.
HasCoverage	The requirement is covered by at least one test.
HasLinkage	Checks if the current object has at least one associated Bug.
HasOthersLinkage	Checks if the current Bug object has at least one associated object that is not another Bug object. Defined only for Bug objects.
HasReqTraceability	Checks if the current requirement has at least one associated requirement in the specified direction.
HasRichContent	Checks if the object has rich content.
ID	The item ID.
IgnoreInAnalysis	Should this requirement be excluded in Risk-based Quality Management analysis?
IsAnalyzed	Checks whether the parent requirement has valid Risk-based Quality Management analysis result data.
IsFolder	No longer in use.
IsLocked	Checks if object is locked for editing.
LinkFactory	The link factory of the current defect object that enables viewing the links. Defined only for Bug objects.
Modified	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.
Name	The Requirement name as seen in the tree.
Paragraph	The paragraph number or numeration of the requirement.
ParentId	The Requirement's parent ID.
ParentRequirementForRBTAnalysis	The parent requirement for the current Risk-based Quality Management Analysis.
Path	The path of the node containing this requirement.
Priority	The requirement priority.
Product	The product name for which the requirement is set.
ReqTraceFactory	The requirement link factory that manages the traceability links of the current requirement to its associated requirements in the specified direction.
RequirementCoverageFactory	Get Requirement Coverage Factory.
RequirementType	Gets the interface for getting the requirement types.
Reviewed	The review status.
RnDEstimatedEffortInHours	The R&D effort.
Status	The status of the tests that cover this requirement.
TestingEffortForFCLevel	Hours needed to test a requirement with the given Functional Complexity.
TestingEffortInHoursFromPolicyMatrix	Calculated time needed to test a requirement in the given Risk and Functional Complexity, according to the current policy.
TestingLevelPercentage	Testing level percentage (of the full testing level).
TestingPolicyMatrix	Risk testing level matrix.
Type	The name of the requirement type.
TypeId	The requirement's type ID.
TypeName	The field's type.
UseCustomBILevel	Does this requirement have a custom Business Criticality level?
UseCustomFCLevel	Does this requirement have a custom Functional Complexity level?
UseCustomFPLevel	Does this requirement have a custom Failure Probability level?
UseCustomRiskLevel	Does this requirement have a custom Risk level?
UseCustomTLAndTE	Does this requirement have a custom Testing Level and Testing Effort?
VC	The version control object for the entity.
VersionData	The IVersionData of the entity.
Virtual	Checks if this is a virtual item, that is, an item that does not have a corresponding database record.

Send Help Center Feedback