Show / Hide Table of Contents

Class DdiItemType

Defines identifiers for DDI 3 item types.

Inheritance
object
DdiItemType
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: Algenta.Colectica.Model.Ddi
Assembly: Algenta.Colectica.Model.Ddi.dll
Syntax
public static class DdiItemType

Properties

Archive

Gets the identifier for the Archive type.

Declaration
public static Guid Archive { get; }
Property Value
Type Description
Guid

Category

Gets the identifier for the Category type.

Declaration
public static Guid Category { get; }
Property Value
Type Description
Guid

CategoryGroup

Gets the identifier for the CategoryGroup type.

Declaration
public static Guid CategoryGroup { get; }
Property Value
Type Description
Guid

CategoryScheme

Gets the identifier for the CategoryScheme type.

Declaration
public static Guid CategoryScheme { get; }
Property Value
Type Description
Guid

ClassificationCorrespondenceTable

Gets the identifier for the ClassificationCorrespondenceTable type.

Declaration
public static Guid ClassificationCorrespondenceTable { get; }
Property Value
Type Description
Guid

ClassificationFamily

Gets the identifier for the ClassificationFamily type.

Declaration
public static Guid ClassificationFamily { get; }
Property Value
Type Description
Guid

ClassificationIndex

Gets the identifier for the ClassificationIndex type.

Declaration
public static Guid ClassificationIndex { get; }
Property Value
Type Description
Guid

ClassificationItem

Gets the identifier for the ClassificationItem type.

Declaration
public static Guid ClassificationItem { get; }
Property Value
Type Description
Guid

ClassificationLevel

Gets the identifier for the ClassificationLevel type.

Declaration
public static Guid ClassificationLevel { get; }
Property Value
Type Description
Guid

ClassificationSeries

Gets the identifier for the ClassificationSeries type.

Declaration
public static Guid ClassificationSeries { get; }
Property Value
Type Description
Guid

CodeList

Gets the identifier for the CodeList type.

Declaration
public static Guid CodeList { get; }
Property Value
Type Description
Guid

CodeListGroup

Gets the identifier for the CodeListGroup type.

Declaration
public static Guid CodeListGroup { get; }
Property Value
Type Description
Guid

CodeListScheme

Gets the identifier for the CodeListScheme type.

Declaration
public static Guid CodeListScheme { get; }
Property Value
Type Description
Guid

CompatItemTypes

Gets an enumeration of all item types that exist for purposes of DDI 3.1 or 3.2 compatibility.

Declaration
public static IEnumerable<Guid> CompatItemTypes { get; }
Property Value
Type Description
IEnumerable<Guid>

ComputationItem

Gets the identifier for the ComputationItem type.

Declaration
public static Guid ComputationItem { get; }
Property Value
Type Description
Guid

Concept

Gets the identifier for the Concept type.

Declaration
public static Guid Concept { get; }
Property Value
Type Description
Guid

ConceptGroup

Gets the identifier for the ConceptGroup type.

Declaration
public static Guid ConceptGroup { get; }
Property Value
Type Description
Guid

ConceptScheme

Gets the identifier for the ConceptScheme type.

Declaration
public static Guid ConceptScheme { get; }
Property Value
Type Description
Guid

ConceptualComponent

Gets the identifier for the ConceptualComponent type.

Declaration
public static Guid ConceptualComponent { get; }
Property Value
Type Description
Guid

ConceptualVariable

Gets the identifier for the ConceptualVariable type.

Declaration
public static Guid ConceptualVariable { get; }
Property Value
Type Description
Guid

ConceptualVariableGroup

Gets the identifier for the ConceptualVariableGroup type.

Declaration
public static Guid ConceptualVariableGroup { get; }
Property Value
Type Description
Guid

ConceptualVariableScheme

Gets the identifier for the ConceptualVariableScheme type.

Declaration
public static Guid ConceptualVariableScheme { get; }
Property Value
Type Description
Guid

ControlConstructGroup

Gets the identifier for the ControlConstructGroup type.

