SIFWorks ADK 2.0
ProfdevDTD Class
NamespacesEdustructures.SifWorks.ProfdevProfdevDTD

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

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



IconMemberDescription
ProfdevDTDProfdevDTDNew()()
static memberACTIVITYPROVIDER
static memberACTIVITYPROVIDER_ADDRESS
static memberACTIVITYPROVIDER_LOCALID
static memberACTIVITYPROVIDER_NAME
static memberACTIVITYPROVIDER_REFID
static memberACTIVITYPROVIDER_SIF_EXTENDEDELEMENTS
static memberACTIVITYPROVIDER_SIF_METADATA
static memberACTIVITYPROVIDER_STATEPROVINCEID
AddElementMappings(IDictionary<(Of <String, IElementDef>)>) (Overrides SdoLibraryImpl.AddElementMappings(IDictionary<(Of <String, IElementDef>)>).)
static memberBACKGROUNDCHECK
static memberBACKGROUNDCHECK_DATE
static memberBACKGROUNDCHECK_DESCRIPTION
static memberBACKGROUNDCHECK_TYPE
static memberBACKGROUNDCHECKS
static memberBACKGROUNDCHECKS_BACKGROUNDCHECK
static memberCERTIFICATION
static memberCERTIFICATION_AREAAUTHORIZED
static memberCERTIFICATION_DESCRIPTION
static memberCERTIFICATIONS
static memberCERTIFICATIONS_CERTIFICATION
static memberEARNED
static memberEARNED_TYPE
static memberEMPLASSIGNMENT
static memberEMPLASSIGNMENT_FTE
static memberEMPLASSIGNMENT_GRADELEVELS
static memberEMPLASSIGNMENT_JOBFUNCTION
static memberEMPLASSIGNMENT_SCHOOLINFOREFID
static memberEMPLOYEEASSIGNMENTS
static memberEMPLOYEEASSIGNMENTS_ASSIGNMENT
static memberEMPLOYEECREDENTIAL
static memberEMPLOYEECREDENTIAL_ASSIGNMENTS
static memberEMPLOYEECREDENTIAL_BACKGROUNDCHECKS
static memberEMPLOYEECREDENTIAL_CERTIFICATIONS
static memberEMPLOYEECREDENTIAL_DEMOGRAPHICS
static memberEMPLOYEECREDENTIAL_EDUCATION
static memberEMPLOYEECREDENTIAL_HISPANIC
static memberEMPLOYEECREDENTIAL_LEAVE
static memberEMPLOYEECREDENTIAL_NAME
static memberEMPLOYEECREDENTIAL_RACE
static memberEMPLOYEECREDENTIAL_REPORTDATE
static memberEMPLOYEECREDENTIAL_SALARY
static memberEMPLOYEECREDENTIAL_SCHOOLYEAR
static memberEMPLOYEECREDENTIAL_SIF_EXTENDEDELEMENTS
static memberEMPLOYEECREDENTIAL_SIF_METADATA
static memberEMPLOYEECREDENTIAL_SSN
static memberEMPLOYEECREDENTIAL_STATEPROVINCEID
static memberEMPLOYEECREDENTIAL_STATUS
static memberEMPLOYEECREDENTIAL_TEACHINGCREDENTIALTYPE
static memberEMPLOYEECREDENTIAL_TERMINATIONCODE
static memberEMPLOYEECREDENTIAL_TOTALYEARS
static memberEMPLOYEECREDENTIAL_UNITYEARS
static memberEMPLOYEECREDIT
static memberEMPLOYEECREDIT_EARNED
static memberEMPLOYEECREDIT_EMPLOYEEPERSONALREFID
static memberEMPLOYEECREDIT_ENDDATE
static memberEMPLOYEECREDIT_PROFESSIONALDEVELOPMENTACTIVITIESREFID
static memberEMPLOYEECREDIT_REFID
static memberEMPLOYEECREDIT_SIF_EXTENDEDELEMENTS
static memberEMPLOYEECREDIT_SIF_METADATA
static memberEMPLOYEERECERTIFICATION
static memberEMPLOYEERECERTIFICATION_ACTIVITYHOURS
static memberEMPLOYEERECERTIFICATION_ACTIVITYNAME
static memberEMPLOYEERECERTIFICATION_ACTIVITYTYPE
static memberEMPLOYEERECERTIFICATION_DATEFROM
static memberEMPLOYEERECERTIFICATION_DATETO
static memberEMPLOYEERECERTIFICATION_DEMOGRAPHICS
static memberEMPLOYEERECERTIFICATION_EARNED
static memberEMPLOYEERECERTIFICATION_NAME
static memberEMPLOYEERECERTIFICATION_SIF_EXTENDEDELEMENTS
static memberEMPLOYEERECERTIFICATION_SIF_METADATA
static memberEMPLOYEERECERTIFICATION_SSN
static memberEMPLOYEERECERTIFICATION_STATEPROVINCEID
Load()() (Overrides SdoLibraryImpl.Load()().)
static memberPROFESSIONALDEVELOPMENTACTIVITIES
static memberPROFESSIONALDEVELOPMENTACTIVITIES_ACTIVITYPROVIDERREFID
static memberPROFESSIONALDEVELOPMENTACTIVITIES_CLOCKHOURS
static memberPROFESSIONALDEVELOPMENTACTIVITIES_CREDITS
static memberPROFESSIONALDEVELOPMENTACTIVITIES_DESCRIPTION
static memberPROFESSIONALDEVELOPMENTACTIVITIES_ENDDATE
static memberPROFESSIONALDEVELOPMENTACTIVITIES_LOCALID
static memberPROFESSIONALDEVELOPMENTACTIVITIES_REFID
static memberPROFESSIONALDEVELOPMENTACTIVITIES_SIF_EXTENDEDELEMENTS
static memberPROFESSIONALDEVELOPMENTACTIVITIES_SIF_METADATA
static memberPROFESSIONALDEVELOPMENTACTIVITIES_STARTDATE
static memberSALARY
static memberSALARY_CURRENCY
static memberTEACHINGCREDENTIAL
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
 ProfdevDTD

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