SIFWorks ADK 2.0
InstrDTD Class
NamespacesEdustructures.SifWorks.InstrInstrDTD

[This is preliminary documentation and is subject to change.]

Metadata for the Schools Interoperability Framework (SIF)
Declaration Syntax
C#Visual BasicVisual C++
public class InstrDTD : SdoLibraryImpl
Public Class InstrDTD _
	Inherits SdoLibraryImpl
public ref class InstrDTD : public SdoLibraryImpl
Members
All MembersConstructorsMethodsFields



IconMemberDescription
InstrDTDInstrDTDNew()()
static memberACTIVITY
static memberACTIVITY_ACTIVITYTIME
static memberACTIVITY_ACTIVITYWEIGHT
static memberACTIVITY_ASSESSMENTREFID
static memberACTIVITY_ESSENTIALMATERIALS
static memberACTIVITY_EVALUATION
static memberACTIVITY_LANGUAGE
static memberACTIVITY_LEARNINGOBJECTIVES
static memberACTIVITY_LEARNINGRESOURCES
static memberACTIVITY_LEARNINGSTANDARDS
static memberACTIVITY_MAXATTEMPTSALLOWED
static memberACTIVITY_POINTS
static memberACTIVITY_PREAMBLE
static memberACTIVITY_PREREQUISITES
static memberACTIVITY_REFID
static memberACTIVITY_SIF_EXTENDEDELEMENTS
static memberACTIVITY_SIF_METADATA
static memberACTIVITY_SOURCEOBJECTS
static memberACTIVITY_STUDENTS
static memberACTIVITY_SUBJECTAREA
static memberACTIVITY_TECHNICALREQUIREMENTS
static memberACTIVITY_TITLE
static memberACTIVITYREFID
static memberACTIVITYTIME
static memberACTIVITYTIME_CREATIONDATE
static memberACTIVITYTIME_DUEDATE
static memberACTIVITYTIME_DURATION
static memberACTIVITYTIME_FINISHDATE
static memberACTIVITYTIME_STARTDATE
AddElementMappings(IDictionary<(Of <String, IElementDef>)>) (Overrides SdoLibraryImpl.AddElementMappings(IDictionary<(Of <String, IElementDef>)>).)
static memberAPPROVAL
static memberAPPROVAL_DATE
static memberAPPROVAL_ORGANIZATION
static memberAPPROVALS
static memberAPPROVALS_APPROVAL
static memberASSIGNMENT
static memberASSIGNMENT_ADDTOGRADEBOOKFLAG
static memberASSIGNMENT_ASSIGNMENTTIME
static memberASSIGNMENT_ESSENTIALMATERIALS
static memberASSIGNMENT_LANGUAGE
static memberASSIGNMENT_LEARNINGOBJECTIVES
static memberASSIGNMENT_LEARNINGSTANDARDS
static memberASSIGNMENT_MAXATTEMPTSALLOWED
static memberASSIGNMENT_PREAMBLE
static memberASSIGNMENT_PREREQUISITES
static memberASSIGNMENT_REFID
static memberASSIGNMENT_SIF_EXTENDEDELEMENTS
static memberASSIGNMENT_SIF_METADATA
static memberASSIGNMENT_SOURCEOBJECTS
static memberASSIGNMENT_STAFFPERSONALREFID
static memberASSIGNMENT_STUDENTS
static memberASSIGNMENT_TECHNICALREQUIREMENTS
static memberASSIGNMENT_TITLE
static memberASSIGNMENTTIME
static memberASSIGNMENTTIME_ADMINISTRATIONDATE
static memberASSIGNMENTTIME_CREATIONDATE
static memberASSIGNMENTTIME_DUEDATE
static memberASSIGNMENTTIME_DUETIME
static memberASSIGNMENTTIME_DURATION
static memberASSIGNMENTTIME_STARTDATE
static memberASSIGNMENTTIME_STARTTIME
static memberASSOCIATEDOBJECT
static memberASSOCIATEDOBJECT_SIF_REFOBJECT
static memberASSOCIATEDOBJECTS
static memberASSOCIATEDOBJECTS_ASSOCIATEDOBJECT
static memberAUTHOR
static memberAUTHORS
static memberAUTHORS_AUTHOR
static memberCOMPONENT
static memberCOMPONENT_ASSOCIATEDOBJECTS
static memberCOMPONENT_DESCRIPTION
static memberCOMPONENT_NAME
static memberCOMPONENT_REFERENCE
static memberCOMPONENT_STRATEGIES
static memberCOMPONENTOBJECT
static memberCOMPONENTOBJECT_SIF_REFOBJECT
static memberCOMPONENTOBJECTS
static memberCOMPONENTOBJECTS_COMPONENTOBJECT
static memberCOMPONENTS
static memberCOMPONENTS_COMPONENT
static memberCONTACTS
static memberCONTACTS_CONTACT
static memberCOPYRIGHT
static memberCOPYRIGHT_DATE
static memberCOPYRIGHT_HOLDER
static memberCURRICULUMHIERARCHYLEVEL
static memberCURRICULUMHIERARCHYLEVEL_DESCRIPTION
static memberCURRICULUMHIERARCHYLEVEL_NAME
static memberCURRICULUMHIERARCHYLEVEL_NUMBER
static memberCURRICULUMSTRUCTURE
static memberCURRICULUMSTRUCTURE_COMPONENTOBJECTS
static memberCURRICULUMSTRUCTURE_CURRICULUMHIERARCHYLEVEL
static memberCURRICULUMSTRUCTURE_DESCRIPTION
static memberCURRICULUMSTRUCTURE_LANGUAGE
static memberCURRICULUMSTRUCTURE_LEARNINGOBJECTIVES
static memberCURRICULUMSTRUCTURE_LEARNINGSTANDARDS
static memberCURRICULUMSTRUCTURE_PREDECESSOROBJECTS
static memberCURRICULUMSTRUCTURE_REFID
static memberCURRICULUMSTRUCTURE_SIF_EXTENDEDELEMENTS
static memberCURRICULUMSTRUCTURE_SIF_METADATA
static memberCURRICULUMSTRUCTURE_SUBJECTAREA
static memberCURRICULUMSTRUCTURE_TITLES
static memberCURRICULUMSTRUCTUREREFID
static memberCURRICULUMSTRUCTURES
static memberCURRICULUMSTRUCTURES_CURRICULUMSTRUCTUREREFID
static memberESSENTIALMATERIAL
static memberESSENTIALMATERIALS
static memberESSENTIALMATERIALS_ESSENTIALMATERIAL
static memberEVALUATION
static memberEVALUATION_DESCRIPTION
static memberEVALUATION_EVALUATIONTYPE
static memberLEARNINGOBJECTIVE
static memberLEARNINGOBJECTIVES
static memberLEARNINGOBJECTIVES_LEARNINGOBJECTIVE
static memberLEARNINGRESOURCE
static memberLEARNINGRESOURCE_AGREEMENTDATE
static memberLEARNINGRESOURCE_APPROVALS
static memberLEARNINGRESOURCE_AUTHOR
static memberLEARNINGRESOURCE_COMPONENTS
static memberLEARNINGRESOURCE_CONTACTS
static memberLEARNINGRESOURCE_DESCRIPTION
static memberLEARNINGRESOURCE_EVALUATIONS
static memberLEARNINGRESOURCE_GRADELEVELS
static memberLEARNINGRESOURCE_LANGUAGE
static memberLEARNINGRESOURCE_LEARNINGSTANDARDS
static memberLEARNINGRESOURCE_LOCATION
static memberLEARNINGRESOURCE_MEDIATYPES
static memberLEARNINGRESOURCE_NAME
static memberLEARNINGRESOURCE_REFID
static memberLEARNINGRESOURCE_SIF_EXTENDEDELEMENTS
static memberLEARNINGRESOURCE_SIF_METADATA
static memberLEARNINGRESOURCE_STATUS
static memberLEARNINGRESOURCE_SUBJECTAREAS
static memberLEARNINGRESOURCE_USEAGREEMENT
static memberLEARNINGRESOURCEREFID
static memberLEARNINGRESOURCES
static memberLEARNINGRESOURCES_LEARNINGRESOURCEREFID
static memberLEARNINGSTANDARDDOCUMENT
static memberLEARNINGSTANDARDDOCUMENT_AUTHORS
static memberLEARNINGSTANDARDDOCUMENT_COPYRIGHT
static memberLEARNINGSTANDARDDOCUMENT_DESCRIPTION
static memberLEARNINGSTANDARDDOCUMENT_DOCUMENTDATE
static memberLEARNINGSTANDARDDOCUMENT_DOCUMENTSTATUS
static memberLEARNINGSTANDARDDOCUMENT_ENDOFLIFEDATE
static memberLEARNINGSTANDARDDOCUMENT_GRADELEVELS
static memberLEARNINGSTANDARDDOCUMENT_LANGUAGE
static memberLEARNINGSTANDARDDOCUMENT_LEARNINGSTANDARDITEMREFID
static memberLEARNINGSTANDARDDOCUMENT_LOCALADOPTIONDATE
static memberLEARNINGSTANDARDDOCUMENT_LOCALARCHIVEDATE
static memberLEARNINGSTANDARDDOCUMENT_ORGANIZATIONCONTACTPOINT
static memberLEARNINGSTANDARDDOCUMENT_ORGANIZATIONS
static memberLEARNINGSTANDARDDOCUMENT_REFID
static memberLEARNINGSTANDARDDOCUMENT_RELATEDLEARNINGSTANDARDS
static memberLEARNINGSTANDARDDOCUMENT_REPOSITORYDATE
static memberLEARNINGSTANDARDDOCUMENT_SIF_EXTENDEDELEMENTS
static memberLEARNINGSTANDARDDOCUMENT_SIF_METADATA
static memberLEARNINGSTANDARDDOCUMENT_SOURCE
static memberLEARNINGSTANDARDDOCUMENT_SUBJECTAREAS
static memberLEARNINGSTANDARDDOCUMENT_TITLE
static memberLEARNINGSTANDARDDOCUMENTREFID
static memberLEARNINGSTANDARDITEM
static memberLEARNINGSTANDARDITEM_GRADELEVELS
static memberLEARNINGSTANDARDITEM_LANGUAGE
static memberLEARNINGSTANDARDITEM_LEARNINGSTANDARDDOCUMENTREFID
static memberLEARNINGSTANDARDITEM_PREDECESSORITEMS
static memberLEARNINGSTANDARDITEM_REFID
static memberLEARNINGSTANDARDITEM_SIF_EXTENDEDELEMENTS
static memberLEARNINGSTANDARDITEM_SIF_METADATA
static memberLEARNINGSTANDARDITEM_STANDARDHIERARCHYLEVEL
static memberLEARNINGSTANDARDITEM_STATEMENTCODES
static memberLEARNINGSTANDARDITEM_STATEMENTS
static memberLEARNINGSTANDARDITEM_SUBJECTAREA
static memberLEARNINGSTANDARDS
static memberLEARNINGSTANDARDS_LEARNINGSTANDARDITEMREFID
static memberLESSON
static memberLESSON_CURRICULUMSTRUCTURES
static memberLESSON_DESCRIPTION
static memberLESSON_DURATION
static memberLESSON_LANGUAGE
static memberLESSON_LEARNINGOBJECTIVES
static memberLESSON_LEARNINGRESOURCES
static memberLESSON_LEARNINGSTANDARDS
static memberLESSON_LESSONSOURCES
static memberLESSON_REFID
static memberLESSON_SIF_EXTENDEDELEMENTS
static memberLESSON_SIF_METADATA
static memberLESSON_STRATEGIES
static memberLESSON_SUBJECTAREA
static memberLESSON_SUPPORTINGACTIVITIES
static memberLESSON_TITLE
static memberLESSONSOURCE
static memberLESSONSOURCE_AUTHOR
static memberLESSONSOURCES
static memberLESSONSOURCES_LESSONSOURCE
Load()() (Overrides SdoLibraryImpl.Load()().)
static memberLRCONTACT
static memberLRCONTACT_ADDRESS
static memberLRCONTACT_EMAIL
static memberLRCONTACT_NAME
static memberLRCONTACT_PHONENUMBER
static memberMEDIATYPE
static memberMEDIATYPES
static memberMEDIATYPES_MEDIATYPE
static memberORGANIZATION
static memberORGANIZATIONS
static memberORGANIZATIONS_ORGANIZATION
static memberPREDECESSORITEMS
static memberPREDECESSORITEMS_LEARNINGSTANDARDITEMREFID
static memberPREDECESSOROBJECTS
static memberPREDECESSOROBJECTS_CURRICULUMSTRUCTUREREFID
static memberPREREQUISITE
static memberPREREQUISITES
static memberPREREQUISITES_PREREQUISITE
static memberRELATEDLEARNINGSTANDARDS
static memberRELATEDLEARNINGSTANDARDS_LEARNINGSTANDARDDOCUMENTREFID
static memberRESOURCECOMPONENT
static memberRESOURCECOMPONENT_ASSOCIATEDOBJECTS
static memberRESOURCECOMPONENT_DESCRIPTION
static memberRESOURCECOMPONENT_NAME
static memberRESOURCECOMPONENT_REFERENCE
static memberRESOURCECOMPONENT_REFID
static memberRESOURCECOMPONENT_STRATEGIES
static memberRESOURCECONTACT
static memberRESOURCECONTACT_ADDRESS
static memberRESOURCECONTACT_EMAIL
static memberRESOURCECONTACT_NAME
static memberRESOURCECONTACT_PHONENUMBER
static memberRESOURCEEVALUATION
static memberRESOURCEEVALUATION_DESCRIPTION
static memberRESOURCEEVALUATION_EVALUATIONDATE
static memberRESOURCEEVALUATION_EVALUATIONREFID
static memberRESOURCEEVALUATION_NAME
static memberRESOURCEEVALUATIONS
static memberRESOURCEEVALUATIONS_EVALUATION
static memberRESOURCELOCATION
static memberRESOURCELOCATION_REFERENCETYPE
static memberSOURCEAUTHOR
static memberSOURCEAUTHOR_ADDRESS
static memberSOURCEAUTHOR_EMAIL
static memberSOURCEAUTHOR_NAME
static memberSOURCEAUTHOR_ORGANIZATION
static memberSOURCEOBJECT
static memberSOURCEOBJECT_SIF_REFOBJECT
static memberSOURCEOBJECTS
static memberSOURCEOBJECTS_SOURCEOBJECT
static memberSTANDARDHIERARCHYLEVEL
static memberSTANDARDHIERARCHYLEVEL_DESCRIPTION
static memberSTANDARDHIERARCHYLEVEL_NUMBER
static memberSTATEMENT
static memberSTATEMENTCODE
static memberSTATEMENTCODES
static memberSTATEMENTCODES_STATEMENTCODE
static memberSTATEMENTS
static memberSTATEMENTS_STATEMENT
static memberSTRATEGIES
static memberSTRATEGIES_STRATEGY
static memberSTRATEGY
static memberSUBJECTAREAS
static memberSUBJECTAREAS_SUBJECTAREA
static memberSUPPORTINGACTIVITIES
static memberSUPPORTINGACTIVITIES_ACTIVITYREFID
static memberTECHNICALREQUIREMENT
static memberTECHNICALREQUIREMENTS
static memberTECHNICALREQUIREMENTS_TECHNICALREQUIREMENT
static memberTIMEDURATION
static memberTIMEDURATION_UNITS
static memberTITLE
static memberTITLES
static memberTITLES_TITLE
Remarks

