SIFWorks ADK 2.0
TransDTD Class
NamespacesEdustructures.SifWorks.TransTransDTD

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

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



IconMemberDescription
TransDTDTransDTDNew()()
AddElementMappings(IDictionary<(Of <String, IElementDef>)>) (Overrides SdoLibraryImpl.AddElementMappings(IDictionary<(Of <String, IElementDef>)>).)
static memberBUS
static memberBUS_BUSINFOREFID
static memberBUSDRIVER
static memberBUSDRIVER_EMPLOYEEPERSONALREFID
static memberBUSDRIVER_NAME
static memberBUSDRIVER_STATUS
static memberBUSEQUIPMENT
static memberBUSEQUIPMENT_DESCRIPTION
static memberBUSEQUIPMENT_REFID
static memberBUSEQUIPMENT_SIF_EXTENDEDELEMENTS
static memberBUSEQUIPMENT_SIF_METADATA
static memberBUSINFO
static memberBUSINFO_CONTRACTOR
static memberBUSINFO_EQUIPMENTLIST
static memberBUSINFO_REFID
static memberBUSINFO_SEATINGCAPACITY
static memberBUSINFO_SIF_EXTENDEDELEMENTS
static memberBUSINFO_SIF_METADATA
static memberBUSINFO_VEHICLENUMBER
static memberBUSPOSITIONINFO
static memberBUSPOSITIONINFO_BUSDRIVER
static memberBUSPOSITIONINFO_BUSINFOREFID
static memberBUSPOSITIONINFO_BUSSTAFFLIST
static memberBUSPOSITIONINFO_DATE
static memberBUSPOSITIONINFO_GRIDLOCATION
static memberBUSPOSITIONINFO_ODOMETER
static memberBUSPOSITIONINFO_OTHERSTATUS
static memberBUSPOSITIONINFO_ROUTESTATUS
static memberBUSPOSITIONINFO_SIF_EXTENDEDELEMENTS
static memberBUSPOSITIONINFO_SIF_METADATA
static memberBUSPOSITIONINFO_SPEEDOMETER
static memberBUSPOSITIONINFO_STUDENTS
static memberBUSPOSITIONINFO_TELEMATICSID
static memberBUSPOSITIONINFO_TELEMETRYLIST
static memberBUSPOSITIONINFO_TIME
static memberBUSROUTEDETAIL
static memberBUSROUTEDETAIL_ARRIVALTIME
static memberBUSROUTEDETAIL_BUSROUTEINFOREFID
static memberBUSROUTEDETAIL_BUSSTOPINFOREFID
static memberBUSROUTEDETAIL_REFID
static memberBUSROUTEDETAIL_SIF_EXTENDEDELEMENTS
static memberBUSROUTEDETAIL_SIF_METADATA
static memberBUSROUTEINFO
static memberBUSROUTEINFO_BUSINFOREFID
static memberBUSROUTEINFO_DESCRIPTION
static memberBUSROUTEINFO_MAXIMUMLOAD
static memberBUSROUTEINFO_NAME
static memberBUSROUTEINFO_REFID
static memberBUSROUTEINFO_ROUTEDISTANCELOADED
static memberBUSROUTEINFO_ROUTEDISTANCETOTAL
static memberBUSROUTEINFO_ROUTEDURATIONLOADED
static memberBUSROUTEINFO_ROUTEDURATIONTOTAL
static memberBUSROUTEINFO_ROUTENUMBER
static memberBUSROUTEINFO_ROUTETYPE
static memberBUSROUTEINFO_SIF_EXTENDEDELEMENTS
static memberBUSROUTEINFO_SIF_METADATA
static memberBUSSTAFF
static memberBUSSTAFF_EMPLOYEEPERSONALREFID
static memberBUSSTAFF_NAME
static memberBUSSTAFF_STATUS
static memberBUSSTAFFLIST
static memberBUSSTAFFLIST_BUSSTAFF
static memberBUSSTOP
static memberBUSSTOP_BUSSTOPINFOREFID
static memberBUSSTOPINFO
static memberBUSSTOPINFO_DESCRIPTION
static memberBUSSTOPINFO_GRIDLOCATION
static memberBUSSTOPINFO_REFID
static memberBUSSTOPINFO_SIF_EXTENDEDELEMENTS
static memberBUSSTOPINFO_SIF_METADATA
static memberDISEMBARKBUSROUTEDETAIL
static memberDISEMBARKBUSROUTEDETAIL_SIF_REFOBJECT
static memberEMBARKBUSROUTEDETAIL
static memberEMBARKBUSROUTEDETAIL_SIF_REFOBJECT
static memberEMPLINK
static memberEMPLINK_EMPLOYEEPERSONALREFID
static memberEQUIPMENT
static memberEQUIPMENT_BUSEQUIPMENTREFID
static memberEQUIPMENT_COUNT
static memberEQUIPMENTLIST
static memberEQUIPMENTLIST_EQUIPMENT
static memberHOMEBUSROUTEDETAIL
static memberHOMEBUSROUTEDETAIL_SIF_REFOBJECT
Load()() (Overrides SdoLibraryImpl.Load()().)
static memberODOMETER
static memberODOMETER_UNIT
static memberROUTEDISTANCE
static memberROUTEDISTANCE_UNIT
static memberROUTESTATUS
static memberROUTESTATUS_BUSROUTEINFOREFID
static memberROUTESTATUS_STATUS
static memberSCHOOLBUSROUTEDETAIL
static memberSCHOOLBUSROUTEDETAIL_SIF_REFOBJECT
static memberSPEEDOMETER
static memberSPEEDOMETER_UNIT
static memberSTUDENTTRANSPORTINFO
static memberSTUDENTTRANSPORTINFO_DAYOFWEEK
static memberSTUDENTTRANSPORTINFO_ELIGIBILITY
static memberSTUDENTTRANSPORTINFO_HOMEBUSROUTEDETAIL
static memberSTUDENTTRANSPORTINFO_REFID
static memberSTUDENTTRANSPORTINFO_SCHOOLBUSROUTEDETAIL
static memberSTUDENTTRANSPORTINFO_SCHOOLINFOREFID
static memberSTUDENTTRANSPORTINFO_SIF_EXTENDEDELEMENTS
static memberSTUDENTTRANSPORTINFO_SIF_METADATA
static memberSTUDENTTRANSPORTINFO_STUDENTPERSONALREFID
static memberSTUDENTTRANSPORTINFO_TRANSFERPOINTS
static memberSTUDENTTRANSPORTINFO_TYPE
static memberTELEMETRY
static memberTELEMETRYLIST
static memberTELEMETRYLIST_TELEMETRY
static memberTRANSFERPOINT
static memberTRANSFERPOINT_DISEMBARKBUSROUTEDETAIL
static memberTRANSFERPOINT_EMBARKBUSROUTEDETAIL
static memberTRANSFERPOINTS
static memberTRANSFERPOINTS_TRANSFERPOINT
static memberTRANSSTUDENT
static memberTRANSSTUDENT_STATUS
static memberTRANSSTUDENT_STUDENTPERSONALREFID
static memberTRANSSTUDENTS
static memberTRANSSTUDENTS_STUDENT
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
 TransDTD

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