Class StudyBase

Provides a base class with common informatino for Group and StudyUnit.

Inheritance
object
NotificationObject
IdentifiableBase
VersionableBase
StudyBase
Group
StudyUnit
Implements
Inherited Members
Namespace: Algenta.Colectica.Model.Ddi
Assembly: Algenta.Colectica.Model.Ddi.dll
Syntax
public abstract class StudyBase : VersionableBase, INotifyPropertyChanged, IVersionable, IIdentifiable, IHasCustomFields, IVisitable, IDescribable, IDublinCoreDescribable, IHasCoverage

Constructors

StudyBase()

Initializes a new instance of the StudyBase class.

Declaration
public StudyBase()

Properties

AnalysisUnits

Gets or sets the study's unit of analysis.

Declaration
[Display(GroupName = "Basic:Data", Order = 60)]
public ObservableCollection<CodeValue> AnalysisUnits { get; }
Property Value
Type Description
ObservableCollection<CodeValue>

AnalysisUnitsCovered

Gets a description of the analysis unit of this study.

Declaration
[Display(GroupName = "Basic:Data", Order = 61)]
public MultilingualString AnalysisUnitsCovered { get; }
Property Value
Type Description
MultilingualString

Archives

Gets the archives associated with the study.

Declaration
[Display(GroupName = "Misc", Order = 510)]
public ObservableCollection<Archive> Archives { get; }
Property Value
Type Description
ObservableCollection<Archive>

AuthorizationSources

Gets descriptions of the study's funding sources.

Declaration
[Display(GroupName = "Authorization Sources", Order = 400)]
public ObservableCollection<AuthorizationSource> AuthorizationSources { get; }
Property Value
Type Description
ObservableCollection<AuthorizationSource>

ChildTypesAccepted

Gets the child types that may be added to this item type.

Declaration
public override Collection<Guid> ChildTypesAccepted { get; }
Property Value
Type Description
Collection<Guid>

The child types that may be added to this item type.
Overrides

ClassificationFamilies

Gets a collection of classification families associated with the study.

Declaration
[Display(GroupName = "Misc", Order = 500)]
public ObservableCollection<ClassificationFamily> ClassificationFamilies { get; }
Property Value
Type Description
ObservableCollection<ClassificationFamily>

ConceptualComponents

Gets the Conceptual Components stored directly by the study. Consider using ResourcePackage to store Conceptual Components instead.

Declaration
[Display(GroupName = "Misc", Order = 500)]
public ObservableCollection<ConceptualComponent> ConceptualComponents { get; }
Property Value
Type Description
ObservableCollection<ConceptualComponent>

Coverage

Gets information about the different topics, areas, and times covered by a study.

Declaration
[Display(GroupName = "Coverage", Order = 450)]
public Coverage Coverage { get; set; }
Property Value
Type Description
Coverage

DataCollections

Gets the data collection modules of the study. Consider storing this information in ResourcePackage instead.

Declaration
[Display(GroupName = "Basic:Data Collection", Order = 200)]
public ObservableCollection<DataCollection> DataCollections { get; }
Property Value
Type Description
ObservableCollection<DataCollection>

DefiningConcept

Gets or set the concept that defines the study.

Declaration
[Display(Name = "Defining Concept", GroupName = "Basic", Order = 6)]
public Concept DefiningConcept { get; set; }
Property Value
Type Description
Concept

Description

Gets the description.

Declaration
[UIHint("hidden")]
public MultilingualString Description { get; }
Property Value
Type Description
MultilingualString

DisplayLabel

Gets the display label.

Declaration
public override string DisplayLabel { get; }
Property Value
Type Description
string
Overrides

DublinCoreMetadata

Gets or sets the Dublin Core citation of the study.

Declaration
[AlsoNotifyFor("DisplayLabel")]
[Display(GroupName = "Basic", Order = 1)]
public DublinCore DublinCoreMetadata { get; set; }
Property Value
Type Description
DublinCore

Embargos

Gets a collection of embargo descriptions.

Declaration
[Display(GroupName = "Misc", Order = 1000)]
public ObservableCollection<Embargo> Embargos { get; }
Property Value
Type Description
ObservableCollection<Embargo>

FundingSources

Gets descriptions of the study's funding sources.

Declaration
[Display(GroupName = "Funding", Order = 300)]
public ObservableCollection<FundingInformation> FundingSources { get; }
Property Value
Type Description
ObservableCollection<FundingInformation>

GeneralDataFormat

Gets or sets the general data formats documented The value may come from a controlled vocabulary.

Declaration
[Display(GroupName = "Basic:Data", Order = 62)]
public ObservableCollection<CodeValue> GeneralDataFormat { get; }
Property Value
Type Description
ObservableCollection<CodeValue>

InformationClassificationType

Gets or sets the type of information classification

Declaration
public CodeValue InformationClassificationType { get; set; }
Property Value
Type Description
CodeValue

InformationClassifications

Gets a collection of Information Classification associated with the study.

Declaration
[Display(GroupName = "Misc", Order = 500)]
public ObservableCollection<InformationClassification> InformationClassifications { get; }
Property Value
Type Description
ObservableCollection<InformationClassification>