SIFDTD defines global {@linkplain com.edustructures.sifworks.ElementDef} constants that describe SIF Data Objects, elements, and attributes across all supported versions of the SIF Specification. The ADK uses this metadata internally to parse and render SIF Data Objects. In addition, many of the framework APIs require that the programmer pass an ElementDef constant from the SIFDTD class to identify an object, element, or attribute.

ElementDef constants are named [PARENT_]ENTITY, where PARENT is the name of the parent element and ENTITY is the name of the element or attribute encapsulated by the ElementDef. Some examples of ElementDef constants defined by this class include:

IElementDefDescription
SIFDTD.STUDENTPERSONAL
Identifies the StudentPersonal data object
SIFDTD.SCHOOLINFO
Identifies the SchoolInfo data object
Many of the Adk's public interfaces require an ElementDef constant to be passed as a parameter. For example, the first parameter to the SetSubscriber(ISubscriber, IElementDef, ProvisioningFlags) method is an IElementDef:
CopyC#
myZone.setSubscriber( SIFDTD.BUSINFO, this, ADKFlags.PROV_SUBSCRIBE );
ElementDef also identifies child elements and attributes as demonstrated by the Query.AddCondition method:
CopyC#
Query query = new Query( SifDtd.STUDENTPERSONAL );
query.AddCondition( SifDtd.STUDENTPERSONAL_REFID, Condition.EQ, "4A37969803F0D00322AF0EB969038483" );