Declaration
public static Guid ControlConstructGroup { get; }
Property Value
Type Description
Guid

ControlConstructScheme

Gets the identifier for the ControlConstructScheme type.

Declaration
public static Guid ControlConstructScheme { get; }
Property Value
Type Description
Guid

DataCollection

Gets the identifier for the DataCollection type.

Declaration
public static Guid DataCollection { get; }
Property Value
Type Description
Guid

DataCollectionMethodology

Gets the identifier for the DataCollectionMethodology type.

Declaration
public static Guid DataCollectionMethodology { get; }
Property Value
Type Description
Guid

DataRelationship

Gets the identifier for the DataRelationship type.

Declaration
public static Guid DataRelationship { get; }
Property Value
Type Description
Guid

Ddi31ItemTypes

Gets an enumeration of all supported DDI 3.1 item types.

Declaration
public static IEnumerable<Guid> Ddi31ItemTypes { get; }
Property Value
Type Description
IEnumerable<Guid>

Ddi32ItemTypes

Gets an enumeration of all supported DDI 3.2 item types.

Declaration
public static IEnumerable<Guid> Ddi32ItemTypes { get; }
Property Value
Type Description
IEnumerable<Guid>

DdiInstance

Gets the identifier for the DdiInstance type.

Declaration
public static Guid DdiInstance { get; }
Property Value
Type Description
Guid

GeneralInstruction

Gets the identifier for the GeneralInstruction type.

Declaration
public static Guid GeneralInstruction { get; }
Property Value
Type Description
Guid

GenerationInstruction

Gets the identifier for the GenerationInstruction type.

Declaration
public static Guid GenerationInstruction { get; }
Property Value
Type Description
Guid

GeographicLocation

Gets the identifier for the GeographicLocation type.

Declaration
public static Guid GeographicLocation { get; }
Property Value
Type Description
Guid

GeographicLocationScheme

Gets the identifier for the GeographicLocationScheme type.

Declaration
public static Guid GeographicLocationScheme { get; }
Property Value
Type Description
Guid

Group

Gets the identifier for the StudyUnit type.

Declaration
public static Guid Group { get; }
Property Value
Type Description
Guid

IfThenElse

Gets the identifier for the IfThenElse type.

Declaration
public static Guid IfThenElse { get; }
Property Value
Type Description
Guid

Individual

Gets the identifier for the Individual type.

Declaration
public static Guid Individual { get; }
Property Value
Type Description
Guid

InformationClassification

Gets the identifier for the InformationClassification type.

Declaration
public static Guid InformationClassification { get; }
Property Value
Type Description
Guid

Instruction

Gets the identifier for the Instruction type.

Declaration
public static Guid Instruction { get; }
Property Value
Type Description
Guid

InstructionGroup

Gets the identifier for the InstructionGroup type.

Declaration
public static Guid InstructionGroup { get; }
Property Value
Type Description
Guid

Instrument

Gets the identifier for the Instrument type.

Declaration
public static Guid Instrument { get; }
Property Value
Type Description
Guid

InstrumentGroup

Gets the identifier for the InstrumentGroup type.

Declaration
public static Guid InstrumentGroup { get; }
Property Value
Type Description
Guid

InstrumentScheme

Gets the identifier for the InstrumentScheme type.

Declaration
public static Guid InstrumentScheme { get; }
Property Value
Type Description
Guid

InterviewerInstructionScheme

Gets the identifier for the InterviewerInstructionScheme type.

Declaration
public static Guid InterviewerInstructionScheme { get; }
Property Value
Type Description
Guid

ItemTypes

Gets an enumeration of all supported DDI 3.3 item types.

Declaration
public static IEnumerable<Guid> ItemTypes { get; }
Property Value
Type Description
IEnumerable<Guid>

LogicalProduct

Gets the identifier for the LogicalProduct type.

Declaration
public static Guid LogicalProduct { get; }
Property Value
Type Description
Guid

LogicalRecord

Gets the identifier for the LogicalRecord type.

