SIFWorks ADK 2.0
ReportingDTD Class
NamespacesEdustructures.SifWorks.ReportingReportingDTD

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

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



IconMemberDescription
ReportingDTDReportingDTDNew()()
AddElementMappings(IDictionary<(Of <String, IElementDef>)>) (Overrides SdoLibraryImpl.AddElementMappings(IDictionary<(Of <String, IElementDef>)>).)
Load()() (Overrides SdoLibraryImpl.Load()().)
static memberRECEIVINGAUTHORITY
static memberRECEIVINGAUTHORITY_SIF_REFOBJECT
static memberREPORTAUTHORITYINFO
static memberREPORTAUTHORITYINFO_ADDRESS
static memberREPORTAUTHORITYINFO_AUTHORITYDEPARTMENT
static memberREPORTAUTHORITYINFO_AUTHORITYID
static memberREPORTAUTHORITYINFO_AUTHORITYLEVEL
static memberREPORTAUTHORITYINFO_AUTHORITYNAME
static memberREPORTAUTHORITYINFO_CONTACTINFO
static memberREPORTAUTHORITYINFO_PHONENUMBER
static memberREPORTAUTHORITYINFO_REFID
static memberREPORTAUTHORITYINFO_SIF_EXTENDEDELEMENTS
static memberREPORTAUTHORITYINFO_SIF_METADATA
static memberREPORTDATA
static memberREPORTDEFINITIONSOURCE
static memberREPORTDEFINITIONSOURCE_QUERYLANGUAGE
static memberREPORTDEFINITIONSOURCE_TYPE
static memberREPORTFORMAT
static memberREPORTFORMAT_CONTENTTYPE
static memberREPORTFORMAT_TYPE
static memberREPORTFORMATLIST
static memberREPORTFORMATLIST_REPORTFORMAT
static memberREPORTINFO
static memberREPORTINFO_CALCULATIONDATE
static memberREPORTINFO_DESCRIPTION
static memberREPORTINFO_REPORTMANIFESTREFID
static memberREPORTINFO_REPORTSUBMITTERINFO
static memberREPORTINFO_SUBMISSIONNUMBER
static memberREPORTINFO_SUBMISSIONREASON
static memberREPORTINGPERIOD
static memberREPORTINGPERIOD_BEGINREPORTDATE
static memberREPORTINGPERIOD_BEGINSUBMITDATE
static memberREPORTINGPERIOD_DUEDATE
static memberREPORTINGPERIOD_ENDREPORTDATE
static memberREPORTINGPERIOD_ENDSUBMITDATE
static memberREPORTMANIFEST
static memberREPORTMANIFEST_DESCRIPTION
static memberREPORTMANIFEST_RECEIVINGAUTHORITY
static memberREPORTMANIFEST_REFID
static memberREPORTMANIFEST_REPORTAUTHORITYINFOREFID
static memberREPORTMANIFEST_REPORTDEFINITIONSOURCE
static memberREPORTMANIFEST_REPORTFORMATLIST
static memberREPORTMANIFEST_REPORTINGPERIOD
static memberREPORTMANIFEST_REPORTNAME
static memberREPORTMANIFEST_SIF_EXTENDEDELEMENTS
static memberREPORTMANIFEST_SIF_EXTENDEDQUERY
static memberREPORTMANIFEST_SIF_MAXBUFFERSIZE
static memberREPORTMANIFEST_SIF_METADATA
static memberREPORTMANIFEST_SIF_QUERYGROUP
static memberREPORTMANIFEST_SIF_VERSION
static memberREPORTPACKAGE
static memberREPORTPACKAGE_BINARYDATA
static memberREPORTPACKAGE_REFERENCE
static memberREPORTPACKAGE_SIF_EXTENDEDELEMENTS
static memberREPORTPACKAGE_SIF_METADATA
static memberREPORTPACKAGE_TEXTDATA
static memberREPORTPACKAGE_XMLDATA
static memberREPORTSUBMITTERINFO
static memberREPORTSUBMITTERINFO_ADDRESS
static memberREPORTSUBMITTERINFO_CONTACTINFO
static memberREPORTSUBMITTERINFO_PHONENUMBER
static memberREPORTSUBMITTERINFO_SIF_REFID
static memberREPORTSUBMITTERINFO_SUBMITTERDEPARTMENT
static memberREPORTSUBMITTERINFO_SUBMITTERNAME
static memberREPORTSUBMITTERINFO_SUBMITTERNOTES
static memberREQUESTINGAGENCYID
static memberREQUESTINGAGENCYID_TYPE
static memberSIF_QUERYGROUP
static memberSIF_QUERYGROUP_SIF_QUERY
static memberSIF_REPORTOBJECT
static memberSIF_REPORTOBJECT_REFID
static memberSIF_REPORTOBJECT_REPORTDATA
static memberSIF_REPORTOBJECT_REPORTINFO
static memberSIF_REPORTOBJECT_SIF_EXTENDEDELEMENTS
static memberSIF_REPORTOBJECT_SIF_EXTENDEDQUERYRESULTS
static memberSIF_REPORTOBJECT_SIF_METADATA
static memberSLCONTACT
static memberSLCONTACT_EDUCATIONALLEVEL
static memberSLCONTACT_NAME
static memberSLCONTACT_OTHERID
static memberSLCONTACT_RELATIONSHIP
static memberSTUDENTLOCATOR
static memberSTUDENTLOCATOR_ADDRESS
static memberSTUDENTLOCATOR_CONFIDENCE
static memberSTUDENTLOCATOR_CONTACT
static memberSTUDENTLOCATOR_DEMOGRAPHICS
static memberSTUDENTLOCATOR_EFFECTIVEDATE
static memberSTUDENTLOCATOR_ENDDATE
static memberSTUDENTLOCATOR_GRADELEVEL
static memberSTUDENTLOCATOR_GRADUATIONDATE
static memberSTUDENTLOCATOR_IDSTATUS
static memberSTUDENTLOCATOR_LOCALID
static memberSTUDENTLOCATOR_NAME
static memberSTUDENTLOCATOR_OTHERID
static memberSTUDENTLOCATOR_REQUESTINGAGENCYID
static memberSTUDENTLOCATOR_SCHOOLATTENDEDLOCATION
static memberSTUDENTLOCATOR_SCHOOLATTENDEDNAME
static memberSTUDENTLOCATOR_SIF_ERROR
static memberSTUDENTLOCATOR_SIF_EXTENDEDELEMENTS
static memberSTUDENTLOCATOR_SIF_METADATA
static memberSTUDENTLOCATOR_SSN
static memberSTUDENTLOCATOR_STARTDATE
static memberSTUDENTLOCATOR_STATEPROVINCEID
static memberSTUDENTLOCATOR_STUDENTPERSONALREFID
static memberSTUDENTLOCATOR_TRANSACTIONID
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
 ReportingDTD

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