SIFWorks ADK 2.0
GradebookDTD Class
NamespacesEdustructures.SifWorks.GradebookGradebookDTD

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

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



IconMemberDescription
GradebookDTDGradebookDTDNew()()
AddElementMappings(IDictionary<(Of <String, IElementDef>)>) (Overrides SdoLibraryImpl.AddElementMappings(IDictionary<(Of <String, IElementDef>)>).)
static memberAUDITINFO
static memberAUDITINFO_CREATIONDATETIME
static memberAUDITINFO_CREATIONUSER
static memberCREATIONUSER
static memberCREATIONUSER_TYPE
static memberCREATIONUSER_USERID
static memberDETAILEDDESCRIPTION
static memberDETAILEDDESCRIPTION_TYPE
static memberGRADINGASSIGNMENT
static memberGRADINGASSIGNMENT_CREATEDATE
static memberGRADINGASSIGNMENT_DESCRIPTION
static memberGRADINGASSIGNMENT_DETAILEDDESCRIPTION
static memberGRADINGASSIGNMENT_DUEDATE
static memberGRADINGASSIGNMENT_GRADINGCATEGORYREFID
static memberGRADINGASSIGNMENT_POINTSPOSSIBLE
static memberGRADINGASSIGNMENT_REFID
static memberGRADINGASSIGNMENT_SCHOOLINFOREFID
static memberGRADINGASSIGNMENT_SECTIONINFOREFID
static memberGRADINGASSIGNMENT_SIF_EXTENDEDELEMENTS
static memberGRADINGASSIGNMENT_SIF_METADATA
static memberGRADINGASSIGNMENT_TERMINFOREFID
static memberGRADINGASSIGNMENT_WEIGHT
static memberGRADINGASSIGNMENTSCORE
static memberGRADINGASSIGNMENTSCORE_GRADINGASSIGNMENTREFID
static memberGRADINGASSIGNMENTSCORE_SCHOOLINFOREFID
static memberGRADINGASSIGNMENTSCORE_SCOREDESCRIPTION
static memberGRADINGASSIGNMENTSCORE_SCORELETTER
static memberGRADINGASSIGNMENTSCORE_SCOREPERCENT
static memberGRADINGASSIGNMENTSCORE_SCOREPOINTS
static memberGRADINGASSIGNMENTSCORE_SECTIONINFOREFID
static memberGRADINGASSIGNMENTSCORE_SIF_EXTENDEDELEMENTS
static memberGRADINGASSIGNMENTSCORE_SIF_METADATA
static memberGRADINGASSIGNMENTSCORE_STUDENTPERSONALREFID
static memberGRADINGCATEGORY
static memberGRADINGCATEGORY_DESCRIPTION
static memberGRADINGCATEGORY_REFID
static memberGRADINGCATEGORY_SCHOOLINFOREFID
static memberGRADINGCATEGORY_SECTIONINFOREFID
static memberGRADINGCATEGORY_SIF_EXTENDEDELEMENTS
static memberGRADINGCATEGORY_SIF_METADATA
static memberGRADINGCATEGORY_TERMINFOREFID
static memberLETTER
static memberLETTER_ISACCEPTED
static memberLETTER_VALIDMARK
Load()() (Overrides SdoLibraryImpl.Load()().)
static memberMARK
static memberMARK_LETTER
static memberMARK_MARKINFOREFID
static memberMARK_NARRATIVE
static memberMARK_NUMERIC
static memberMARK_PERCENTAGE
static memberMARKINFO
static memberMARKINFO_DESCRIPTION
static memberMARKINFO_MARKVALUEINFOREFID
static memberMARKINFO_REFID
static memberMARKINFO_SCHOOLINFOREFID
static memberMARKINFO_SCHOOLYEAR
static memberMARKINFO_SIF_EXTENDEDELEMENTS
static memberMARKINFO_SIF_METADATA
static memberMARKINFOLIST
static memberMARKINFOLIST_MARKINFOREFID
static memberMARKINFOLIST_SIF_ACTION
static memberMARKINFOLIST_TERMINFOREFID
static memberMARKINFOREFID
static memberMARKLIST
static memberMARKLIST_MARK
static memberMARKVALUEINFO
static memberMARKVALUEINFO_LETTER
static memberMARKVALUEINFO_NAME
static memberMARKVALUEINFO_NARRATIVE
static memberMARKVALUEINFO_NUMERIC
static memberMARKVALUEINFO_PERCENTAGE
static memberMARKVALUEINFO_REFID
static memberMARKVALUEINFO_SCHOOLINFOREFID
static memberMARKVALUEINFO_SCHOOLYEAR
static memberMARKVALUEINFO_SIF_EXTENDEDELEMENTS
static memberMARKVALUEINFO_SIF_METADATA
static memberNARRATIVE
static memberNARRATIVE_ISACCEPTED
static memberNARRATIVE_MAXIMUMSIZE
static memberNUMERIC
static memberNUMERIC_HIGH
static memberNUMERIC_ISACCEPTED
static memberNUMERIC_LOW
static memberNUMERIC_PRECISION
static memberNUMERIC_SCALE
static memberOFFICIALSTUDENTPERIODATTENDANCE
static memberOFFICIALSTUDENTPERIODATTENDANCE_ATTENDANCECODE
static memberOFFICIALSTUDENTPERIODATTENDANCE_ATTENDANCECOMMENT
static memberOFFICIALSTUDENTPERIODATTENDANCE_AUDITINFO
static memberOFFICIALSTUDENTPERIODATTENDANCE_SIF_EXTENDEDELEMENTS
static memberOFFICIALSTUDENTPERIODATTENDANCE_SIF_METADATA
static memberOFFICIALSTUDENTPERIODATTENDANCE_TIMEIN
static memberOFFICIALSTUDENTPERIODATTENDANCE_TIMEOUT
static memberOFFICIALSTUDENTPERIODATTENDANCE_TIMETABLEPERIOD
static memberPERCENTAGE
static memberPERCENTAGE_ISACCEPTED
static memberPERCENTAGE_MAXIMUM
static memberPERCENTAGE_MINIMUM
static memberSECTIONMARKINFO
static memberSECTIONMARKINFO_SCHOOLINFOREFID
static memberSECTIONMARKINFO_SECTIONINFOREFID
static memberSECTIONMARKINFO_SIF_EXTENDEDELEMENTS
static memberSECTIONMARKINFO_SIF_METADATA
static memberSECTIONMARKINFO_TERMMARKLISTS
static memberSTUDENTPERIODATTENDANCE
static memberSTUDENTPERIODATTENDANCE_ATTENDANCECODE
static memberSTUDENTPERIODATTENDANCE_ATTENDANCECOMMENT
static memberSTUDENTPERIODATTENDANCE_AUDITINFO
static memberSTUDENTPERIODATTENDANCE_DATE
static memberSTUDENTPERIODATTENDANCE_REFID
static memberSTUDENTPERIODATTENDANCE_SCHOOLINFOREFID
static memberSTUDENTPERIODATTENDANCE_SECTIONINFOREFID
static memberSTUDENTPERIODATTENDANCE_SIF_EXTENDEDELEMENTS
static memberSTUDENTPERIODATTENDANCE_SIF_METADATA
static memberSTUDENTPERIODATTENDANCE_STUDENTPERSONALREFID
static memberSTUDENTPERIODATTENDANCE_TIMEIN
static memberSTUDENTPERIODATTENDANCE_TIMEOUT
static memberSTUDENTPERIODATTENDANCE_TIMETABLEPERIOD
static memberSTUDENTSECTIONMARKS
static memberSTUDENTSECTIONMARKS_ISFINAL
static memberSTUDENTSECTIONMARKS_MARKLIST
static memberSTUDENTSECTIONMARKS_SCHOOLINFOREFID
static memberSTUDENTSECTIONMARKS_SECTIONINFOREFID
static memberSTUDENTSECTIONMARKS_SIF_EXTENDEDELEMENTS
static memberSTUDENTSECTIONMARKS_SIF_METADATA
static memberSTUDENTSECTIONMARKS_STUDENTPERSONALREFID
static memberSTUDENTSECTIONMARKS_TERMINFOREFID
static memberTERMMARKLISTS
static memberTERMMARKLISTS_MARKINFOLIST
static memberVALIDMARK
static memberVALIDMARK_CODE
static memberVALIDMARK_DESCRIPTION
static memberVALIDMARK_NUMERICEQUIVALENT
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
 GradebookDTD

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