Declaration
public static Guid LogicalRecord { get; }
Property Value
Type Description
Guid

Loop

Gets the identifier for the Loop type.

Declaration
public static Guid Loop { get; }
Property Value
Type Description
Guid

ManagedDateTimeRepresentation

Gets the identifier for the ManagedDateTimeRepresentation type.

Declaration
public static Guid ManagedDateTimeRepresentation { get; }
Property Value
Type Description
Guid

ManagedMissingValuesRepresentation

Gets the identifier for the ManagedMissingValuesRepresentation type.

Declaration
public static Guid ManagedMissingValuesRepresentation { get; }
Property Value
Type Description
Guid

ManagedNumericRepresentation

Gets the identifier for the ManagedNumericRepresentation type.

Declaration
public static Guid ManagedNumericRepresentation { get; }
Property Value
Type Description
Guid

ManagedRepresentationGroup

Gets the identifier for the ManagedRepresentationGroup type.

Declaration
public static Guid ManagedRepresentationGroup { get; }
Property Value
Type Description
Guid

ManagedRepresentationScheme

Gets the identifier for the ManagedRepresentationScheme type.

Declaration
public static Guid ManagedRepresentationScheme { get; }
Property Value
Type Description
Guid

ManagedScaleRepresentation

Gets the identifier for the ManagedScaleRepresentation type.

Declaration
public static Guid ManagedScaleRepresentation { get; }
Property Value
Type Description
Guid

ManagedTextRepresentation

Gets the identifier for the ManagedTextRepresentation type.

Declaration
public static Guid ManagedTextRepresentation { get; }
Property Value
Type Description
Guid

MeasurementConstruct

Gets the identifier for the MeasurementItem type.

Declaration
public static Guid MeasurementConstruct { get; }
Property Value
Type Description
Guid

MeasurementItem

Gets the identifier for the MeasurementItem type.

Declaration
public static Guid MeasurementItem { get; }
Property Value
Type Description
Guid

NCube

Gets the identifier for the NCube type.

Declaration
public static Guid NCube { get; }
Property Value
Type Description
Guid

NCubeGroup

Gets the identifier for the NCubeGroup type.

Declaration
public static Guid NCubeGroup { get; }
Property Value
Type Description
Guid

NCubeScheme

Gets the identifier for the NCubeScheme type.

Declaration
public static Guid NCubeScheme { get; }
Property Value
Type Description
Guid

Organization

Gets the identifier for the Organization type.

Declaration
public static Guid Organization { get; }
Property Value
Type Description
Guid

OrganizationGroup

Gets the identifier for the OrganizationGroup type.

Declaration
public static Guid OrganizationGroup { get; }
Property Value
Type Description
Guid

OrganizationScheme

Gets the identifier for the OrganizationScheme type.

Declaration
public static Guid OrganizationScheme { get; }
Property Value
Type Description
Guid

OtherMaterial

Gets the identifier for the OtherMaterial type.

Declaration
public static Guid OtherMaterial { get; }
Property Value
Type Description
Guid

OtherMaterialGroup

Gets the identifier for the OtherMaterialGroup type.

Declaration
public static Guid OtherMaterialGroup { get; }
Property Value
Type Description
Guid

OtherMaterialScheme

Gets the identifier for the OtherMaterialScheme type.

Declaration
public static Guid OtherMaterialScheme { get; }
Property Value
Type Description
Guid

PhysicalDataProduct

Gets the identifier for the PhysicalDataProduct type.

Declaration
public static Guid PhysicalDataProduct { get; }
Property Value
Type Description
Guid

PhysicalInstance

Gets the identifier for the PhysicalInstance type.

Declaration
public static Guid PhysicalInstance { get; }
Property Value
Type Description
Guid

PhysicalStructure

Gets the identifier for the PhysicalStructure type.

Declaration
public static Guid PhysicalStructure { get; }
Property Value
Type Description
Guid

PhysicalStructureScheme

Gets the identifier for the PhysicalStructureScheme type.

