Req Object
Members 
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
Public Method AddAlert Adds a new alert to the specified entity.
Public Method AddConfigurationsToCoverage Adds a list of test configurations to the coverage.
Public Method AddCoverage Assigns a test to cover this requirement.
Public Method AddCoverageByFilter Adds the tests from the specified subject that match the input filter to the list of tests that cover the current requirement.
Public Method AddCoverageEx Assigns all the tests in the specified subject folder to cover this current requirement.
Public Method AddCriteriaToCoverage Adds a list of test criteria to the coverage.
Public Method AddSubjectToCoverage Adds the tests from the specified subject that match the input filter to the list of tests that cover the current requirement.
Public Method AddTestInstanceToCoverage Adds the test instance to the list of test instances that cover the current requirement.
Public Method 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.
Public Method AddTestToCoverage Adds the test to the list of tests that cover the current requirement.
Public Method AnalyzeAndSave Do analysis, create analysis results and save testing levels for all child Req objects.
Public Method AnalyzeButDontSave Do analysis, create analysis results, but do not save testing levels in children yet.
Public Method ApplyPolicyOnResultMatix Use current policy matrix and re-apply it on the aggregated counts matrix to calculate total analyzed requirements duration.
Public Method AssessBILevel Assess the Business Criticality risk level for this requirement, according to the values provided.
Public Method AssessFCLevel Assess the Functional Complexity risk level for this requirement, according to the values provided.
Public Method AssessFPLevel Assess the Failure Probability risk level for this requirement, according to the values provided.
Public Method CancelFollowUp Removes the current entity's follow-up.
Public Method CleanAllAlerts Removes all current object alerts from the database.
Public Method DeleteAlert Removes an alert or alerts associated with the current object from the database.
Public Method GenerateRichContentHTMLDocument Generate HTML document of the rich content data.
Public Method get_Icon Returns the bitmap stream for the requirement's type.
Public Method GetAlert Gets the alert specified by the alert ID.
Public Method GetAlertList Gets a list of all alerts associated with the object.
Public Method GetCoverageTestConfigs Returns the list of test configurations that cover the current requirement and, optionally, cover those of its children that match the requirement filter.
Public Method 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.
Public Method GetCoverageTestsByReqFilter Returns the list of tests that cover the current requirement and, optionally, cover those of its children that match the requirement filter.
Public Method GetCoverList Gets a list of the tests that cover this requirement.
Public Method GetCoverListByFilter Gets the list of all tests that cover the current requirement and match the filter.
Public Method GetFollowUp Gets the date and description for the follow-up associated with the current object.
Public Method HasAlerts Checks if any alerts are associated with the object.
Public Method HasFollowUp Checks if the object has at least one follow-up associated with it.
Public Method HasNewAlerts New, unread alerts are associated with the object.
Public Method IsFollowUpOverdue Checks if the date of the unsent follow-up is earlier than the current database server date.
Public Method LoadRichContent Downloads rich content files.
Public Method LockObject Locks the object. Returns True if the object has been changed on the server.
Public Method Mail Mails the IBaseFieldExMail field item.
Public Method MailEx Mails the IMailableEntity field item.
Public Method Move Moves a requirement to being a child of a specified father in the requirements tree.
Public Method PopulateTargetCycleToChildren Assigns the target cycle of the requirement as the target cycle of all child requirements, recursively down the folder tree.
Public Method PopulateTargetReleaseToChildren Assigns the target release of the requirement as the target release of all child requirements, recursively down the folder tree.
Public Method Post Posts all changed values into database.
Public Method Refresh Reads saved values, overwriting values in memory.
Public Method RemoveCoverage Removes a test from the list of tests that cover this requirement.
Public Method ResetPolicyToDefaults Copy the policy from customization.
Public Method SaveRichContent Uploads rich content files.
Public Method SetFollowUp Sets an alert for follow-up for the current object.
Public Method Undo Undoes changes to field values that have not been posted.
Public Method UnLockObject Unlocks the object.
Public Properties
Public Property AnalysisFilter The filter used for the Analysis.
Public Property 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.
Public Property 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.
Public Property AnalysisResultCountCustomizedRequirements Count of all child requirements visited in last analysis that their Testing Efforts were customized (not set by analysis).
Public Property AnalysisResultCountIgnoredRequirements Count of all child requirements ignored in last analysis.
Public Property 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.
Public Property AnalysisResultCountUnanalyzableRequirements Count of all child requirements visited in last analysis that could not be analyzed due to missing Assessment or incomplete custom effort.
Public Property AnalysisResultCustomizedDurationInHours Time it would take to test the requirements with CustomTestingLevel with this policy set in the related Risk-based Quality Management Analysis setup.
Public Property AnalysisResultLastAnalysisDate The Date/Time of the last analysis done on this parent requirement.
Public Property AnalyzedTestingEffortInHours The testing effort determined by the last analysis.
Public Property AnalyzedTestingLevel The testing level determined by the last analysis, from 'RBT Testing Levels' in LISTS.
Public Property AssessedBILevel Business Criticality risk level for this requirement, from the last time we called AssessBILevel.
Public Property AssessedFCLevel Functional Complexity risk level for this requirement, from the last time we called AssessBILevel.
Public Property AssessedFPLevel Failure Probability risk level for this requirement, from the last time we called AssessFPLevel.
Public Property Attachments The Attachment factory for the object.
Public Property Author The name of the requirement author.
Public Property AutoPost If true, the database is updated immediately when the field value changes.
Public Property AutoUnlock Indicates whether to make the item changeable to other users automatically after a Refresh or Post.
Public Property AvailableTimeInHours Available time for this Risk-based Quality Management Analysis.
Public Property BIChosenAnswerForQuestion The chosen value to this Business Criticality criterion for this requirement.
Public Property BugLinkFactory The bug link factory that manages the links of the current object to its associated defects.
Public Property CalculatedRiskLevel Calculated Risk level for this requirement.
Public Property Comment The comment associated with this requirement.
Public Property Count The number of direct children.
Public Property CustomBILevel Custom Business Criticality level, overrides the assessed level.
Public Property CustomFCLevel Custom Functional Complexity level, overrides the assessed level.
Public Property CustomFPLevel Custom Failure Probability level, overrides the assessed level.
Public Property CustomRiskLevel Custom Risk level, overrides the assessed level.
Public Property CustomTestingEffortInHours The custom testing effort.
Public Property CustomTestingLevel The custom testing level supplied, from 'RBT Testing Levels' in LISTS.
Public Property DiagramFactory Returns a diagram factory
Public Property EffectiveBILevel Effective Business Criticality level.
Public Property EffectiveFCLevel Effective Functional Complexitylevel.
Public Property EffectiveFPLevel Effective Failure Probability level.
Public Property EffectiveRiskLevel Effective Risk level.
Public Property FCChosenAnswerForQuestion The chosen value to this Functional Complexity criterion for this requirement.
Public Property Field The value of the specified field.
Public Property FieldMultiValue The MultiValue object of the specified field.
Public Property FPChosenAnswerForQuestion The chosen value to this Failure Probability criterion for this requirement.
Public Property FPLevelTestingEffortInHours Obsolete. Returns E_NOTIMPL.
Public Property HasAttachment Checks if the object has one or more attachments.
Public Property HasCoverage The requirement is covered by at least one test.
Public Property HasLinkage Checks if the current object has at least one associated Bug.
Public Property HasOthersLinkage Checks if the current Bug object has at least one associated object that is not another Bug object. Defined only for Bug objects.
Public Property HasReqTraceability Checks if the current requirement has at least one associated requirement in the specified direction.
Public Property HasRichContent Checks if the object has rich content.
Public Property ID The item ID.
Public Property IgnoreInAnalysis Should this requirement be excluded in Risk-based Quality Management analysis?
Public Property IsAnalyzed Checks whether the parent requirement has valid Risk-based Quality Management analysis result data.
Public Property IsFolder No longer in use.
Public Property IsLocked Checks if object is locked for editing.
Public Property LinkFactory The link factory of the current defect object that enables viewing the links. Defined only for Bug objects.
Public Property 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.
Public Property Name The Requirement name as seen in the tree.
Public Property Paragraph The paragraph number or numeration of the requirement.
Public Property ParentId The Requirement's parent ID.
Public Property ParentRequirementForRBTAnalysis The parent requirement for the current Risk-based Quality Management Analysis.
Public Property Path The path of the node containing this requirement.
Public Property Priority The requirement priority.
Public Property Product The product name for which the requirement is set.
Public Property ReqTraceFactory The requirement link factory that manages the traceability links of the current requirement to its associated requirements in the specified direction.
Public Property RequirementCoverageFactory Get Requirement Coverage Factory.
Public Property RequirementType Gets the interface for getting the requirement types.
Public Property Reviewed The review status.
Public Property RnDEstimatedEffortInHours The R&D effort.
Public Property Status The status of the tests that cover this requirement.
Public Property TestingEffortForFCLevel Hours needed to test a requirement with the given Functional Complexity.
Public Property TestingEffortInHoursFromPolicyMatrix Calculated time needed to test a requirement in the given Risk and Functional Complexity, according to the current policy.
Public Property TestingLevelPercentage Testing level percentage (of the full testing level).
Public Property TestingPolicyMatrix Risk testing level matrix.
Public Property Type The name of the requirement type.
Public Property TypeId The requirement's type ID.
Public Property TypeName The field's type.
Public Property UseCustomBILevel Does this requirement have a custom Business Criticality level?
Public Property UseCustomFCLevel Does this requirement have a custom Functional Complexity level?
Public Property UseCustomFPLevel Does this requirement have a custom Failure Probability level?
Public Property UseCustomRiskLevel Does this requirement have a custom Risk level?
Public Property UseCustomTLAndTE Does this requirement have a custom Testing Level and Testing Effort?
Public Property VC The version control object for the entity.
Public Property VersionData The IVersionData of the entity.
Public Property Virtual Checks if this is a virtual item, that is, an item that does not have a corresponding database record.
See Also