complexType "VersionableType" | DDI-Lifecycle 3.3 XML Schema Documentation (2020-01-15)

complexType "VersionableType"

Namespace:	ddi:reusable:3_3
Content:	complex, 7 attributes, 12 elements
Abstract:	(cannot be assigned directly to elements used in instance XML documents)
Defined:	globally in reusable.xsd; see XML source
Includes:	definitions of 1 attribute, 1 element
Used:	at 72 locations

XML Representation Summary

<...

inheritanceAction	=	("Add" \| "Update" \| "Delete")
objectSource	=	(xs:string \| xs:string)
scopeOfUniqueness	=	("Agency" \| "Maintainable") : "Agency"
isUniversallyUnique	=	xs:boolean
versionDate	=	(xs:dateTime \| xs:date \| xs:gYearMonth \| xs:gYear \| xs:duration)
isPublished	=	xs:boolean : "false"
isVersionable	=	"true"

>

Content:

(URN | (Agency, ID, Version))[1..2], UserID*, UserAttributePair*, (VersionResponsibility | VersionResponsibilityReference)?, VersionRationale?, BasedOnObject?, RelatedOtherMaterialReference*, MaintainableObject?

</...>

Known Direct Subtypes (72):

AgentType, ApprovalReviewType, BaseRecordLayoutType, CategoryGroupType, CategoryType, CodeListGroupType, ConceptGroupType, ConceptType, ConceptualVariableGroupType, ConceptualVariableType, ControlConstructGroupType, ControlConstructType, DataCaptureDevelopmentType, DataRelationshipType, DescribableType, DevelopmentActivityGroupType, DevelopmentActivityType, DevelopmentImplementationType, DevelopmentPlanType, DevelopmentResultsType, GenericMapType, GeographicLocationGroupType, GeographicLocationType, GeographicStructureGroupType, GeographicStructureType, InstructionGroupType, InstructionType, InstrumentGroupType, InstrumentType, ManagedRepresentationGroupType, ManagedRepresentationType, MeasurementGroupType, MeasurementItemType, MethodologyType, NCubeGroupType, NCubeInstanceType, NCubeInstanceType, NCubeInstanceType, NCubeType, OrganizationGroupType, OtherMaterialGroupType, OtherMaterialType, PhysicalStructureGroupType, PhysicalStructureType, ProcessingEventGroupType, ProcessingEventType, ProcessingInstructionGroupType, ProcessingInstructionType, QualityStandardGroupType, QualityStandardType, QualityStatementGroupType, QualityStatementType, QuestionGroupType, QuestionType, RecordLayoutGroupType, RelationType, RepresentationMapType, RepresentedVariableGroupType, RepresentedVariableType, SampleFrameType, SampleType, SamplingInformationGroupType, SamplingPlanType, SubUniverseClassType, UnitTypeGroupType, UniverseGroupType, UniverseType, VariableGroupType, VariableStatisticsType, VariableType, WeightingMethodologyType, WeightingType

Known Indirect Subtypes (46):

ClassificationCorrespondenceTableType, ClassificationIndexType, ClassificationItemType, ClassificationLevelType, ClassificationSeriesType, CognitiveExpertReviewActivityType, CognitiveInterviewActivityType, ComputationItemType, ContentReviewActivityType, DataSetType, DevelopmentStepType, FocusGroupActivityType, GeneralInstructionType, GenerationInstructionType, IfThenElseType, IndividualType, InformationClassificationType, LoopType, ManagedDateTimeRepresentationType, ManagedMissingValuesRepresentationType, ManagedNumericRepresentationType, ManagedScaleRepresentationType, ManagedTextRepresentationType, MeasurementConstructType, OrganizationType, PretestActivityType, QuestionBlockType, QuestionConstructType, QuestionGridType, QuestionItemType, RecordLayoutType, RecordLayoutType, RecordLayoutType, RecordLayoutType, RecordLayoutType, RepeatUntilType, RepeatWhileType, SampleStepType, SamplingStageType, SequenceType, SplitJoinType, SplitType, StatementItemType, StatisticalClassificationType, TranslationActivityType, UnitTypeType

