ReqComponentInfo

Name ReqComponentInfo
Usage StatementService
translateReqComponentToNL getReqComponent getReqComponentsByType validateReqComponent createReqComponent updateReqComponent
StatementTreeViewInfo
Type Complex

Description

Information about a requirement component.
============== Deprecated ===============

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
desc Desc RichTextInfo Narrative description of the requirement component.     One No  
reqCompFields Req Comp Fields ReqCompFieldInfoList Detailed information about a requirement component field value.     Many No  
effectiveDate Effective Date Date Date and time that this requirement component became effective. This is a similar concept to the effective date on enumerated values. When an expiration date has been specified, this field must be less than or equal to the expiration date.     One No  
expirationDate Expiration Date Date Date and time that this requirement component expires. This is a similar concept to the expiration date on enumerated values. If specified, this must be greater than or equal to the effective date. If this field is not specified, then no expiration date has been currently defined and should automatically be considered greater than the effective date.     One No  
metaInfo Meta Info MetaInfo Create and last update info for the structure. This is optional and treated as read only since the data is set by the internals of the service during maintenance operations.     One No  
type Type String Unique identifier for a requirement component type.     One Yes  
state State String The current status of the requirement component. The values for this field are constrained to those in the reqComponentState enumeration. A separate setup operation does not exist for retrieval of the meta data around this value.     One Yes  
id Id String Unique identifier for a requirement component. This is optional, due to the identifier being set at the time of creation. Once the requirement component has been created, this should be seen as required.     One Yes  
naturalLanguageTranslation Natural Language Translation String naturalLanguageTranslation attribute is a read-only
attribute which is generated on-the-fly and should not be persisted.
    One Yes