1EdTech Common Cartridge (Assignment Extension Resource) 1.0 Data Model (XSD) Checklist
Author |
Colin Smythe (1EdTech, UK) |
Date |
29th October 2013 |
Release |
Provisional (1.0) |
Schema Version |
1EdTech CC ASSIGNMENT 1.0 |
Namespace |
http://www.imsglobal.org/xsd/imscc_extensions/assignment |
Summary |
This document provides a checklist of the data model defined for the 1EdTech Common Cartridge (Assignment Extension Resource) 1.0 Specification. |
IPR and Distribution Notices
Recipients of this document are requested to submit, with their comments, notification of any relevant patent claims or other intellectual property rights of which they may be aware that might be infringed by any implementation of the specification set forth in this document, and to provide supporting documentation.
1EdTech takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on 1EdTech's procedures with respect to rights in 1EdTech specifications can be found at the 1EdTech Intellectual Property Rights web page: http://www.imsglobal.org/ipr/imsipr_policyFinal.pdf.
Copyright © 2013 1EdTech Consortium. All Rights Reserved.
Use of this specification to develop products or services is governed by the license with 1EdTech found on the 1EdTech website: http://www.imsglobal.org/license.html.
Permission is granted to all parties to use excerpts from this document as needed in producing requests for proposals.
The limited permissions granted above are perpetual and will not be revoked by 1EdTech or its successors or assigns.
THIS SPECIFICATION IS BEING OFFERED WITHOUT ANY WARRANTY WHATSOEVER, AND IN PARTICULAR, ANY WARRANTY OF NONINFRINGEMENT IS EXPRESSLY DISCLAIMED. ANY USE OF THIS SPECIFICATION SHALL BE MADE ENTIRELY AT THE IMPLEMENTER'S OWN RISK, AND NEITHER THE CONSORTIUM, NOR ANY OF ITS MEMBERS OR SUBMITTERS, SHALL HAVE ANY LIABILITY WHATSOEVER TO ANY IMPLEMENTER OR THIRD PARTY FOR ANY DAMAGES OF ANY NATURE WHATSOEVER, DIRECTLY OR INDIRECTLY, ARISING FROM THE USE OF THIS SPECIFICATION.
Table of Contents
- Key and Color Coding
- Root Attributes Summary Checklist
- Root Class Checklists
- Common Class Checklists
- Derived Class Checklists
- Primitive Data-Type Definitions
Key and Color Coding
In the following tables, three colours are used to denote standard classifications of the rows:
- Light Blue - the class definition;
- Grey - a standard feature;
- Indigo - an extension feature.
The key to the columns used in the following profile comparison details is:
- Identifier - a unique identifier for the element/attribute in this table (indentation reflects any hierarchy due to abstract classes). All attributes are labeled using alphabetic characters;
- Element/Attribute Name - the name of the element/attribute (an attribute is shown with the first character of @). All colon delimited names are defined in an external imported XSD. If the entry "Abstract" is used then this denotes that the model included an abstract class (the content of this class are explicity defined at this point in the list);
- Multiplicity - the permitted multiplicity defined as a [lower .. upper] value (* denotes the upper limit is unbounded and a value of [1] means a single required instance);
- Data Type - the named data-type of the element/attribute. The annotations mean:-
- PT:{data-type} - a primitive data type mapped to XML data-type
- DT:{name} - a derived data type mapped to the parent type
- Enumeration - an enumerated set of permitted values
- Sequence - a sequence complexType
- Selection - a choice complexType
- Any - an any complexType
- Unordered - a constrained choice complexType
- Mixed - the complexType can contain a mixture of text and elements (this value accompanies either Sequence, Selection, Any or Unordered)
- List - a list of values
- EnumeratedList - a list of values selected from an enumerated set of values
- Union - a value that is a union of one other primitive data-types
- Import - an element that is sourced from an external XSD.
Root Attributes Summary Checklist
The set of root attributes defined in the data model.
Identifier | Element/Attribute Name | Multiplicity | Data Type | Notes |
---|---|---|---|---|
1 | assignment | [1] | Assignment (All) | - |
Root Class Checklists
The set of root classes (the classes for the set of root attributes) defined in the data model.
"Assignment" Root Class Checklist
Identifier | Element/Attribute Name | Multiplicity | Data Type | Notes |
---|---|---|---|---|
Root | Assignment.Type | - N/A - | -[[ All ]]- | - N/A - |
a
|
->@identifier | [0..1] | PT:ID | - |
1
|
->title | [1] | PT:String | - |
2
|
->text | [0..1] | DT:Text (PT:String) | - |
2a
|
--->@texttype | [1] | [ Enumeration (TextTypes) ] | Permitted values are: { text/plain | text/html }. |
3
|
->instructor_text | [1] | DT:Text (PT:String) | - |
3a
|
--->@texttype | [1] | [ Enumeration (TextTypes) ] | Permitted values are: { text/plain | text/html }. |
4
|
->attachments | [0..1] | Attachments (Sequence) | - |
5
|
->gradable | [0..1] | DT:Gradable (PT:Boolean) | - |
5a
|
--->@points_possible | [0..1] | PT:Float | - |
6
|
->submission_formats | [0..1] | SubmissionFormats (Sequence) | - |
7
|
->extensions | [0..1] | Extensions (Sequence) | - |
Common Class Checklists
The set of classes (excluding the root classes) defined in the data model.
"Attachments" Class Checklist
Identifier | Element/Attribute Name | Multiplicity | Data Type | Notes |
---|---|---|---|---|
Class | Attachments.Type | - N/A - | -[[ Sequence ]]- | - N/A - |
1
|
->attachment | [1..*] | DT:Attachment (PT:Empty) | This derived element has no value i.e. it is empty. |
1a
|
--->@href | [1] | PT:AnyURI | - |
1b
|
--->@role | [1] | [ Enumeration (RoleTypes) ] | Permitted values are: { All | Learner | Manager | Instructor }. |
"Extensions" Class Checklist
Identifier | Element/Attribute Name | Multiplicity | Data Type | Notes |
---|---|---|---|---|
Class | Extensions.Type | - N/A - | -[[ Sequence ]]- | - N/A - |
a
|
->@platform | [0..1] | PT:String | - |
1
|
->extensions | [0..*] | PT:Namespace | This is a permitted extension point (element) using strict namespacing. |
"SubmissionFormats" Class Checklist
Identifier | Element/Attribute Name | Multiplicity | Data Type | Notes |
---|---|---|---|---|
Class | SubmissionFormats.Type | - N/A - | -[[ Sequence ]]- | - N/A - |
1
|
->format | [1..*] | DT:Format (PT:Empty) | This derived element has no value i.e. it is empty. |
1a
|
--->@type | [1] | [ Enumeration (FormatTypes) ] | Permitted values are: { text | html | url | file }. |
Derived Data-Type Checklists
This is the definition of the set of derived data-types used in this specification and its associated profiles. In the cases where the named child elements are "pattern", "whiteSpace", "minLength", "minInclusive", "maxInclusive" or "maxLength" then these are used to constrain the value of the parent and will not occur as child elements in an instance.
"Attachment" Derived Class Checklists
Identifier | Element/Attribute Name | Multiplicity | Data Type | Notes |
---|---|---|---|---|
Class | Attachment.Type | - N/A - | PT:Empty | - N/A - |
a
|
->@href | [1] | PT:AnyURI | - |
b
|
->@role | [1] | [ Enumeration (RoleTypes) ] | Permitted values are: { All | Learner | Manager | Instructor }. |
"Format" Derived Class Checklists
Identifier | Element/Attribute Name | Multiplicity | Data Type | Notes |
---|---|---|---|---|
Class | Format.Type | - N/A - | PT:Empty | - N/A - |
a
|
->@type | [1] | [ Enumeration (FormatTypes) ] | Permitted values are: { text | html | url | file }. |
"Gradable" Derived Class Checklists
Identifier | Element/Attribute Name | Multiplicity | Data Type | Notes |
---|---|---|---|---|
Class | Gradable.Type | - N/A - | PT:Boolean | - N/A - |
a
|
->@points_possible | [0..1] | PT:Float | - |
"Text" Derived Class Checklists
Identifier | Element/Attribute Name | Multiplicity | Data Type | Notes |
---|---|---|---|---|
Class | Text.Type | - N/A - | PT:String | - N/A - |
a
|
->@texttype | [1] | [ Enumeration (TextTypes) ] | Permitted values are: { text/plain | text/html }. |
Primitive Data-Type Definitions
This is the definition of the set of primitive data-types used in this specification and its associated profiles.
Data-type Name | Description |
---|---|
AnyURI | This is mapped to the XML "xs:anyURI" data-type. |
Boolean | This is mapped to the XML "xs:boolean" data-type. |
Empty | This is used to denote an element that will not contain a value i.e. it is empty. |
Float | This is mapped to the XML "xs:float" data-type. |
ID | This is mapped to the XML "xs:ID" data-type. |
Namespace | This provides a strict namespace-based extension facility. |
String | This is mapped to the XML "xs:string" data-type. |