Declaration
public static Guid PhysicalStructureScheme { get; }
Property Value
Type Description
Guid

ProcessingEvent

Gets the identifier for the ProcessingEvent type.

Declaration
public static Guid ProcessingEvent { get; }
Property Value
Type Description
Guid

ProcessingEventGroup

Gets the identifier for the ProcessingEventScheme type.

Declaration
public static Guid ProcessingEventGroup { get; }
Property Value
Type Description
Guid

ProcessingEventScheme

Gets the identifier for the ProcessingEventScheme type.

Declaration
public static Guid ProcessingEventScheme { get; }
Property Value
Type Description
Guid

ProcessingInstructionGroup

Gets the identifier for the ProcessingInstructionScheme type.

Declaration
public static Guid ProcessingInstructionGroup { get; }
Property Value
Type Description
Guid

ProcessingInstructionScheme

Gets the identifier for the ProcessingInstructionScheme type.

Declaration
public static Guid ProcessingInstructionScheme { get; }
Property Value
Type Description
Guid

QualityStandard

Gets the identifier for the QualityStandard type.

Declaration
public static Guid QualityStandard { get; }
Property Value
Type Description
Guid

QualityStatement

Gets the identifier for the QualityStatement type.

Declaration
public static Guid QualityStatement { get; }
Property Value
Type Description
Guid

QualityStatementGroup

Gets the identifier for the QualityStatementGroup type.

Declaration
public static Guid QualityStatementGroup { get; }
Property Value
Type Description
Guid

QualityStatementScheme

Gets the identifier for the QualityStatementScheme type.

Declaration
public static Guid QualityStatementScheme { get; }
Property Value
Type Description
Guid

QuestionBlock

Gets the identifier for the QuestionBlock type.

Declaration
public static Guid QuestionBlock { get; }
Property Value
Type Description
Guid

QuestionConstruct

Gets the identifier for the QuestionConstruct type.

Declaration
public static Guid QuestionConstruct { get; }
Property Value
Type Description
Guid

QuestionGrid

Gets the identifier for the QuestionGrid type.

Declaration
public static Guid QuestionGrid { get; }
Property Value
Type Description
Guid

QuestionGroup

Gets the identifier for the QuestionGroup type.

Declaration
public static Guid QuestionGroup { get; }
Property Value
Type Description
Guid

QuestionItem

Gets the identifier for the QuestionItem type.

Declaration
public static Guid QuestionItem { get; }
Property Value
Type Description
Guid

QuestionScheme

Gets the identifier for the QuestionScheme type.

Declaration
public static Guid QuestionScheme { get; }
Property Value
Type Description
Guid

RecordLayout

Gets the identifier for the RecordLayout type.

Declaration
public static Guid RecordLayout { get; }
Property Value
Type Description
Guid

RecordLayoutScheme

Gets the identifier for the RecordLayoutScheme type.

Declaration
public static Guid RecordLayoutScheme { get; }
Property Value
Type Description
Guid

RecordRelationship

Gets the identifier for the RecordRelationship type.

Declaration
public static Guid RecordRelationship { get; }
Property Value
Type Description
Guid

RepeatUntil

Gets the identifier for the RepeatUntil type.

Declaration
public static Guid RepeatUntil { get; }
Property Value
Type Description
Guid

RepeatWhile

Gets the identifier for the RepeatWhile type.

Declaration
public static Guid RepeatWhile { get; }
Property Value
Type Description
Guid

RepresentedVariable

Gets the identifier for the RepresentedVariable type.

Declaration
public static Guid RepresentedVariable { get; }
Property Value
Type Description
Guid

RepresentedVariableGroup

Gets the identifier for the RepresentedVariableGroup type.

Declaration
public static Guid RepresentedVariableGroup { get; }
Property Value
Type Description
Guid

RepresentedVariableScheme

Gets the identifier for the RepresentedVariableScheme type.

Declaration
public static Guid RepresentedVariableScheme { get; }
Property Value
Type Description
Guid

ResourcePackage

