SIFWorks ADK 2.0
FoodDTD Class
NamespacesEdustructures.SifWorks.FoodFoodDTD

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

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



IconMemberDescription
FoodDTDFoodDTDNew()()
AddElementMappings(IDictionary<(Of <String, IElementDef>)>) (Overrides SdoLibraryImpl.AddElementMappings(IDictionary<(Of <String, IElementDef>)>).)
static memberAGENCIES
static memberAGENCIES_AGENCY
static memberAGENCY
static memberAGENCY_NAME
static memberAGENCY_RATES
static memberAGENCY_TYPE
static memberCHARGETOCHILD
static memberCHARGETOCHILD_CURRENCY
static memberCOST
static memberCOST_CURRENCY
static memberCOUNT
static memberCOUNT_AMOUNT
static memberCOUNT_EARNEDSTATUS
static memberCOUNT_MEALSTATUS
static memberCOUNT_MEALTYPE
static memberCOUNT_TAX
static memberCOUNT_VALUE
static memberCOUNTS
static memberCOUNTS_COUNT
static memberCUSTOMER
static memberCUSTOMER_EARNEDSTATUS
static memberCUSTOMER_MEALSTATUS
static memberCUSTOMER_SIF_REFID
static memberCUSTOMER_SIF_REFOBJECT
static memberEARNEDSTATUS
static memberEARNEDSTATUS_ENDDATE
static memberEARNEDSTATUS_STARTDATE
static memberEARNEDSTATUS_TYPE
static memberFOODSERVICEITEM
static memberFOODSERVICEITEM_DESCRIPTION
static memberFOODSERVICEITEM_ELECTRONICIDLIST
static memberFOODSERVICEITEM_ITEMCATEGORY
static memberFOODSERVICEITEM_LOCALID
static memberFOODSERVICEITEM_REFID
static memberFOODSERVICEITEM_SIF_EXTENDEDELEMENTS
static memberFOODSERVICEITEM_SIF_METADATA
static memberFOODSERVICEITEMPORTION
static memberFOODSERVICEITEMPORTION_DESCRIPTION
static memberFOODSERVICEITEMPORTION_FOODSERVICEITEMUNITREFID
static memberFOODSERVICEITEMPORTION_ITEMPORTIONQUANTITY
static memberFOODSERVICEITEMPORTION_ITEMPORTIONTYPE
static memberFOODSERVICEITEMPORTION_REFID
static memberFOODSERVICEITEMPORTION_SIF_EXTENDEDELEMENTS
static memberFOODSERVICEITEMPORTION_SIF_METADATA
static memberFOODSERVICEITEMSALES
static memberFOODSERVICEITEMSALES_DATE
static memberFOODSERVICEITEMSALES_ITEMQUANTITIES
static memberFOODSERVICEITEMSALES_PROGRAM
static memberFOODSERVICEITEMSALES_REFID
static memberFOODSERVICEITEMSALES_SCHOOLINFOREFID
static memberFOODSERVICEITEMSALES_SIF_EXTENDEDELEMENTS
static memberFOODSERVICEITEMSALES_SIF_METADATA
static memberFOODSERVICEITEMUNIT
static memberFOODSERVICEITEMUNIT_DESCRIPTION
static memberFOODSERVICEITEMUNIT_FOODSERVICEITEMREFID
static memberFOODSERVICEITEMUNIT_GRAMWEIGHT
static memberFOODSERVICEITEMUNIT_MEASUREDESCRIPTIONCODE
static memberFOODSERVICEITEMUNIT_REFID
static memberFOODSERVICEITEMUNIT_SIF_EXTENDEDELEMENTS
static memberFOODSERVICEITEMUNIT_SIF_METADATA
static memberFOODSERVICEMEALPRICES
static memberFOODSERVICEMEALPRICES_PRICES
static memberFOODSERVICEMEALPRICES_PROGRAM
static memberFOODSERVICEMEALPRICES_REFID
static memberFOODSERVICEMEALPRICES_SCHOOLINFOREFID
static memberFOODSERVICEMEALPRICES_SIF_EXTENDEDELEMENTS
static memberFOODSERVICEMEALPRICES_SIF_METADATA
static memberFOODSERVICEMENUPLAN
static memberFOODSERVICEMENUPLAN_DESCRIPTION
static memberFOODSERVICEMENUPLAN_GRADELEVELS
static memberFOODSERVICEMENUPLAN_MENUPLANDATE
static memberFOODSERVICEMENUPLAN_MENUPLANQUANTITIES
static memberFOODSERVICEMENUPLAN_PROGRAM
static memberFOODSERVICEMENUPLAN_PROJECTEDPARTICIPATION
static memberFOODSERVICEMENUPLAN_REFID
static memberFOODSERVICEMENUPLAN_SCHOOLINFOREFID
static memberFOODSERVICEMENUPLAN_SIF_EXTENDEDELEMENTS
static memberFOODSERVICEMENUPLAN_SIF_METADATA
static memberFOODSERVICEMILKSALES
static memberFOODSERVICEMILKSALES_DATE
static memberFOODSERVICEMILKSALES_PROGRAM
static memberFOODSERVICEMILKSALES_REFID
static memberFOODSERVICEMILKSALES_SALEQUANTITIES
static memberFOODSERVICEMILKSALES_SCHOOLINFOREFID
static memberFOODSERVICEMILKSALES_SIF_EXTENDEDELEMENTS
static memberFOODSERVICEMILKSALES_SIF_METADATA
static memberFOODSERVICEPURCHASETRANSACTION
static memberFOODSERVICEPURCHASETRANSACTION_FOODSERVICETRANSACTIONREFID
static memberFOODSERVICEPURCHASETRANSACTION_PURCHASEQUANTITIES
static memberFOODSERVICEPURCHASETRANSACTION_REFID
static memberFOODSERVICEPURCHASETRANSACTION_SIF_EXTENDEDELEMENTS
static memberFOODSERVICEPURCHASETRANSACTION_SIF_METADATA
static memberFOODSERVICEREIMBURSEMENTRATES
static memberFOODSERVICEREIMBURSEMENTRATES_AGENCIES
static memberFOODSERVICEREIMBURSEMENTRATES_ENDDATE
static memberFOODSERVICEREIMBURSEMENTRATES_PROGRAM
static memberFOODSERVICEREIMBURSEMENTRATES_REFID
static memberFOODSERVICEREIMBURSEMENTRATES_SCHOOLINFOREFID
static memberFOODSERVICEREIMBURSEMENTRATES_SIF_EXTENDEDELEMENTS
static memberFOODSERVICEREIMBURSEMENTRATES_SIF_METADATA
static memberFOODSERVICEREIMBURSEMENTRATES_STARTDATE
static memberFOODSERVICESALES
static memberFOODSERVICESALES_DATE
static memberFOODSERVICESALES_PROGRAM
static memberFOODSERVICESALES_REFID
static memberFOODSERVICESALES_SALESAMOUNTS
static memberFOODSERVICESALES_SCHOOLINFOREFID
static memberFOODSERVICESALES_SIF_EXTENDEDELEMENTS
static memberFOODSERVICESALES_SIF_METADATA
static memberFOODSERVICESTAFFENROLLMENTCOUNT
static memberFOODSERVICESTAFFENROLLMENTCOUNT_COUNTS
static memberFOODSERVICESTAFFENROLLMENTCOUNT_DATE
static memberFOODSERVICESTAFFENROLLMENTCOUNT_PROGRAM
static memberFOODSERVICESTAFFENROLLMENTCOUNT_SCHOOLINFOREFID
static memberFOODSERVICESTAFFENROLLMENTCOUNT_SIF_EXTENDEDELEMENTS
static memberFOODSERVICESTAFFENROLLMENTCOUNT_SIF_METADATA
static memberFOODSERVICESTAFFMEALCOUNTS
static memberFOODSERVICESTAFFMEALCOUNTS_COUNTS
static memberFOODSERVICESTAFFMEALCOUNTS_DATE
static memberFOODSERVICESTAFFMEALCOUNTS_PROGRAM
static memberFOODSERVICESTAFFMEALCOUNTS_REFID
static memberFOODSERVICESTAFFMEALCOUNTS_SCHOOLINFOREFID
static memberFOODSERVICESTAFFMEALCOUNTS_SIF_EXTENDEDELEMENTS
static memberFOODSERVICESTAFFMEALCOUNTS_SIF_METADATA
static memberFOODSERVICESTUDENTENROLLMENTCOUNT
static memberFOODSERVICESTUDENTENROLLMENTCOUNT_COUNTS
static memberFOODSERVICESTUDENTENROLLMENTCOUNT_DATE
static memberFOODSERVICESTUDENTENROLLMENTCOUNT_PROGRAM
static memberFOODSERVICESTUDENTENROLLMENTCOUNT_SCHOOLINFOREFID
static memberFOODSERVICESTUDENTENROLLMENTCOUNT_SIF_EXTENDEDELEMENTS
static memberFOODSERVICESTUDENTENROLLMENTCOUNT_SIF_METADATA
static memberFOODSERVICESTUDENTMEALCOUNTS
static memberFOODSERVICESTUDENTMEALCOUNTS_COUNTS
static memberFOODSERVICESTUDENTMEALCOUNTS_DATE
static memberFOODSERVICESTUDENTMEALCOUNTS_PROGRAM
static memberFOODSERVICESTUDENTMEALCOUNTS_REFID
static memberFOODSERVICESTUDENTMEALCOUNTS_SCHOOLINFOREFID
static memberFOODSERVICESTUDENTMEALCOUNTS_SIF_EXTENDEDELEMENTS
static memberFOODSERVICESTUDENTMEALCOUNTS_SIF_METADATA
static memberFOODSERVICETRANSACTION
static memberFOODSERVICETRANSACTION_AMOUNT
static memberFOODSERVICETRANSACTION_CUSTOMER
static memberFOODSERVICETRANSACTION_DESCRIPTION
static memberFOODSERVICETRANSACTION_FSAMOUNT
static memberFOODSERVICETRANSACTION_PROGRAM
static memberFOODSERVICETRANSACTION_REFID
static memberFOODSERVICETRANSACTION_SCHOOLINFOREFID
static memberFOODSERVICETRANSACTION_SIF_EXTENDEDELEMENTS
static memberFOODSERVICETRANSACTION_SIF_METADATA
static memberFOODSERVICETRANSACTION_TAX
static memberFOODSERVICETRANSACTION_TRANSACTIONDATE
static memberFOODSERVICETRANSACTION_TRANSACTIONTIME
static memberFOODSERVICETRANSACTION_TRANSACTIONTYPES
static memberFOODSERVICETRANSACTION_VOIDED
static memberFOODSERVICETRANSACTIONDETAILS
static memberFOODSERVICETRANSACTIONDETAILS_AMOUNTS
static memberFOODSERVICETRANSACTIONDETAILS_DESCRIPTION
static memberFOODSERVICETRANSACTIONDETAILS_FOODSERVICETRANSACTIONREFID
static memberFOODSERVICETRANSACTIONDETAILS_REFID
static memberFOODSERVICETRANSACTIONDETAILS_SIF_EXTENDEDELEMENTS
static memberFOODSERVICETRANSACTIONDETAILS_SIF_METADATA
static memberFOODSERVICETRANSACTIONPAYMETHOD
static memberFOODSERVICETRANSACTIONPAYMETHOD_FOODSERVICETRANSACTIONREFID
static memberFOODSERVICETRANSACTIONPAYMETHOD_REFID
static memberFOODSERVICETRANSACTIONPAYMETHOD_SIF_EXTENDEDELEMENTS
static memberFOODSERVICETRANSACTIONPAYMETHOD_SIF_METADATA
static memberFOODSERVICETRANSACTIONPAYMETHOD_TRANSACTIONPAYMETHODS
static memberFSAMOUNT
static memberFSAMOUNT_CREDITS
static memberFSAMOUNT_TYPE
static memberFSAMOUNTS
static memberFSAMOUNTS_AMOUNT
static memberHISTORICALMEALSTATUS
static memberHISTORICALMEALSTATUS_MEALSTATUS
static memberITEMQUANTITIES
static memberITEMQUANTITIES_ITEMQUANTITY
static memberITEMQUANTITY
static memberITEMQUANTITY_COST
static memberITEMQUANTITY_FOODSERVICEITEMPORTIONREFID
static memberITEMQUANTITY_GRADELEVELS
static memberITEMQUANTITY_MEALTYPE
static memberITEMQUANTITY_VALUE
Load()() (Overrides SdoLibraryImpl.Load()().)
static memberMEALSTATUS
static memberMEALSTATUS_ENDDATE
static memberMEALSTATUS_SCHOOLYEAR
static memberMEALSTATUS_STARTDATE
static memberMEALSTATUS_TYPE
static memberMENUPLANQUANTITIES
static memberMENUPLANQUANTITIES_MENUPLANQUANTITY
static memberMENUPLANQUANTITY
static memberMENUPLANQUANTITY_FOODSERVICEITEMPORTIONREFID
static memberMENUPLANQUANTITY_MENUCATEGORY
static memberPRICE
static memberPRICE_GRADELEVELS
static memberPRICE_MEALSTATUS
static memberPRICE_MEALTYPE
static memberPRICE_VALUE
static memberPRICES
static memberPRICES_PRICE
static memberPURCHASEQUANTITIES
static memberPURCHASEQUANTITIES_PURCHASEQUANTITY
static memberPURCHASEQUANTITY
static memberPURCHASEQUANTITY_EARNED
static memberPURCHASEQUANTITY_FOODSERVICEITEMPORTIONREFID
static memberPURCHASEQUANTITY_MEALTYPE
static memberPURCHASEQUANTITY_VALUE
static memberRATE
static memberRATE_MEALSTATUS
static memberRATE_SEVERENEED
static memberRATE_VALUE
static memberRATES
static memberRATES_RATE
static memberSALEQUANTITIES
static memberSALEQUANTITIES_SALEQUANTITY
static memberSALEQUANTITY
static memberSALEQUANTITY_CHARGETOCHILD
static memberSALEQUANTITY_MEALSTATUS
static memberSALEQUANTITY_SALEUNIT
static memberSALEQUANTITY_VALUE
static memberSALESAMOUNT
static memberSALESAMOUNT_ACCOUNTTYPE
static memberSALESAMOUNT_TYPE
static memberSALESAMOUNTS
static memberSALESAMOUNTS_SALESAMOUNT
static memberSTAFFMEAL
static memberSTAFFMEAL_AMOUNTS
static memberSTAFFMEAL_EARNEDSTATUS
static memberSTAFFMEAL_LASTBREAKFASTDATE
static memberSTAFFMEAL_LASTLUNCHDATE
static memberSTAFFMEAL_SIF_EXTENDEDELEMENTS
static memberSTAFFMEAL_SIF_METADATA
static memberSTAFFMEAL_STAFFPERSONALREFID
static memberSTUDENTMEAL
static memberSTUDENTMEAL_AMOUNTS
static memberSTUDENTMEAL_BRKCREDITS
static memberSTUDENTMEAL_CASH
static memberSTUDENTMEAL_HISTORICALMEALSTATUS
static memberSTUDENTMEAL_LASTBREAKFASTDATE
static memberSTUDENTMEAL_LASTBRKDATE
static memberSTUDENTMEAL_LASTLUNCHDATE
static memberSTUDENTMEAL_LASTLUNDATE
static memberSTUDENTMEAL_LUNCREDITS
static memberSTUDENTMEAL_MEALSTATUS
static memberSTUDENTMEAL_SCHOOLYEAR
static memberSTUDENTMEAL_SIF_EXTENDEDELEMENTS
static memberSTUDENTMEAL_SIF_METADATA
static memberSTUDENTMEAL_STUDENTPERSONALREFID
static memberTAX
static memberTAX_CURRENCY
static memberTRANSACTIONPAYMETHOD
static memberTRANSACTIONPAYMETHOD_AMOUNTS
static memberTRANSACTIONPAYMETHOD_TYPE
static memberTRANSACTIONPAYMETHODS
static memberTRANSACTIONPAYMETHODS_TRANSACTIONPAYMETHOD
static memberTRANSACTIONTYPE
static memberTRANSACTIONTYPES
static memberTRANSACTIONTYPES_TRANSACTIONTYPE
static memberVALUE
static memberVALUE_CURRENCY
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
 FoodDTD

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