SIFWorks ADK 2.0
ProgramsDTD Class
NamespacesEdustructures.SifWorks.ProgramsProgramsDTD

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

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



IconMemberDescription
ProgramsDTDProgramsDTDNew()()
static memberACCOMMODATION
static memberACCOMMODATION_ACCOMMODATIONCATEGORY
static memberACCOMMODATION_CODE
static memberACCOMMODATION_OTHERCODELIST
static memberACCOMMODATION_SPECIALMATERIALS
static memberACCOMMODATIONCATEGORY
static memberACCOMMODATIONCATEGORY_CODE
static memberACCOMMODATIONCATEGORY_OTHERCODELIST
static memberACCOMMODATIONS
static memberACCOMMODATIONS_ACCOMMODATION
AddElementMappings(IDictionary<(Of <String, IElementDef>)>) (Overrides SdoLibraryImpl.AddElementMappings(IDictionary<(Of <String, IElementDef>)>).)
static memberDIRECTTIME
static memberDIRECTTIME_UNITOFMEASURE
static memberFREQUENCYTIME
static memberFREQUENCYTIME_CODE
static memberFREQUENCYTIME_OTHERCODELIST
static memberINDIRECTTIME
static memberINDIRECTTIME_UNITOFMEASURE
static memberLEASTRESTRICTIVEENVIRONMENT
static memberLEASTRESTRICTIVEENVIRONMENT_CODE
static memberLEASTRESTRICTIVEENVIRONMENT_OTHERCODELIST
Load()() (Overrides SdoLibraryImpl.Load()().)
static memberMANAGINGPUBLICAGENCY
static memberMANAGINGPUBLICAGENCY_SIF_REFOBJECT
static memberMANAGINGSCHOOL
static memberMANAGINGSCHOOL_SIF_REFOBJECT
static memberPARTCTRANSITIONMEETINGNOTHELDREASON
static memberPARTCTRANSITIONMEETINGNOTHELDREASON_CODE
static memberPARTCTRANSITIONMEETINGNOTHELDREASON_OTHERCODELIST
static memberPARTCTRANSITIONMEETINGNOTHELDREASONS
static memberPARTCTRANSITIONMEETINGNOTHELDREASONS_PARTCTRANSITIONMEETINGNOTHELDREASON
static memberPARTCTRANSITIONMEETINGOUTCOME
static memberPARTCTRANSITIONMEETINGOUTCOME_CODE
static memberPARTCTRANSITIONMEETINGOUTCOME_OTHERCODELIST
static memberPARTCTRANSITIONMEETINGOUTCOMES
static memberPARTCTRANSITIONMEETINGOUTCOMES_PARTCTRANSITIONMEETINGOUTCOME
static memberPROGRAMAVAILABILITY
static memberPROGRAMAVAILABILITY_CODE
static memberPROGRAMAVAILABILITY_OTHERCODELIST
static memberPROGRAMEXITREASON
static memberPROGRAMEXITREASON_CODE
static memberPROGRAMEXITREASON_CODETYPE
static memberPROGRAMEXITREASON_OTHERCODELIST
static memberPROGRAMFUNDINGSOURCES
static memberPROGRAMFUNDINGSOURCES_PROGRAMFUNDINGSOURCE
static memberPROGRAMPLANTYPE
static memberPROGRAMPLANTYPE_CODE
static memberPROGRAMPLANTYPE_OTHERCODELIST
static memberPROJECTEDEXITREASON
static memberPROJECTEDEXITREASON_CODESET
static memberREFERRALSOURCE
static memberREFERRALSOURCE_CODE
static memberREFERRALSOURCE_OTHERCODELIST
static memberSCHOOLWHERESERVICEDELIVERED
static memberSCHOOLWHERESERVICEDELIVERED_SIF_REFOBJECT
static memberSERVICE
static memberSERVICE_CODE
static memberSERVICE_CODETYPE
static memberSERVICE_OTHERCODELIST
static memberSERVICE_TYPE
static memberSERVICEFUNDINGSOURCE
static memberSERVICEFUNDINGSOURCE_CODE
static memberSERVICEFUNDINGSOURCE_OTHERCODELIST
static memberSERVICEFUNDINGSOURCES
static memberSERVICEFUNDINGSOURCES_SERVICEFUNDINGSOURCE
static memberSERVICEPROVIDERTYPE
static memberSERVICEPROVIDERTYPE_CODE
static memberSERVICEPROVIDERTYPE_OTHERCODELIST
static memberSERVICESETTING
static memberSERVICESETTING_CODE
static memberSERVICESETTING_CODETYPE
static memberSERVICESETTING_OTHERCODELIST
static memberSERVICINGPUBLICAGENCY
static memberSERVICINGPUBLICAGENCY_SIF_REFOBJECT
static memberSERVICINGSCHOOL
static memberSERVICINGSCHOOL_SIF_REFOBJECT
static memberSTUDENTPARTICIPATION
static memberSTUDENTPARTICIPATION_BIPDATE
static memberSTUDENTPARTICIPATION_ENTRYPERSON
static memberSTUDENTPARTICIPATION_EVALUATIONDATE
static memberSTUDENTPARTICIPATION_EVALUATIONEXTENSIONDATE
static memberSTUDENTPARTICIPATION_EVALUATIONPARENTALCONSENTDATE
static memberSTUDENTPARTICIPATION_EXCEPTIONALITYCATEGORIES
static memberSTUDENTPARTICIPATION_EXTENDEDDAY
static memberSTUDENTPARTICIPATION_EXTENDEDSCHOOLYEAR
static memberSTUDENTPARTICIPATION_EXTENSIONCOMMENTS
static memberSTUDENTPARTICIPATION_FBADATE
static memberSTUDENTPARTICIPATION_GIFTEDELIGIBILITYCRITERIA
static memberSTUDENTPARTICIPATION_LEASTRESTRICTIVEENVIRONMENT
static memberSTUDENTPARTICIPATION_MANAGINGPUBLICAGENCY
static memberSTUDENTPARTICIPATION_MANAGINGSCHOOL
static memberSTUDENTPARTICIPATION_NOREPDATE
static memberSTUDENTPARTICIPATION_PARTCTRANSITIONMEETINGDATE
static memberSTUDENTPARTICIPATION_PARTCTRANSITIONMEETINGNOTHELDREASONS
static memberSTUDENTPARTICIPATION_PARTCTRANSITIONMEETINGOUTCOMES
static memberSTUDENTPARTICIPATION_PARTICIPATIONCONTACT
static memberSTUDENTPARTICIPATION_PLACEMENTPARENTALCONSENTDATE
static memberSTUDENTPARTICIPATION_PLANNEDASSESSMENTPARTICIPATION
static memberSTUDENTPARTICIPATION_PRIVATENOTPLACEDBYPUBLIC
static memberSTUDENTPARTICIPATION_PROGRAMAVAILABILITY
static memberSTUDENTPARTICIPATION_PROGRAMELIGIBILITYDATE
static memberSTUDENTPARTICIPATION_PROGRAMEXITDATE
static memberSTUDENTPARTICIPATION_PROGRAMEXITREASON
static memberSTUDENTPARTICIPATION_PROGRAMFUNDINGSOURCES
static memberSTUDENTPARTICIPATION_PROGRAMPLACEMENTDATE
static memberSTUDENTPARTICIPATION_PROGRAMPLANDATE
static memberSTUDENTPARTICIPATION_PROGRAMPLANEFFECTIVEDATE
static memberSTUDENTPARTICIPATION_PROGRAMPLANTYPE
static memberSTUDENTPARTICIPATION_PROGRAMREVIEWDATE
static memberSTUDENTPARTICIPATION_PROGRAMSTATUS
static memberSTUDENTPARTICIPATION_PROGRAMTYPE
static memberSTUDENTPARTICIPATION_PROJECTEDEXITDATE
static memberSTUDENTPARTICIPATION_PROJECTEDEXITREASON
static memberSTUDENTPARTICIPATION_REEVALUATIONDATE
static memberSTUDENTPARTICIPATION_REFERRALDATE
static memberSTUDENTPARTICIPATION_REFERRALSOURCE
static memberSTUDENTPARTICIPATION_REFID
static memberSTUDENTPARTICIPATION_SIF_EXTENDEDELEMENTS
static memberSTUDENTPARTICIPATION_SIF_METADATA
static memberSTUDENTPARTICIPATION_SPROGRAMEXITREASON
static memberSTUDENTPARTICIPATION_STUDENTPARTICIPATIONASOFDATE
static memberSTUDENTPARTICIPATION_STUDENTPERSONALREFID
static memberSTUDENTPARTICIPATION_STUDENTSPECIALEDUCATIONFTE
static memberSTUDENTPARTICIPATION_TRANSITIONPLANNING
static memberSTUDENTPARTICIPATION_TYPE
static memberSTUDENTPLACEMENT
static memberSTUDENTPLACEMENT_AGENCYTYPE
static memberSTUDENTPLACEMENT_ASSISTIVETECHNOLOGY
static memberSTUDENTPLACEMENT_DIRECTTIME
static memberSTUDENTPLACEMENT_ENDDATE
static memberSTUDENTPLACEMENT_ENTRYPERSON
static memberSTUDENTPLACEMENT_FREQUENCYTIME
static memberSTUDENTPLACEMENT_INCLUDEDINSPECIALEDUCATIONFTE
static memberSTUDENTPLACEMENT_INDIRECTTIME
static memberSTUDENTPLACEMENT_LATESTSTARTDATE
static memberSTUDENTPLACEMENT_REFID
static memberSTUDENTPLACEMENT_SCHOOLWHERESERVICEDELIVERED
static memberSTUDENTPLACEMENT_SERVICE
static memberSTUDENTPLACEMENT_SERVICECATEGORY
static memberSTUDENTPLACEMENT_SERVICEFUNDINGSOURCES
static memberSTUDENTPLACEMENT_SERVICEPROVIDERAGENCY
static memberSTUDENTPLACEMENT_SERVICEPROVIDERNAME
static memberSTUDENTPLACEMENT_SERVICEPROVIDERTYPE
static memberSTUDENTPLACEMENT_SERVICESETTING
static memberSTUDENTPLACEMENT_SERVICINGPUBLICAGENCY
static memberSTUDENTPLACEMENT_SERVICINGSCHOOL
static memberSTUDENTPLACEMENT_SIF_EXTENDEDELEMENTS
static memberSTUDENTPLACEMENT_SIF_METADATA
static memberSTUDENTPLACEMENT_SPECIALNEEDSTRANSPORTATION
static memberSTUDENTPLACEMENT_STARTDATE
static memberSTUDENTPLACEMENT_STUDENTPARTICIPATIONREFID
static memberSTUDENTPLACEMENT_STUDENTPERSONALREFID
static memberSTUDENTPLACEMENT_STUDENTPLACEMENTASOFDATE
static memberSTUDENTPLACEMENT_TOTALSERVICEDURATION
static memberSTUDENTPLACEMENT_WHENSERVICEPROVIDED
static memberSTUDENTPROGRAMACCOMMODATION
static memberSTUDENTPROGRAMACCOMMODATION_ACCOMMODATIONS
static memberSTUDENTPROGRAMACCOMMODATION_STUDENTPARTICIPATIONREFID
static memberSTUDENTPROGRAMACCOMMODATION_STUDENTPROGRAMTYPE
static memberSTUDENTPROGRAMACCOMMODATIONS
static memberSTUDENTPROGRAMACCOMMODATIONS_STUDENTPROGRAMACCOMMODATION
static memberSTUDENTPROGRAMTYPE
static memberSTUDENTPROGRAMTYPE_CODE
static memberSTUDENTPROGRAMTYPE_OTHERCODELIST
static memberTESTACCOMMODATION
static memberTESTACCOMMODATION_ACTUALTESTADMINISTRATIONDATE
static memberTESTACCOMMODATION_ASSESSMENTREGISTRATIONREFID
static memberTESTACCOMMODATION_AUTHORIZEDACTUAL
static memberTESTACCOMMODATION_GRADELEVEL
static memberTESTACCOMMODATION_LEAINFOREFID
static memberTESTACCOMMODATION_LOCALID
static memberTESTACCOMMODATION_NAME
static memberTESTACCOMMODATION_PLANNEDTESTADMINISTRATIONDATE
static memberTESTACCOMMODATION_REFID
static memberTESTACCOMMODATION_SCHOOLINFOREFID
static memberTESTACCOMMODATION_SIF_EXTENDEDELEMENTS
static memberTESTACCOMMODATION_SIF_METADATA
static memberTESTACCOMMODATION_STATEDISTRICTID
static memberTESTACCOMMODATION_STATEPROVINCEID
static memberTESTACCOMMODATION_STATESCHOOLID
static memberTESTACCOMMODATION_STUDENTPERSONALREFID
static memberTESTACCOMMODATION_STUDENTPROGRAMACCOMMODATIONS
static memberTESTACCOMMODATION_TESTADMINISTRATION
static memberTESTACCOMMODATION_TESTADMINISTRATIONDATERANGE
static memberTESTACCOMMODATION_TESTGRADELEVEL
static memberTESTACCOMMODATION_TESTSUBJECTAREA
static memberTESTACCOMMODATION_TESTTYPE
static memberTIMEUNIT
static memberTIMEUNIT_UNITOFMEASURE
static memberTOTALSERVICEDURATION
static memberTOTALSERVICEDURATION_UNITOFMEASURE
static memberTRANSITIONPLANNING
static memberTRANSITIONPLANNING_CODESET
static memberWHENSERVICEPROVIDED
static memberWHENSERVICEPROVIDED_CODE
static memberWHENSERVICEPROVIDED_OTHERCODELIST
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
 ProgramsDTD

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