Gets the identifier for the ResourcePackage type.

Declaration
public static Guid ResourcePackage { get; }
Property Value
Type Description
Guid

Sequence

Gets the identifier for the Sequence type.

Declaration
public static Guid Sequence { get; }
Property Value
Type Description
Guid

StatementItem

Gets the identifier for the StatementItem type.

Declaration
public static Guid StatementItem { get; }
Property Value
Type Description
Guid

StatisticalClassification

Gets the identifier for the StatisticalClassification type.

Declaration
public static Guid StatisticalClassification { get; }
Property Value
Type Description
Guid

StudyUnit

Gets the identifier for the StudyUnit type.

Declaration
public static Guid StudyUnit { get; }
Property Value
Type Description
Guid

SubGroup

Gets the identifier for the StudyUnit type.

Declaration
public static Guid SubGroup { get; }
Property Value
Type Description
Guid

UnitType

Gets the identifier for the UnitType type.

Declaration
public static Guid UnitType { get; }
Property Value
Type Description
Guid

UnitTypeGroup

Gets the identifier for the UnitTypeGroup type.

Declaration
public static Guid UnitTypeGroup { get; }
Property Value
Type Description
Guid

UnitTypeScheme

Gets the identifier for the UnitTypeScheme type.

Declaration
public static Guid UnitTypeScheme { get; }
Property Value
Type Description
Guid

Universe

Gets the identifier for the Universe type.

Declaration
public static Guid Universe { get; }
Property Value
Type Description
Guid

UniverseGroup

Gets the identifier for the UniverseGroup type.

Declaration
public static Guid UniverseGroup { get; }
Property Value
Type Description
Guid

UniverseScheme

Gets the identifier for the UniverseScheme type.

Declaration
public static Guid UniverseScheme { get; }
Property Value
Type Description
Guid

Variable

Gets the identifier for the Variable type.

Declaration
public static Guid Variable { get; }
Property Value
Type Description
Guid

VariableGroup

Gets the identifier for the VariableGroup type.

Declaration
public static Guid VariableGroup { get; }
Property Value
Type Description
Guid

VariableScheme

Gets the identifier for the VariableScheme type.

Declaration
public static Guid VariableScheme { get; }
Property Value
Type Description
Guid

VariableStatistic

Gets the identifier for the VariableStatistic type.

Declaration
public static Guid VariableStatistic { get; }
Property Value
Type Description
Guid

WeightingMethodology

Gets the identifier for the DataColleWeightingMethodologyctionMethodology type.

Declaration
public static Guid WeightingMethodology { get; }
Property Value
Type Description
Guid

Methods

GetEnglishPluralLabelForItemType(Guid)

Gets a plural display label for the specified type, in English.

Declaration
public static string GetEnglishPluralLabelForItemType(Guid itemType)
Parameters
Type Name Description
Guid itemType

The type identifier.

Returns
Type Description
string

GetLabelForItemType(Guid)

Gets a display label for the specified item type.

Declaration
public static string GetLabelForItemType(Guid itemType)
Parameters
Type Name Description
Guid itemType

The type identifer.

Returns
Type Description
string

The display label for the specified item type.

GetParentTypes(Guid)

Gets an array of item types that may reference the specified item type.

Declaration
public static Guid[] GetParentTypes(Guid itemType)
Parameters
Type Name Description
Guid itemType

The item type.

Returns
Type Description
Guid[]

An array of item types that may reference the specified item type.

GetPluralLabelForItemType(Guid)

Gets a plural display label for the specified type.

Declaration
public static string GetPluralLabelForItemType(Guid itemType)
Parameters
Type Name Description
Guid itemType

The type identifier.

Returns
Type Description
string

GetReferencedTypes(Guid)

Gets an array of item types that may be referenced by the specified item type.

Declaration
public static Guid[] GetReferencedTypes(Guid itemType)
Parameters
Type Name Description
Guid itemType

The item type.

Returns
Type Description
Guid[]

An array of item types that may be referenced by the specified item type.

