SIFWorks ADK 2.0
CommonDTD Class
NamespacesEdustructures.SifWorks.CommonCommonDTD

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

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



IconMemberDescription
CommonDTDCommonDTDNew()()
AddElementMappings(IDictionary<(Of <String, IElementDef>)>) (Overrides SdoLibraryImpl.AddElementMappings(IDictionary<(Of <String, IElementDef>)>).)
static memberADDRESS
static memberADDRESS_CITY
static memberADDRESS_COUNTRY
static memberADDRESS_COUNTY
static memberADDRESS_GRIDLOCATION
static memberADDRESS_POSTALCODE
static memberADDRESS_STATEPROVINCE
static memberADDRESS_STREET
static memberADDRESS_TYPE
static memberADDRESSLIST
static memberADDRESSLIST_ADDRESS
static memberATTENDANCECODE
static memberATTENDANCECODE_ATTENDANCECODEINFOREFID
static memberBINARYDATA
static memberBINARYDATA_DESCRIPTION
static memberBINARYDATA_FILENAME
static memberBINARYDATA_MIMETYPE
static memberCODESETVALUE
static memberCODESETVALUE_CODE
static memberCODESETVALUE_OTHERCODELIST
static memberCONTACTINFO
static memberCONTACTINFO_ADDRESS
static memberCONTACTINFO_EMAILLIST
static memberCONTACTINFO_NAME
static memberCONTACTINFO_PHONENUMBERLIST
static memberCONTACTINFO_POSITIONTITLE
static memberCONTACTINFO_ROLE
static memberCOUNTRIESOFCITIZENSHIP
static memberCOUNTRIESOFCITIZENSHIP_COUNTRYOFCITIZENSHIP
static memberCOUNTRIESOFRESIDENCY
static memberCOUNTRIESOFRESIDENCY_COUNTRYOFRESIDENCY
static memberCOUNTRY
static memberCOUNTRYOFRESIDENCY
static memberDEMOGRAPHICS
static memberDEMOGRAPHICS_BIRTHDATE
static memberDEMOGRAPHICS_BIRTHDATEVERIFICATION
static memberDEMOGRAPHICS_CITIZENSHIPSTATUS
static memberDEMOGRAPHICS_COUNTRIESOFCITIZENSHIP
static memberDEMOGRAPHICS_COUNTRIESOFRESIDENCY
static memberDEMOGRAPHICS_COUNTRYARRIVALDATE
static memberDEMOGRAPHICS_COUNTRYOFBIRTH
static memberDEMOGRAPHICS_COUNTYOFBIRTH
static memberDEMOGRAPHICS_DWELLINGARRANGEMENT
static memberDEMOGRAPHICS_ENGLISHPROFICIENCY
static memberDEMOGRAPHICS_GENDER
static memberDEMOGRAPHICS_HISPANICLATINO
static memberDEMOGRAPHICS_LANGUAGELIST
static memberDEMOGRAPHICS_MARITALSTATUS
static memberDEMOGRAPHICS_PLACEOFBIRTH
static memberDEMOGRAPHICS_RACELIST
static memberDEMOGRAPHICS_STATEOFBIRTH
static memberDURATION
static memberDURATION_UNITS
static memberDWELLINGARRANGEMENT
static memberDWELLINGARRANGEMENT_CODE
static memberDWELLINGARRANGEMENT_OTHERCODELIST
static memberELECTRONICID
static memberELECTRONICID_TYPE
static memberELECTRONICIDLIST
static memberELECTRONICIDLIST_ELECTRONICID
static memberEMAIL
static memberEMAIL_TYPE
static memberEMAILLIST
static memberEMAILLIST_EMAIL
static memberENGLISHPROFICIENCY
static memberENGLISHPROFICIENCY_CODE
static memberENGLISHPROFICIENCY_OTHERCODELIST
static memberEXCEPTIONALITYCATEGORIES
static memberEXCEPTIONALITYCATEGORIES_EXCEPTIONALITYCATEGORY
static memberEXCEPTIONALITYCATEGORY
static memberEXCEPTIONALITYCATEGORY_CODE
static memberEXCEPTIONALITYCATEGORY_CODETYPE
static memberEXCEPTIONALITYCATEGORY_EXCEPTIONALITYPRIORITY
static memberEXCEPTIONALITYCATEGORY_OTHERCODELIST
static memberGRADELEVEL
static memberGRADELEVEL_CODE
static memberGRADELEVEL_OTHERCODELIST
static memberGRADELEVELS
static memberGRADELEVELS_GRADELEVEL
static memberGRIDLOCATION
static memberGRIDLOCATION_LATITUDE
static memberGRIDLOCATION_LONGITUDE
static memberIDENTIFICATIONINFO
static memberIDENTIFICATIONINFO_CODE
static memberIDENTIFICATIONINFOLIST
static memberIDENTIFICATIONINFOLIST_IDENTIFICATIONINFO
static memberINSTRUCTIONALLEVEL
static memberINSTRUCTIONALLEVEL_CODE
static memberINSTRUCTIONALLEVEL_OTHERCODELIST
static memberJOBFUNCTION
static memberJOBFUNCTION_CODE
static memberJOBFUNCTION_OTHERCODELIST
static memberLANGUAGE
static memberLANGUAGE_CODE
static memberLANGUAGE_DIALECT
static memberLANGUAGE_LANGUAGETYPE
static memberLANGUAGE_OTHERCODELIST
static memberLANGUAGELIST
static memberLANGUAGELIST_LANGUAGE
static memberLEAINFOLINK
static memberLEAINFOLINK_LEAINFOREFID
static memberLEARNINGSTANDARDITEMREFID
Load()() (Overrides SdoLibraryImpl.Load()().)
static memberMEETINGTIME
static memberMEETINGTIME_TIMETABLEDAY
static memberMEETINGTIME_TIMETABLEPERIOD
static memberMEETINGTIMELIST
static memberMEETINGTIMELIST_MEETINGTIME
static memberMONETARYAMOUNTTYPE
static memberMONETARYAMOUNTTYPE_CURRENCY
static memberNAME
static memberNAME_FIRSTNAME
static memberNAME_FULLNAME
static memberNAME_LASTNAME
static memberNAME_MIDDLENAME
static memberNAME_PREFERREDNAME
static memberNAME_PREFIX
static memberNAME_SORTNAME
static memberNAME_SUFFIX
static memberNAME_TYPE
static memberNAMELIST
static memberNAMELIST_NAME
static memberOTHERCODE
static memberOTHERCODE_CODESET
static memberOTHERCODELIST
static memberOTHERCODELIST_OTHERCODE
static memberOTHERID
static memberOTHERID_TYPE
static memberOTHERIDLIST
static memberOTHERIDLIST_OTHERID
static memberPARTIALDATETYPE
static memberPHONENUMBER
static memberPHONENUMBER_EXTENSION
static memberPHONENUMBER_FORMAT
static memberPHONENUMBER_LISTEDSTATUS
static memberPHONENUMBER_NUMBER
static memberPHONENUMBER_TYPE
static memberPHONENUMBERLIST
static memberPHONENUMBERLIST_PHONENUMBER
static memberPICTURESOURCE
static memberPICTURESOURCE_TYPE
static memberPLANNEDASSESSMENTPARTICIPATION
static memberPLANNEDASSESSMENTPARTICIPATION_CODESET
static memberPROGRAM
static memberPROGRAM_TYPE
static memberPROGRAMFUNDINGSOURCE
static memberPROGRAMFUNDINGSOURCE_CODE
static memberPROGRAMFUNDINGSOURCE_OTHERCODELIST
static memberPROGRAMSTATUS
static memberPROGRAMSTATUS_CODE
static memberPROGRAMSTATUS_OTHERCODELIST
static memberPROGRAMTYPE
static memberPROGRAMTYPE_CODE
static memberPROGRAMTYPE_OTHERCODELIST
static memberRACE
static memberRACE_CODE
static memberRACE_OTHERCODELIST
static memberRACE_PROPORTION
static memberRACE_TYPE
static memberRACELIST
static memberRACELIST_RACE
static memberREFERENCE
static memberREFERENCE_DESCRIPTION
static memberREFERENCE_MIMETYPE
static memberREFERENCE_URL
static memberRELATIONSHIP
static memberRELATIONSHIP_CODE
static memberRELATIONSHIP_OTHERCODELIST
static memberSCHOOLCONTACT
static memberSCHOOLCONTACT_CONTACTINFO
static memberSCHOOLCONTACT_PUBLISHINDIRECTORY
static memberSCHOOLCONTACTLIST
static memberSCHOOLCONTACTLIST_SCHOOLCONTACT
static memberSIF_EXTENDEDELEMENT
static memberSIF_EXTENDEDELEMENT_NAME
static memberSIF_EXTENDEDELEMENT_SIF_ACTION
static memberSIF_EXTENDEDELEMENT_XSITYPE
static memberSIF_EXTENDEDELEMENTS
static memberSIF_EXTENDEDELEMENTS_SIF_EXTENDEDELEMENT
static memberSIF_REFID
static memberSIF_REFID_SIF_REFOBJECT
static memberSTAFFLINK
static memberSTAFFLINK_STAFFPERSONALREFID
static memberSTREET
static memberSTREET_APARTMENTNUMBER
static memberSTREET_APARTMENTNUMBERPREFIX
static memberSTREET_APARTMENTNUMBERSUFFIX
static memberSTREET_APARTMENTTYPE
static memberSTREET_COMPLEX
static memberSTREET_LINE1
static memberSTREET_LINE2
static memberSTREET_LINE3
static memberSTREET_STREETNAME
static memberSTREET_STREETNUMBER
static memberSTREET_STREETPREFIX
static memberSTREET_STREETSUFFIX
static memberSTREET_STREETTYPE
static memberSTUDENTPERSONALREFID
static memberSTUDENTS
static memberSTUDENTS_STUDENTPERSONALREFID
static memberSUBJECTAREA
static memberSUBJECTAREA_CODE
static memberSUBJECTAREA_OTHERCODELIST
static memberSUBJECTAREALIST
static memberSUBJECTAREALIST_SUBJECTAREA
static memberTERMSPAN
static memberTERMSPAN_CODE
static memberTERMSPAN_OTHERCODELIST
static memberTEXTDATA
static memberTEXTDATA_DESCRIPTION
static memberTEXTDATA_FILENAME
static memberTEXTDATA_MIMETYPE
static memberXMLDATA
static memberXMLDATA_DESCRIPTION
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
 CommonDTD

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