complexType "AbstractVersionableType"
Namespace:
ddi:reusable:3_3
Content:
complex, 6 attributes, 11 elements
Abstract:
(cannot be assigned directly to elements used in instance XML documents)
Defined:
globally in reusable.xsd; see XML source
Includes:
definitions of 2 attributes, 5 elements
Used:
at 2 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"
   
>
   
Content: 
(URN | (Agency, ID, Version))[1..2], UserID*, UserAttributePair*, (VersionResponsibility | VersionResponsibilityReference)?, VersionRationale?, BasedOnObject?, RelatedOtherMaterialReference*
</...>
Known Direct Subtypes (2):
AbstractMaintainableType, VersionableType
Known Indirect Subtypes (162):
AgentType, ApprovalReviewType, ArchiveType, BaseLogicalProductType, BaseRecordLayoutType, CategoryGroupType, CategorySchemeType, CategoryType, ClassificationCorrespondenceTableType, ClassificationFamilyType, ClassificationIndexType, ClassificationItemType, ClassificationLevelType, ClassificationSeriesType, CodeListGroupType, CodeListSchemeType, CodeListType, CognitiveExpertReviewActivityType, CognitiveInterviewActivityType, ComparisonType, ComputationItemType, ConceptGroupType, ConceptSchemeType, ConceptType, ConceptualComponentType, ConceptualVariableGroupType, ConceptualVariableSchemeType, ConceptualVariableType, ContentReviewActivityType, ControlConstructGroupType, ControlConstructSchemeType, ControlConstructType, DDIInstanceType, DDIProfileType, DataCaptureDevelopmentType, DataCollectionType, DataRelationshipType, DataSetType, DescribableType, DevelopmentActivityGroupType, DevelopmentActivitySchemeType, DevelopmentActivityType, DevelopmentImplementationType, DevelopmentPlanType, DevelopmentResultsType, DevelopmentStepType, FocusGroupActivityType, GeneralInstructionType, GenerationInstructionType, GenericMapType, GeographicLocationGroupType, GeographicLocationSchemeType, GeographicLocationType, GeographicStructureGroupType, GeographicStructureSchemeType, GeographicStructureType, GroupType, IfThenElseType, IndividualType, InformationClassificationType, InstructionGroupType, InstructionType, InstrumentGroupType, InstrumentSchemeType, InstrumentType, InterviewerInstructionSchemeType, LocalHoldingPackageType, LogicalProductType, LoopType, MaintainableType, ManagedDateTimeRepresentationType, ManagedMissingValuesRepresentationType, ManagedNumericRepresentationType, ManagedRepresentationGroupType, ManagedRepresentationSchemeType, ManagedRepresentationType, ManagedScaleRepresentationType, ManagedTextRepresentationType, MeasurementConstructType, MeasurementGroupType, MeasurementItemType, MeasurementSchemeType, MethodologyType, NCubeGroupType, NCubeInstanceType, NCubeInstanceType, NCubeInstanceType, NCubeSchemeType, NCubeType, OrganizationGroupType, OrganizationSchemeType, OrganizationType, OtherMaterialGroupType, OtherMaterialSchemeType, OtherMaterialType, PhysicalDataProductType, PhysicalInstanceGroupType, PhysicalInstanceType, PhysicalStructureGroupType, PhysicalStructureSchemeType, PhysicalStructureType, PretestActivityType, ProcessingEventGroupType, ProcessingEventSchemeType, ProcessingEventType, ProcessingInstructionGroupType, ProcessingInstructionSchemeType, ProcessingInstructionType, QualitySchemeType, QualityStandardGroupType, QualityStandardType, QualityStatementGroupType, QualityStatementType, QuestionBlockType, QuestionConstructType, QuestionGridType, QuestionGroupType, QuestionItemType, QuestionSchemeType, QuestionType, RecordLayoutGroupType, RecordLayoutSchemeType, RecordLayoutType, RecordLayoutType, RecordLayoutType, RecordLayoutType, RecordLayoutType, RelationType, RepeatUntilType, RepeatWhileType, RepresentationMapType, RepresentedVariableGroupType, RepresentedVariableSchemeType, RepresentedVariableType, ResourcePackageType, SampleFrameType, SampleStepType, SampleType, SamplingInformationGroupType, SamplingInformationSchemeType, SamplingPlanType, SamplingStageType, SequenceType, SplitJoinType, SplitType, StatementItemType, StatisticalClassificationType, StudyUnitType, SubUniverseClassType, TranslationActivityType, UnitTypeGroupType, UnitTypeSchemeType, UnitTypeType, UniverseGroupType, UniverseSchemeType, UniverseType, VariableGroupType, VariableSchemeType, VariableStatisticsType, VariableType, WeightingMethodologyType, WeightingType
All Direct / Indirect Based Elements (168):
ApprovalReview, ApprovalReviewDocument, Archive, BaseLogicalProduct, BaseRecordLayout, Category, CategoryGroup, CategoryMap, CategoryScheme, ClassificationCorrespondenceTable, ClassificationFamily, ClassificationIndex, ClassificationItem, ClassificationLevel, ClassificationSeries, CodeList, CodeListGroup, CodeListScheme, CognitiveExpertReviewActivity, CognitiveInterviewActivity, Comparison, ComputationItem, Concept, ConceptGroup, ConceptMap, ConceptScheme, ConceptualComponent, ConceptualVariable, ConceptualVariableGroup, ConceptualVariableScheme, ContentReviewActivity, ControlConstruct, ControlConstructGroup, ControlConstructScheme, DDIInstance, DDIProfile, DataCaptureDevelopment, DataCollection, DataRelationship, DataSet, DevelopmentActivity, DevelopmentActivityGroup, DevelopmentActivityScheme, DevelopmentImplementation, DevelopmentPlan, DevelopmentResults, DevelopmentStep, FocusGroupActivity, FundingDocument, GeneralInstruction, GenerationInstruction, GeographicLocation, GeographicLocationGroup, GeographicLocationScheme, GeographicStructure, GeographicStructureGroup, GeographicStructureScheme, Group, IfThenElse, Individual, InformationClassification, Instruction, InstructionGroup, Instrument, InstrumentGroup, InstrumentScheme, InterviewerInstructionScheme, LocalGroupContent, LocalHoldingPackage, LocalResourcePackageContent, LocalStudyUnitContent, LogicalProduct, Loop, ManagedDateTimeRepresentation, ManagedItemMap, ManagedMissingValuesRepresentation, ManagedNumericRepresentation, ManagedRepresentation, ManagedRepresentationGroup, ManagedRepresentationScheme, ManagedScaleRepresentation, ManagedTextRepresentation, MeasurementConstruct, MeasurementGroup, MeasurementItem, MeasurementScheme, Methodology, NCube, NCubeGroup, NCubeInstance, NCubeInstance, NCubeInstance, NCubeScheme, Organization, OrganizationGroup, OrganizationScheme, OtherMaterial, OtherMaterialGroup, OtherMaterialScheme, PhysicalDataProduct, PhysicalInstance, PhysicalInstanceGroup, PhysicalStructure, PhysicalStructureGroup, PhysicalStructureScheme, PretestActivity, ProcessingEvent, ProcessingEventGroup, ProcessingEventScheme, ProcessingInstruction, ProcessingInstructionGroup, ProcessingInstructionScheme, QualityScheme, QualityStandard, QualityStandardGroup, QualityStatement, QualityStatementGroup, QuestionBlock, QuestionConstruct, QuestionGrid, QuestionGroup, QuestionItem, QuestionMap, QuestionScheme, RecordLayout, RecordLayout, RecordLayout, RecordLayout, RecordLayout, RecordLayoutGroup, RecordLayoutScheme, Relation, RepeatUntil, RepeatWhile, RepresentationMap, RepresentedVariable, RepresentedVariableGroup, RepresentedVariableScheme, ResourcePackage, Sample, SampleFrame, SampleStep, SamplingInformationGroup, SamplingInformationScheme, SamplingPlan, SamplingStage, Sequence, Split, SplitJoin, StatementItem, StatisticalClassification, StudyUnit, SubUniverseClass, TranslationActivity, UnitType, UnitTypeGroup, UnitTypeScheme, Universe, UniverseGroup, UniverseMap, UniverseScheme, Variable, VariableGroup, VariableMap, VariableScheme, VariableStatistics, Weighting, WeightingMethodology
Known Usage Locations
Annotation
Used to identify described versionable objects for purposes of internal and/or external referencing. Elements of this type cannot be maintained except as part of a complex parent element. Provides containers for Uniform Resource Name (URN) as well as ID information. An entity can either be identified either by a URN and/or an identification sequence. At a minimum, one or the other is required. You must designate they type of URN supported by your agency, either "Canonical" or "Deprecated". To fully support interoperability both the DDI URN and the full identification sequence should be used. Note that to support interoperability of the canonical and deprecated URN, at minimum the MaintainableIdentifier and TypeOfMaintainableObject should be supplied if the canonical URN is being used by the agency. If both URN and the identification sequence is used, and there is any conflict, the URN takes precedence. The element can be designated as an addition, replacement, or deletion to facilitate tracking changes. In addtion to the elements and attributes inherited from AbstractIdentifiable, additional information regarding the versioning process can be provided; version date, the person and/or organization within the maintenance agency responsible for the change as either text or reference, and the reason for the change. If the object created was based on an exisiting object (other than by versioning), the object on which it is based can be identified using BasedOnReference. In addition to UserID, versionable and maintainable objects may also designate additional user specific properties expressed as a key/value pair using UserAttributePair.
Type Definition Detail
Type Derivation Tree
AbstractIdentifiableType (extension)
  AbstractVersionableType
