Class ResponseDomain
Represents a type of data that can be collected by a Question.
Inheritance
Implements
Inherited Members
Namespace: Algenta.Colectica.Model.Ddi
Assembly: Algenta.Colectica.Model.Ddi.dll
Syntax
public abstract class ResponseDomain : NotificationObject, INotifyPropertyChanged
Constructors
ResponseDomain()
Initializes a new instance of the ResponseDomain class.
Declaration
protected ResponseDomain()
Properties
AttachedToCodes
If this ResponseDomain is only valid when certain codes from a previous CodeDomain have been selected, those Codes are referenced here.
Declaration
public ObservableCollection<IdentifierTriple> AttachedToCodes { get; }
Property Value
| Type | Description |
|---|---|
| ObservableCollection<IdentifierTriple> |
AttachedToValues
Links a reponse domain by value
Declaration
public ObservableCollection<DomainSpecificValue> AttachedToValues { get; set; }
Property Value
| Type | Description |
|---|---|
| ObservableCollection<DomainSpecificValue> |
Remarks
Prefer the attached to codes when possible.
BlankIsMissingValue
Gets or sets a value indicating whether a blank or empty response represents a missing value.
Declaration
public bool BlankIsMissingValue { get; set; }
Property Value
| Type | Description |
|---|---|
| Boolean |
|
ClassificationLevel
Gets or sets the classification level.
Declaration
public CategoryRelation ClassificationLevel { get; set; }
Property Value
| Type | Description |
|---|---|
| CategoryRelation |
Description
Gets the description.
Declaration
public MultilingualString Description { get; }
Property Value
| Type | Description |
|---|---|
| MultilingualString |
GenericOutputFormat
This field provides a recommended generic treatment of the data for display by an application.
Declaration
public CodeValue GenericOutputFormat { get; set; }
Property Value
| Type | Description |
|---|---|
| CodeValue |
GridAttachments
Part of the GridAttachment implementation. Colectica will serialize and deserialize this when the response domain is used in a QuestionGrid, but will not provide any display or user interaction with this information, except through the SDK. We consider this section of the standard ambiguous and do not recommend using it.
Declaration
public Collection<QuestionGridAttachment> GridAttachments { get; }
Property Value
| Type | Description |
|---|---|
| Collection<QuestionGridAttachment> |
Label
Gets the label.
Declaration
public MultilingualString Label { get; }
Property Value
| Type | Description |
|---|---|
| MultilingualString |
MeasurementUnit
This field provides the recommended measurement unit as of DDI 3.3
Declaration
public CodeValue MeasurementUnit { get; set; }
Property Value
| Type | Description |
|---|---|
| CodeValue |
MissingValues
Gets a list of values used to represent missing data in a space delimited array.
Declaration
public ObservableCollection<string> MissingValues { get; }
Property Value
| Type | Description |
|---|---|
| ObservableCollection<String> |
OutParameter
Gets or sets the out parameter that defines the data collected by the response domain.
Declaration
public Parameter OutParameter { get; set; }
Property Value
| Type | Description |
|---|---|
| Parameter |
RecommendedDataType
This field provides the recommended treatment of the data within an application.
Declaration
public CodeValue RecommendedDataType { get; set; }
Property Value
| Type | Description |
|---|---|
| CodeValue |
RepresentationType
Gets or sets the type of data represented.
Declaration
public RepresentationType RepresentationType { get; set; }
Property Value
| Type | Description |
|---|---|
| RepresentationType |
Methods
GetChildren()
Gets the identifiers of the item's children.
Declaration
public virtual ChildItemCollection GetChildren()
Returns
| Type | Description |
|---|---|
| ChildItemCollection | The identifiers of the item's children. |
RemoveChild(IdentifierTriple)
Removes the specified child.
Declaration
public virtual int RemoveChild(IdentifierTriple child)
Parameters
| Type | Name | Description |
|---|---|---|
| IdentifierTriple | child | The child to be removed. |
Returns
| Type | Description |
|---|---|
| Int32 | The number of children removed from the item. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | child |
ReplaceChild(IdentifierTriple, IVersionable)
Replaces the child with the specified identifier with the provided item.
Declaration
public virtual int ReplaceChild(IdentifierTriple toReplace, IVersionable child)
Parameters
| Type | Name | Description |
|---|---|---|
| IdentifierTriple | toReplace | The identifier of the child to replace. |
| IVersionable | child | The new child. |
Returns
| Type | Description |
|---|---|
| Int32 | The number of children replaced. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | child |