SIFWorks ADK 2.0
EtranscriptsDTD Class
NamespacesEdustructures.SifWorks.EtranscriptsEtranscriptsDTD

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

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



IconMemberDescription
EtranscriptsDTDEtranscriptsDTDNew()()
static memberACADEMICPERFORMANCEHISTORY
static memberACADEMICPERFORMANCEHISTORY_TERMPERFORMANCE
static memberACADEMICPERFORMANCESUMMARY
static memberACADEMICPERFORMANCESUMMARY_ACADEMICTRACK
static memberACADEMICPERFORMANCESUMMARY_CLASSRANK
static memberACADEMICPERFORMANCESUMMARY_CLASSRANKINGDATE
static memberACADEMICPERFORMANCESUMMARY_CLASSTOTALNUMBER
static memberACADEMICPERFORMANCESUMMARY_CUMULATIVEGPA
static memberACADEMICPERFORMANCESUMMARY_CUMULATIVEGPACREDITSEARNED
static memberACADEMICPERFORMANCESUMMARY_CUMULATIVEGRADEPOINTS
static memberACADEMICPERFORMANCESUMMARY_GPATYPE
static memberACADEMICPERFORMANCESUMMARY_GRADUATIONDATE
static memberACADEMICPERFORMANCESUMMARY_GRADUATIONDIPLOMATYPE
static memberACADEMICPERFORMANCESUMMARY_PROJECTEDGRADUATIONDATE
static memberACADEMICPERFORMANCESUMMARY_TOTALCREDITSATTEMPTED
static memberACADEMICPERFORMANCESUMMARY_TOTALCREDITSEARNED
static memberACTIVITYAWARD
static memberACTIVITYAWARD_DIPLOMACREDENTIALHONORSCODE
static memberACTIVITYAWARD_DIPLOMACREDENTIALHONORSDESCRIPTION
static memberACTIVITYAWARD_HONORSDESCRIPTION
static memberACTIVITYAWARD_HONORSINFORMATIONCODE
static memberACTIVITYAWARD_INVOLVEMENTAMOUNT
static memberACTIVITYAWARD_INVOLVEMENTBEGINNINGDATE
static memberACTIVITYAWARD_INVOLVEMENTCODE
static memberACTIVITYAWARD_INVOLVEMENTENDINGDATE
static memberACTIVITYAWARD_NAME
static memberACTIVITYAWARDHISTORY
static memberACTIVITYAWARDHISTORY_ACTIVITYAWARD
AddElementMappings(IDictionary<(Of <String, IElementDef>)>) (Overrides SdoLibraryImpl.AddElementMappings(IDictionary<(Of <String, IElementDef>)>).)
static memberADDITIONALGRADUATIONREQUIREMENTPERFORMANCEHISTORY
static memberADDITIONALGRADUATIONREQUIREMENTPERFORMANCEHISTORY_REQUIREMENT
static memberADVISOR
static memberADVISOR_STAFFPERSONALDATA
static memberASSESSMENTHISTORY
static memberASSESSMENTHISTORY_ADMINISTRATIONDATE
static memberASSESSMENTHISTORY_FORM
static memberASSESSMENTHISTORY_LEVEL
static memberASSESSMENTHISTORY_NAME
static memberASSESSMENTHISTORY_STUDENTGRADELEVELWHENASSESSED
static memberASSESSMENTHISTORY_SUBTESTCATEGORY
static memberASSESSMENTHISTORY_TESTSCORE
static memberASSESSMENTHISTORY_TESTSCORETYPE
static memberASSESSMENTPERFORMANCEHISTORY
static memberASSESSMENTPERFORMANCEHISTORY_ASSESSMENT
static memberCOUNSELOR
static memberCOUNSELOR_STAFFPERSONALDATA
static memberCOURSE
static memberCOURSE_ENDDATE
static memberCOURSE_MARKINGPERIODS
static memberCOURSE_SCHOOLATTENDEDREFID
static memberCOURSE_SCHOOLCOURSEINFODATA
static memberCOURSE_STARTDATE
static memberCOURSEHISTORY
static memberCOURSEHISTORY_TERM
static memberCOURSES
static memberCOURSES_COURSE
static memberCURRENTCOURSEACTIVITY
static memberCURRENTCOURSEACTIVITY_COURSES
static memberCURRENTCOURSEACTIVITY_TERMINFODATA
static memberDEMOGRAPHICSDATA
static memberDEMOGRAPHICSDATA_BIRTHDATE
static memberDEMOGRAPHICSDATA_GENDER
static memberDEMOGRAPHICSDATA_RACELIST
static memberENROLLMENTHISTORY
static memberENROLLMENTHISTORY_STUDENTSCHOOLENROLLMENTDATA
static memberLEAINFODATA
static memberLEAINFODATA_LEANAME
static memberLEAINFODATA_LOCALID
static memberLEAINFODATA_NCESID
static memberLEAINFODATA_STATEPROVINCEID
Load()() (Overrides SdoLibraryImpl.Load()().)
static memberMARKDATA
static memberMARKDATA_LETTER
static memberMARKDATA_MARKVALUEINFODATAREFID
static memberMARKDATA_NARRATIVE
static memberMARKDATA_NUMERIC
static memberMARKDATA_PERCENTAGE
static memberMARKINGPERIOD
static memberMARKINGPERIOD_COURSECREDITSATTEMPTED
static memberMARKINGPERIOD_COURSECREDITSEARNED
static memberMARKINGPERIOD_DAYSABSENT
static memberMARKINGPERIOD_DAYSPRESENT
static memberMARKINGPERIOD_GRADELEVELWHENTAKEN
static memberMARKINGPERIOD_MARKDATA
static memberMARKINGPERIOD_TERMINFODATA
static memberMARKINGPERIODS
static memberMARKINGPERIODS_MARKINGPERIOD
static memberMARKINGSYSTEMS
static memberMARKINGSYSTEMS_MARKVALUEINFODATA
static memberMARKVALUEINFODATA
static memberMARKVALUEINFODATA_LETTER
static memberMARKVALUEINFODATA_NAME
static memberMARKVALUEINFODATA_NARRATIVE
static memberMARKVALUEINFODATA_NUMERIC
static memberMARKVALUEINFODATA_PERCENTAGE
static memberMARKVALUEINFODATA_REFID
static memberOTHERRECORDS
static memberOTHERRECORDS_STUDENTRECORDPACKAGEREFID
static memberPARENTGUARDIAN
static memberPARENTGUARDIAN_ADDRESSLIST
static memberPARENTGUARDIAN_NAME
static memberPARENTGUARDIAN_PHONENUMBERLIST
static memberRECORDS
static memberRECORDS_OTHERRECORDS
static memberRECORDS_STUDENTACADEMICRECORDREFID
static memberRECORDS_STUDENTDEMOGRAPHICRECORDREFID
static memberRECORDS_STUDENTSPECIALEDUCATIONRECORDREFID
static memberREQUIREMENT
static memberREQUIREMENT_METHOD
static memberREQUIREMENT_NAME
static memberREQUIREMENT_STATUS
static memberREQUIREMENT_STATUSDETERMINATIONDATE
static memberSCHOOLATTENDANCEHISTORY
static memberSCHOOLATTENDANCEHISTORY_SCHOOLATTENDED
static memberSCHOOLATTENDED
static memberSCHOOLATTENDED_ACCREDITINGBODY
static memberSCHOOLATTENDED_LEAINFODATA
static memberSCHOOLATTENDED_MARKINGSYSTEMS
static memberSCHOOLATTENDED_REFID
static memberSCHOOLATTENDED_SCHOOLINFODATA
static memberSCHOOLCOURSEINFODATA
static memberSCHOOLCOURSEINFODATA_COREACADEMICCOURSE
static memberSCHOOLCOURSEINFODATA_COURSECODE
static memberSCHOOLCOURSEINFODATA_COURSETITLE
static memberSCHOOLCOURSEINFODATA_DEPARTMENT
static memberSCHOOLCOURSEINFODATA_DESCRIPTION
static memberSCHOOLCOURSEINFODATA_DISTRICTCOURSECODE
static memberSCHOOLCOURSEINFODATA_GRADUATIONREQUIREMENT
static memberSCHOOLCOURSEINFODATA_INSTRUCTIONALLEVEL
static memberSCHOOLCOURSEINFODATA_NATIONALCOURSECODE
static memberSCHOOLCOURSEINFODATA_STATECOURSECODE
static memberSCHOOLCOURSEINFODATA_SUBJECTAREALIST
static memberSCHOOLINFODATA
static memberSCHOOLINFODATA_ADDRESSLIST
static memberSCHOOLINFODATA_GRADELEVELS
static memberSCHOOLINFODATA_LOCALID
static memberSCHOOLINFODATA_NCESID
static memberSCHOOLINFODATA_PHONENUMBERLIST
static memberSCHOOLINFODATA_SCHOOLCONTACTLIST
static memberSCHOOLINFODATA_SCHOOLNAME
static memberSCHOOLINFODATA_SCHOOLURL
static memberSCHOOLINFODATA_STATEPROVINCEID
static memberSTAFFPERSONALDATA
static memberSTAFFPERSONALDATA_ADDRESSLIST
static memberSTAFFPERSONALDATA_NAME
static memberSTAFFPERSONALDATA_PHONENUMBERLIST
static memberSTAFFPERSONALDATA_TITLE
static memberSTUDENTACADEMICRECORD
static memberSTUDENTACADEMICRECORD_ACADEMICPERFORMANCEHISTORY
static memberSTUDENTACADEMICRECORD_ACADEMICPERFORMANCESUMMARY
static memberSTUDENTACADEMICRECORD_ACTIVITYAWARDHISTORY
static memberSTUDENTACADEMICRECORD_ADDITIONALGRADUATIONREQUIREMENTPERFORMANCEHISTORY
static memberSTUDENTACADEMICRECORD_ASSESSMENTPERFORMANCEHISTORY
static memberSTUDENTACADEMICRECORD_COURSEHISTORY
static memberSTUDENTACADEMICRECORD_CURRENTCOURSEACTIVITY
static memberSTUDENTACADEMICRECORD_DISTRICTENTRYDATE
static memberSTUDENTACADEMICRECORD_ENROLLMENTHISTORY
static memberSTUDENTACADEMICRECORD_REFID
static memberSTUDENTACADEMICRECORD_REPORTINGDATE
static memberSTUDENTACADEMICRECORD_SCHOOLATTENDANCEHISTORY
static memberSTUDENTACADEMICRECORD_SIF_EXTENDEDELEMENTS
static memberSTUDENTACADEMICRECORD_SIF_METADATA
static memberSTUDENTACADEMICRECORD_SIF_REFID
static memberSTUDENTACADEMICRECORD_SIF_REFOBJECT
static memberSTUDENTACADEMICRECORD_STUDENTSCHOOLENROLLMENTDATA
static memberSTUDENTCONTACTSSUMMARY
static memberSTUDENTCONTACTSSUMMARY_PARENTGUARDIAN1
static memberSTUDENTCONTACTSSUMMARY_PARENTGUARDIAN2
static memberSTUDENTDEMOGRAPHICRECORD
static memberSTUDENTDEMOGRAPHICRECORD_REFID
static memberSTUDENTDEMOGRAPHICRECORD_REPORTINGDATE
static memberSTUDENTDEMOGRAPHICRECORD_SIF_EXTENDEDELEMENTS
static memberSTUDENTDEMOGRAPHICRECORD_SIF_METADATA
static memberSTUDENTDEMOGRAPHICRECORD_SIF_REFID
static memberSTUDENTDEMOGRAPHICRECORD_SIF_REFOBJECT
static memberSTUDENTDEMOGRAPHICRECORD_STUDENTCONTACTSSUMMARY
static memberSTUDENTDEMOGRAPHICRECORD_STUDENTPERSONALDATA
static memberSTUDENTPARTICIPATIONDATA
static memberSTUDENTPARTICIPATIONDATA_EVALUATIONDATE
static memberSTUDENTPARTICIPATIONDATA_EXCEPTIONALITYCATEGORIES
static memberSTUDENTPARTICIPATIONDATA_LEAINFODATA
static memberSTUDENTPARTICIPATIONDATA_PLANNEDASSESSMENTPARTICIPATION
static memberSTUDENTPARTICIPATIONDATA_PROGRAMPLANDATE
static memberSTUDENTPARTICIPATIONDATA_PROGRAMPLANEFFECTIVEDATE
static memberSTUDENTPARTICIPATIONDATA_PROGRAMSTATUS
static memberSTUDENTPARTICIPATIONDATA_PROGRAMTYPE
static memberSTUDENTPARTICIPATIONDATA_REEVALUATIONDATE
static memberSTUDENTPARTICIPATIONDATA_REFERRALDATE
static memberSTUDENTPARTICIPATIONDATA_SCHOOLINFODATA
static memberSTUDENTPERSONALDATA
static memberSTUDENTPERSONALDATA_ADDRESSLIST
static memberSTUDENTPERSONALDATA_DEMOGRAPHICSDATA
static memberSTUDENTPERSONALDATA_ECONOMICDISADVANTAGE
static memberSTUDENTPERSONALDATA_ELL
static memberSTUDENTPERSONALDATA_GIFTEDTALENTED
static memberSTUDENTPERSONALDATA_HOMELESS
static memberSTUDENTPERSONALDATA_IDEA
static memberSTUDENTPERSONALDATA_IMMIGRANT
static memberSTUDENTPERSONALDATA_LOCALID
static memberSTUDENTPERSONALDATA_MIGRANT
static memberSTUDENTPERSONALDATA_NAME
static memberSTUDENTPERSONALDATA_NEGLECTEDDELINQUENT
static memberSTUDENTPERSONALDATA_OTHERNAMES
static memberSTUDENTPERSONALDATA_PHONENUMBERLIST
static memberSTUDENTPERSONALDATA_SECTION504
static memberSTUDENTPERSONALDATA_SSN
static memberSTUDENTPERSONALDATA_STATEPROVINCEID
static memberSTUDENTPERSONALDATA_TITLE1
static memberSTUDENTPERSONALDATA_VOCATIONALCONCENTRATOR
static memberSTUDENTRECORDEXCHANGE
static memberSTUDENTRECORDEXCHANGE_LOCALID
static memberSTUDENTRECORDEXCHANGE_RECORDS
static memberSTUDENTRECORDEXCHANGE_REFID
static memberSTUDENTRECORDEXCHANGE_SIF_EXTENDEDELEMENTS
static memberSTUDENTRECORDEXCHANGE_SIF_METADATA
static memberSTUDENTRECORDEXCHANGE_STATEPROVINCEID
static memberSTUDENTRECORDEXCHANGE_STUDENTPERSONALREFID
static memberSTUDENTRECORDPACKAGE
static memberSTUDENTRECORDPACKAGE_BINARYDATA
static memberSTUDENTRECORDPACKAGE_REFERENCE
static memberSTUDENTRECORDPACKAGE_REFID
static memberSTUDENTRECORDPACKAGE_SIF_EXTENDEDELEMENTS
static memberSTUDENTRECORDPACKAGE_SIF_METADATA
static memberSTUDENTRECORDPACKAGE_SIF_REFID
static memberSTUDENTRECORDPACKAGE_SIF_REFOBJECT
static memberSTUDENTRECORDPACKAGE_TEXTDATA
static memberSTUDENTRECORDPACKAGE_XMLDATA
static memberSTUDENTRECORDPACKAGEREFID
static memberSTUDENTSCHOOLENROLLMENTDATA
static memberSTUDENTSCHOOLENROLLMENTDATA_ADVISOR
static memberSTUDENTSCHOOLENROLLMENTDATA_COUNSELOR
static memberSTUDENTSCHOOLENROLLMENTDATA_GRADELEVEL
static memberSTUDENTSCHOOLENROLLMENTDATA_SCHOOLATTENDEDREFID
static memberSTUDENTSCHOOLENROLLMENTHISTORY
static memberSTUDENTSCHOOLENROLLMENTHISTORY_ENTRYDATE
static memberSTUDENTSCHOOLENROLLMENTHISTORY_EXITDATE
static memberSTUDENTSCHOOLENROLLMENTHISTORY_SCHOOLATTENDEDREFID
static memberSTUDENTSCHOOLENROLLMENTHISTORY_SCHOOLYEAR
static memberSTUDENTSPECIALEDUCATIONRECORD
static memberSTUDENTSPECIALEDUCATIONRECORD_LEAINFODATA
static memberSTUDENTSPECIALEDUCATIONRECORD_REFID
static memberSTUDENTSPECIALEDUCATIONRECORD_REPORTINGDATE
static memberSTUDENTSPECIALEDUCATIONRECORD_SCHOOLINFODATA
static memberSTUDENTSPECIALEDUCATIONRECORD_SIF_EXTENDEDELEMENTS
static memberSTUDENTSPECIALEDUCATIONRECORD_SIF_METADATA
static memberSTUDENTSPECIALEDUCATIONRECORD_SIF_REFID
static memberSTUDENTSPECIALEDUCATIONRECORD_SIF_REFOBJECT
static memberSTUDENTSPECIALEDUCATIONRECORD_STUDENTPARTICIPATIONDATA
static memberTERM
static memberTERM_COURSES
static memberTERM_TERMINFODATA
static memberTERMINFODATA
static memberTERMINFODATA_DESCRIPTION
static memberTERMINFODATA_ENDDATE
static memberTERMINFODATA_SCHOOLATTENDEDREFID
static memberTERMINFODATA_SCHOOLYEAR
static memberTERMINFODATA_STARTDATE
static memberTERMINFODATA_TERMCODE
static memberTERMINFODATA_TERMSPAN
static memberTERMINFODATA_TRACK
static memberTERMPERFORMANCE
static memberTERMPERFORMANCE_CREDITSATTEMPTED
static memberTERMPERFORMANCE_CREDITSEARNED
static memberTERMPERFORMANCE_DAYSABSENT
static memberTERMPERFORMANCE_DAYSPRESENT
static memberTERMPERFORMANCE_GPA
static memberTERMPERFORMANCE_GPACREDITSATTEMPTED
static memberTERMPERFORMANCE_GPACREDITSEARNED
static memberTERMPERFORMANCE_GPAGRADEPOINTS
static memberTERMPERFORMANCE_GRADELEVELWHENTAKEN
static memberTERMPERFORMANCE_TERMINFODATA
static memberTERMPERFORMANCE_WEIGHTEDGPA
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
 EtranscriptsDTD

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