ItemName

Gets the name of the item.

Declaration
[UIHint("hidden")]
public MultilingualString ItemName { get; }
Property Value
Type Description
MultilingualString

The name of the item.

KindsOfData

Gets or sets the type of data associated witth this study. The value may come from a controlled vocabulary.

Declaration
[Display(GroupName = "Basic:Data", Order = 62)]
public ObservableCollection<CodeValue> KindsOfData { get; }
Property Value
Type Description
ObservableCollection<CodeValue>

Label

Gets the label.

Declaration
[UIHint("hidden")]
public MultilingualString Label { get; }
Property Value
Type Description
MultilingualString

LevelOfInformationClassification

Gets or sets the level of information classification

Declaration
public CodeValue LevelOfInformationClassification { get; set; }
Property Value
Type Description
CodeValue

LogicalProducts

Gets the logical products that describe data. Consider using ResourcePackage to store items that can be described in a LogicalProduct.

Declaration
[Display(GroupName = "Misc", Order = 500)]
public ObservableCollection<LogicalProduct> LogicalProducts { get; }
Property Value
Type Description
ObservableCollection<LogicalProduct>

PhysicalInstanceTypes

Gets a dictionary containing type information for each data file that is associated with the study.

Declaration
[UIHint("hidden")]
public Dictionary<IdentifierTriple, string> PhysicalInstanceTypes { get; }
Property Value
Type Description
Dictionary<IdentifierTriple, string>

PhysicalInstances

Gets the data files associated with a study.

Declaration
[Display(GroupName = "Basic:Data", Order = 50)]
public ObservableCollection<PhysicalInstance> PhysicalInstances { get; }
Property Value
Type Description
ObservableCollection<PhysicalInstance>

PhysicalProducts

Gets the physical data descriptions. Consider using ResourcePackage to store these.

Declaration
[Display(GroupName = "Misc", Order = 500)]
public ObservableCollection<PhysicalProduct> PhysicalProducts { get; }
Property Value
Type Description
ObservableCollection<PhysicalProduct>

Purpose

Gets a description of the study's purpose.

Declaration
[Display(GroupName = "Basic", Order = 3)]
public MultilingualString Purpose { get; }
Property Value
Type Description
MultilingualString

QualityStatements

Gets a collection of quality statements associated with the study.

Declaration
[Display(GroupName = "Misc", Order = 500)]
public ObservableCollection<QualityStatement> QualityStatements { get; }
Property Value
Type Description
ObservableCollection<QualityStatement>

ResourcePackages

Gets a collection of ResourcePackages containing items referenced by the study.

Declaration
[Display(GroupName = "Misc", Order = 500)]
public ObservableCollection<ResourcePackage> ResourcePackages { get; }
Property Value
Type Description
ObservableCollection<ResourcePackage>

SeriesStatement

Gets an object that describes the series.

Declaration
[Display(GroupName = "Studies", Order = 500)]
public SeriesStatement SeriesStatement { get; set; }
Property Value
Type Description
SeriesStatement

StudyAbstract

Gets the study's abstract.

Declaration
[Display(Name = "Abstract", GroupName = "Basic", Order = 2)]
public MultilingualString StudyAbstract { get; }
Property Value
Type Description
MultilingualString

StudyUniverse

Gets or sets the study universe which describes the group of persons or other elements that are the object of reseasrch and to which any analytic results refer.

Declaration
[Display(Name = "Universe", GroupName = "Basic", Order = 5)]
public Universe StudyUniverse { get; set; }
Property Value
Type Description
Universe

TypeOfItem

Gets a description of the study's coded sub type.

Declaration
[Display(GroupName = "Basic", Order = 4)]
public CodeValue TypeOfItem { get; set; }
Property Value
Type Description
CodeValue

Methods

AcceptForBaseProperties(IVersionableVisitor)

Accepts for a visitor and passes it along to properties defined in this class.

Declaration
protected void AcceptForBaseProperties(IVersionableVisitor visitor)
Parameters
Type Name Description
IVersionableVisitor visitor

The visitor.

AddChild(IVersionable)

Adds the provided child to this item.

Declaration
public override void AddChild(IVersionable child)
Parameters
Type Name Description
IVersionable child

The item to be added as a child of this item.
Overrides
Exceptions
Type Condition
ArgumentNullException

child

GetChildren()

Gets the identifiers of the item's children.

Declaration
public override ChildItemCollection GetChildren()
Returns
Type Description
ChildItemCollection

The identifiers of the item's children.
Overrides

RemoveChild(IdentifierTriple)

Removes the specified child.

Declaration
public override int RemoveChild(IdentifierTriple child)
Parameters
Type Name Description
IdentifierTriple child

The child to be removed.
Returns
Type Description
int

The number of children removed from the item.
Overrides
Exceptions
Type Condition
ArgumentNullException

child

ReplaceChild(IdentifierTriple, IVersionable)

Replaces the child with the specified identifier with the provided item.

Declaration
public override 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
int

The number of children replaced.
Overrides
Exceptions
Type Condition
ArgumentNullException

child

WatchProperties()

Watch for property changed events

Declaration
protected override void WatchProperties()
Overrides

Implements

Extension Methods