All Direct / Indirect Based Elements (122):

ApprovalReview, ApprovalReviewDocument, BaseRecordLayout, Category, CategoryGroup, CategoryMap, ClassificationCorrespondenceTable, ClassificationIndex, ClassificationItem, ClassificationLevel, ClassificationSeries, CodeListGroup, CognitiveExpertReviewActivity, CognitiveInterviewActivity, ComputationItem, Concept, ConceptGroup, ConceptMap, ConceptualVariable, ConceptualVariableGroup, ContentReviewActivity, ControlConstruct, ControlConstructGroup, DataCaptureDevelopment, DataRelationship, DataSet, DevelopmentActivity, DevelopmentActivityGroup, DevelopmentImplementation, DevelopmentPlan, DevelopmentResults, DevelopmentStep, FocusGroupActivity, FundingDocument, GeneralInstruction, GenerationInstruction, GeographicLocation, GeographicLocationGroup, GeographicStructure, GeographicStructureGroup, IfThenElse, Individual, InformationClassification, Instruction, InstructionGroup, Instrument, InstrumentGroup, Loop, ManagedDateTimeRepresentation, ManagedItemMap, ManagedMissingValuesRepresentation, ManagedNumericRepresentation, ManagedRepresentation, ManagedRepresentationGroup, ManagedScaleRepresentation, ManagedTextRepresentation, MeasurementConstruct, MeasurementGroup, MeasurementItem, Methodology, NCube, NCubeGroup, NCubeInstance, NCubeInstance, NCubeInstance, Organization, OrganizationGroup, OtherMaterial, OtherMaterialGroup, PhysicalStructure, PhysicalStructureGroup, PretestActivity, ProcessingEvent, ProcessingEventGroup, ProcessingInstruction, ProcessingInstructionGroup, QualityStandard, QualityStandardGroup, QualityStatement, QualityStatementGroup, QuestionBlock, QuestionConstruct, QuestionGrid, QuestionGroup, QuestionItem, QuestionMap, RecordLayout, RecordLayout, RecordLayout, RecordLayout, RecordLayout, RecordLayoutGroup, Relation, RepeatUntil, RepeatWhile, RepresentationMap, RepresentedVariable, RepresentedVariableGroup, Sample, SampleFrame, SampleStep, SamplingInformationGroup, SamplingPlan, SamplingStage, Sequence, Split, SplitJoin, StatementItem, StatisticalClassification, SubUniverseClass, TranslationActivity, UnitType, UnitTypeGroup, Universe, UniverseGroup, UniverseMap, Variable, VariableGroup, VariableMap, VariableStatistics, Weighting, WeightingMethodology

Known Usage Locations

In derivations of other global types (72):

AgentType (as extension base),

ApprovalReviewType (as extension base),

BaseRecordLayoutType (as extension base),

CategoryGroupType (as extension base),

CategoryType (as extension base),

CodeListGroupType (as extension base),

ConceptGroupType (as extension base),

ConceptType (as extension base),

ConceptualVariableGroupType (as extension base),

ConceptualVariableType (as extension base),

ControlConstructGroupType (as extension base),

ControlConstructType (as extension base),

DataCaptureDevelopmentType (as extension base),

DataRelationshipType (as extension base),

DescribableType (as extension base),

DevelopmentActivityGroupType (as extension base),

DevelopmentActivityType (as extension base),

DevelopmentImplementationType (as extension base),

DevelopmentPlanType (as extension base),

DevelopmentResultsType (as extension base),

GenericMapType (as extension base),

GeographicLocationGroupType (as extension base),

GeographicLocationType (as extension base),

GeographicStructureGroupType (as extension base),

GeographicStructureType (as extension base),

InstructionGroupType (as extension base),

InstructionType (as extension base),

InstrumentGroupType (as extension base),

InstrumentType (as extension base),

ManagedRepresentationGroupType (as extension base),