SDO Libraries

ElementDef metadata is grouped into "SDO Libraries", which are organized along SIF Working Group boundaries. SDO Libraries are loaded into the SifDdt class when the Adk is initialized. All or part of the metadata is loaded into depending on the flags passed to the Initialize(SifVersion, SdoLibraryType) method, metadata from one or more SDO Libraries may be loaded. For example, the following call loads metadata for the Student Information Working Group Objects and Transportation And Geographic Information Working Group Objects (Common Elements and Infrastructure Working Group Objects metadata is always loaded

CopyC#
Adk.Initialize( SiFVersion.LATEST, SdoLibraryType.Student | SdoLibraryType.Trans )

If an given SDO Library is not loaded, all of the SIFDTD constants that belong to that library will be

CopyC#
null
and cannot be referenced. For example, given the SDO Libraries loaded above, attempting to reference the
CopyC#
SIFDTD.LIBRARYPATRONSTATUS
object from the Library Automation Working Group would result in a NullPointerException:

CopyC#
SifDtd.LIBRARYPATRONSTATUS.Name;
Inheritance Hierarchy
Object
SdoLibraryImpl
 InstrDTD

Assembly: Edustructures.SifWorks.SdoAll (Module: Edustructures.SifWorks.SdoAll) Version: 2.0.0.10