XML Source (w/o annotations (9); see within schema source)
<xs:complexType abstract="true" name="AbstractVersionableType">
<xs:complexContent>
<xs:extension base="AbstractIdentifiableType">
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="VersionResponsibility"/>
<xs:element ref="VersionResponsibilityReference"/>
</xs:choice>
<xs:element minOccurs="0" ref="VersionRationale"/>
<xs:element minOccurs="0" ref="BasedOnObject"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="RelatedOtherMaterialReference"/>
</xs:sequence>
<xs:attribute name="versionDate" type="BaseDateType" use="optional"/>
<xs:attribute default="false" name="isPublished" type="xs:boolean"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Attribute Detail (all declarations; defined within this component only; 2/6)
isPublished
Type:
xs:boolean, predefined
Use:
optional
Indicates that the maintainable will not be changed without versioning, and is a stable target for referencing.
Attribute Value
Default:
"false"
XML Source (w/o annotations (1); see within schema source)
<xs:attribute default="false" name="isPublished" type="xs:boolean"/>
versionDate
Type:
BaseDateType
Use:
optional
Date of version using the union set BaseDateType. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
Attribute Value
xs:dateTime | xs:date | xs:gYearMonth | xs:gYear | xs:duration
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="versionDate" type="BaseDateType" use="optional"/>
Content Element Detail (all declarations; defined within this component only; 5/11)
BasedOnObject
Type:
BasedOnObjectType, complex content
Use when creating an object that is based on an existing object or objects that are managed by a different agency or when the new object is NOT simply a version change but you wish to maintain a reference to the object that served as a basis for the new object. BasedOnObject may contain references to any number of objects which serve as a basis for this object, a BasedOnRationalDescription of how the content of the referenced object was incorporated or altered, and a BasedOnRationalCode to allow for specific typing of the BasedOnReference according to an external controlled vocabulary.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="BasedOnObject"/>
RelatedOtherMaterialReference
Type:
ReferenceType, complex content
The inclusion of an existing OtherMaterial by reference. Use for any type of OtherMaterial not specifically addressed by an inline description for such as ExternalAid in QuestionItem.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="RelatedOtherMaterialReference"/>
VersionRationale
Type:
VersionRationaleType, complex content
Textual description of the rationale/purpose for the version change and a coded value to provide an internal processing flag within and organization or system. Note that versioning can only take place on objects owned by the specified DDI Agency. If you are creating a local instance of an object from another agency for current or future modification use BasedOnObject. If the changes being made result in what you determine to be new object rather than a version of a previous object, i.e. the change is too extensive to consider it a version of the existing object, create a new object and use BasedOnObject to provide a link to the object or objects that were a basis for the new object.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="VersionRationale"/>
VersionResponsibility
Type:
xs:string, predefined, simple content
Person or organization within the MaintenanceAgency responsible for the version change. If it is important to retain the affiliation between and individual responsible for the version and his/her agency, it may be included in this notation. This is primarily intended for internal use.
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="VersionResponsibility"/>
VersionResponsibilityReference
Type:
ReferenceType, complex content
Reference person or organization within the MaintenanceAgency responsible for the version change, as described in an OrganizationScheme. If it is important to retain the affiliation between and individual responsible for the version and his/her agency, a Relation should be created between the individual referenced here and his/her organization. This is primarily intended for internal use.
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="VersionResponsibilityReference"/>
XML schema documentation generated with DocFlex/XML 1.12 using DocFlex/XML XSDDoc 2.9.0 template set