ManagedRepresentationType (as extension base),

MeasurementGroupType (as extension base),

MeasurementItemType (as extension base),

MethodologyType (as extension base),

NCubeGroupType (as extension base),

NCubeInstanceType (as extension base),

NCubeInstanceType (as extension base),

NCubeInstanceType (as extension base),

NCubeType (as extension base),

OrganizationGroupType (as extension base),

OtherMaterialGroupType (as extension base),

OtherMaterialType (as extension base),

PhysicalStructureGroupType (as extension base),

PhysicalStructureType (as extension base),

ProcessingEventGroupType (as extension base),

ProcessingEventType (as extension base),

ProcessingInstructionGroupType (as extension base),

ProcessingInstructionType (as extension base),

QualityStandardGroupType (as extension base),

QualityStandardType (as extension base),

QualityStatementGroupType (as extension base),

QualityStatementType (as extension base),

QuestionGroupType (as extension base),

QuestionType (as extension base),

RecordLayoutGroupType (as extension base),

RelationType (as extension base),

RepresentationMapType (as extension base),

RepresentedVariableGroupType (as extension base),

RepresentedVariableType (as extension base),

SampleFrameType (as extension base),

SampleType (as extension base),

SamplingInformationGroupType (as extension base),

SamplingPlanType (as extension base),

SubUniverseClassType (as extension base),

UnitTypeGroupType (as extension base),

UniverseGroupType (as extension base),

UniverseType (as extension base),

VariableGroupType (as extension base),

VariableStatisticsType (as extension base),

VariableType (as extension base),

WeightingMethodologyType (as extension base),

WeightingType (as extension base)

Annotation

Adds the attribute identifying this as a versionable object as well as the MaintainableObject. All versionable objects should provide their contextual information, the identity of their maintainable parent. The deprecated form of the URN contains all the information to identify and object and its context. A Canonical URN scoped to the Maintainable contains the ID of the Maintainable as part of its structure. To provide full contextual information use the MaintainableObject structure. The use of the Canonical URN scoped to the agency or the identification sequence alone requires the content of the MaintainableObject to provide full contextual information. All content of Versionable is considered to be administrative metadata. Note that changes to the administrative metadata does not drive a change in the version of the parent objects. See DDI 3.2 Technical Documentation: Part I for further details.

Type Definition Detail

Type Derivation Tree

AbstractIdentifiableType (extension)

AbstractVersionableType (extension)

VersionableType

XML Source (w/o annotations (3); see within schema source)

<xs:complexType abstract="true" name="VersionableType">

<xs:complexContent>

<xs:extension base="AbstractVersionableType">

<xs:sequence>

<xs:element minOccurs="0" ref="MaintainableObject"/>

</xs:sequence>

<xs:attribute fixed="true" name="isVersionable" type="xs:boolean"/>

</xs:extension>

</xs:complexContent>

</xs:complexType>

Attribute Detail (all declarations; defined within this component only; 1/7)

isVersionable

Type:	xs:boolean, predefined
Use:	optional

This is a fixed flag informing the system or user that this element is versionable and may be versioned over time as well as referenced.

Attribute Value

Fixed:

"true"

XML Source (w/o annotations (1); see within schema source)

<xs:attribute fixed="true" name="isVersionable" type="xs:boolean"/>

Content Element Detail (all declarations; defined within this component only; 1/12)

MaintainableObject

Type:

MaintainableObjectType, complex content

This section provides information on the Maintainable Parent of this object at its point of origination. This content will not change over time unless the version of the object changes. Note that if the ID, Agency, Version sequence is used, and the scope of uniqueness of the referenced object is the Maintainable, then the ID of the Maintainable is needed to create the structured ID portion of the canonical URN. If the system uses the deprecated URN, both the Maintainable ID and TypeOfMaintainableObject are required to create the deprecated URN structure.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" ref="MaintainableObject"/>

XML schema documentation generated with DocFlex/XML 1.12 using DocFlex/XML XSDDoc 2.9.0 template set