GetSortOrder(Guid)

Gets the sort order for the specified type, to be used in comparison methods.

Declaration
public static int GetSortOrder(Guid itemType)
Parameters
Type Name Description
Guid itemType

The type identifier.

Returns
Type Description
int

GetTypeForItemType(Guid)

Gets the .NET Type used to instantiate the speciifed item type.

Declaration
public static Type GetTypeForItemType(Guid itemType)
Parameters
Type Name Description
Guid itemType

The item type.

Returns
Type Description
Type

The .NET Type used ot instantiate the item type.

SupportsItemType(Guid)

Gets a value indicating whether the specified item type is supported by this class.

Declaration
public static bool SupportsItemType(Guid itemType)
Parameters
Type Name Description
Guid itemType

The item type.

Returns
Type Description
bool

true if the item type is supported by this class; otherwise false.

SupportsItemType(Guid, Guid)

Gets a value indicating whether the specified item type is supported by this class in a specific format.

Declaration
public static bool SupportsItemType(Guid itemType, Guid repositoryFormat)
Parameters
Type Name Description
Guid itemType

The item type.

Guid repositoryFormat

Repository storage format

Returns
Type Description
bool

true if the item type is supported by this class; otherwise false.

TryGetDdiNameOfType(string, out Guid)

Gets the item type corresponding to the specified DDI schema type.

Declaration
public static bool TryGetDdiNameOfType(string stringType, out Guid itemType)
Parameters
Type Name Description
string stringType

The DDI schema type.

Guid itemType

The item type.

Returns
Type Description
bool

true if the item type was successfully located; otherwise false.

TryGetDdiTypeOfObject(Guid, out string)

Gets the DDI schema type corresponding to the specified item type.

Declaration
public static bool TryGetDdiTypeOfObject(Guid itemType, out string stringType)
Parameters
Type Name Description
Guid itemType

The item type.

string stringType

The DDI schema type.

Returns
Type Description
bool

true if the item type was successfully located; otherwise false.

TryGetDdiTypeOfObject33(Guid, out string)

Gets the DDI schema type corresponding to the specified item type.

Declaration
public static bool TryGetDdiTypeOfObject33(Guid itemType, out string stringType)
Parameters
Type Name Description
Guid itemType

The item type.

string stringType

The DDI schema type.

Returns
Type Description
bool

true if the item type was successfully located; otherwise false.

TryGetImageNameForItemType16(Guid, out string)

Gets the name of a 16x16 image used to represent the specified item type.

Declaration
public static bool TryGetImageNameForItemType16(Guid itemType, out string imageName)
Parameters
Type Name Description
Guid itemType

The item type.

string imageName

The name of the 16x16 image.

Returns
Type Description
bool

true if the image name was successfully located; otherwise false.

TryGetImageNameForItemType32(Guid, out string)

Gets the name of a 32x32 image used to represent the specified item type.

Declaration
public static bool TryGetImageNameForItemType32(Guid itemType, out string imageName)
Parameters
Type Name Description
Guid itemType

The item type.

string imageName

The name of the 32x32 image.

Returns
Type Description
bool

true if the image name was successfully located; otherwise false.

TryGetSchemaTypeForItemType(Guid, out string)

Gets the DDI schema type that corresponds to the specified item type.

Declaration
public static bool TryGetSchemaTypeForItemType(Guid itemType, out string schemaType)
Parameters
Type Name Description
Guid itemType

The item type.

string schemaType

The corresponding DDI schema type.

Returns
Type Description
bool

true if the schema type was successfully located; otherwise false.

TryGetTypeForSchemaType(string, out Guid)

Gets the item type corresponding to the specified DDI schema type.

Declaration
public static bool TryGetTypeForSchemaType(string schemaLocalName, out Guid itemType)
Parameters
Type Name Description
string schemaLocalName

The name of the type in the DDI schema.

Guid itemType

The item type.

Returns
Type Description
bool

true if the item type was successfully located; otherwise false.

In this article
Back to top Generated by DocFX