SIFWorks ADK 2.0
HrfinDTD Class
NamespacesEdustructures.SifWorks.HrfinHrfinDTD

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

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



IconMemberDescription
HrfinDTDHrfinDTDNew()()
static memberACCOUNTINGPERIOD
static memberACCOUNTINGPERIOD_DESCRIPTION
static memberACCOUNTINGPERIOD_ENDDATE
static memberACCOUNTINGPERIOD_FISCALYEARREFID
static memberACCOUNTINGPERIOD_NAME
static memberACCOUNTINGPERIOD_REFID
static memberACCOUNTINGPERIOD_SIF_EXTENDEDELEMENTS
static memberACCOUNTINGPERIOD_SIF_METADATA
static memberACCOUNTINGPERIOD_STARTDATE
AddElementMappings(IDictionary<(Of <String, IElementDef>)>) (Overrides SdoLibraryImpl.AddElementMappings(IDictionary<(Of <String, IElementDef>)>).)
static memberANNUALITEM
static memberANNUALITEM_ACCOUNTTYPE
static memberANNUALITEM_AMOUNT
static memberANNUALITEM_EXPENDITUREAREA
static memberANNUALITEM_FUNCTION
static memberANNUALITEM_FUNDTYPE
static memberANNUALITEM_GLAMOUNTTYPE
static memberANNUALITEM_INSTRUCTIONALPROGRAM
static memberANNUALITEM_OBJECT
static memberANNUALITEM_SPECIALAMOUNTTYPE
static memberANNUALITEM_STATEPROVINCEID
static memberANNUALITEMS
static memberANNUALITEMS_ANNUALITEM
static memberBASESALARY
static memberBASESALARY_CURRENCY
static memberBILLEDAMOUNT
static memberBILLEDAMOUNT_CURRENCY
static memberBILLEDENTITY
static memberBILLEDENTITY_SIF_REFOBJECT
static memberBILLING
static memberBILLING_BILLEDAMOUNT
static memberBILLING_BILLEDENTITY
static memberBILLING_BILLINGDATE
static memberBILLING_ENTITYID
static memberBILLING_REFID
static memberBILLING_SIF_EXTENDEDELEMENTS
static memberBILLING_SIF_METADATA
static memberBILLING_TRANSACTIONDESCRIPTION
static memberBUDGETACCOUNT
static memberBUDGETACCOUNT_ACCOUNTCLASS
static memberBUDGETACCOUNT_BUDGETAMOUNT
static memberBUDGETACCOUNT_FUNCTIONBREAKDOWN
static memberBUDGETACCOUNT_FUNDBREAKDOWN
static memberBUDGETACCOUNT_OBJECTBREAKDOWN
static memberBUDGETACCOUNTS
static memberBUDGETACCOUNTS_BUDGETACCOUNT
static memberEMPLOYEEASSIGNMENT
static memberEMPLOYEEASSIGNMENT_DESCRIPTION
static memberEMPLOYEEASSIGNMENT_EMPLOYEEPERSONALREFID
static memberEMPLOYEEASSIGNMENT_FUNDINGSOURCE
static memberEMPLOYEEASSIGNMENT_JOBCLASSIFICATION
static memberEMPLOYEEASSIGNMENT_JOBENDDATE
static memberEMPLOYEEASSIGNMENT_JOBFTE
static memberEMPLOYEEASSIGNMENT_JOBSTARTDATE
static memberEMPLOYEEASSIGNMENT_LOCATIONINFOREFID
static memberEMPLOYEEASSIGNMENT_PRIMARYASSIGNMENT
static memberEMPLOYEEASSIGNMENT_PROGRAMTYPE
static memberEMPLOYEEASSIGNMENT_REFID
static memberEMPLOYEEASSIGNMENT_SIF_EXTENDEDELEMENTS
static memberEMPLOYEEASSIGNMENT_SIF_METADATA
static memberEMPLOYEEASSIGNMENT_SISID
static memberEMPLOYEECONTRACT
static memberEMPLOYEECONTRACT_ASSIGNMENTDAYS
static memberEMPLOYEECONTRACT_BASESALARY
static memberEMPLOYEECONTRACT_CONTRACTDAYS
static memberEMPLOYEECONTRACT_CONTRACTENDDATE
static memberEMPLOYEECONTRACT_CONTRACTSTARTDATE
static memberEMPLOYEECONTRACT_CONTRACTTERM
static memberEMPLOYEECONTRACT_EMPLOYEEPERSONALREFID
static memberEMPLOYEECONTRACT_REFID
static memberEMPLOYEECONTRACT_SIF_EXTENDEDELEMENTS
static memberEMPLOYEECONTRACT_SIF_METADATA
static memberEMPLOYEEPERSONAL
static memberEMPLOYEEPERSONAL_ADDRESSLIST
static memberEMPLOYEEPERSONAL_DEMOGRAPHICS
static memberEMPLOYEEPERSONAL_EMAILLIST
static memberEMPLOYEEPERSONAL_NAME
static memberEMPLOYEEPERSONAL_OTHERIDLIST
static memberEMPLOYEEPERSONAL_PHONENUMBERLIST
static memberEMPLOYEEPERSONAL_REFID
static memberEMPLOYEEPERSONAL_SIF_EXTENDEDELEMENTS
static memberEMPLOYEEPERSONAL_SIF_METADATA
static memberEMPLOYEEPERSONAL_SSN
static memberEMPLOYEEPERSONAL_STATEPROVINCEID
static memberEMPLOYEEPICTURE
static memberEMPLOYEEPICTURE_EMPLOYEEPERSONALREFID
static memberEMPLOYEEPICTURE_PICTURESOURCE
static memberEMPLOYEEPICTURE_SIF_EXTENDEDELEMENTS
static memberEMPLOYEEPICTURE_SIF_METADATA
static memberEMPLOYEEWAGE
static memberEMPLOYEEWAGE_EMPLOYEEPERSONALREFID
static memberEMPLOYEEWAGE_PAYRATES
static memberEMPLOYEEWAGE_REFID
static memberEMPLOYEEWAGE_SIF_EXTENDEDELEMENTS
static memberEMPLOYEEWAGE_SIF_METADATA
static memberEMPLOYMENTRECORD
static memberEMPLOYMENTRECORD_ACTIVE
static memberEMPLOYMENTRECORD_FULLTIMESTATUS
static memberEMPLOYMENTRECORD_HIREDATE
static memberEMPLOYMENTRECORD_LEAINFOREFID
static memberEMPLOYMENTRECORD_POSITIONNUMBER
static memberEMPLOYMENTRECORD_POSITIONTITLE
static memberEMPLOYMENTRECORD_REFID
static memberEMPLOYMENTRECORD_SENIORITYDATE
static memberEMPLOYMENTRECORD_SIF_EXTENDEDELEMENTS
static memberEMPLOYMENTRECORD_SIF_METADATA
static memberEMPLOYMENTRECORD_SIF_REFID
static memberEMPLOYMENTRECORD_SIF_REFOBJECT
static memberEMPLOYMENTRECORD_TENUREDATE
static memberEMPLOYMENTRECORD_TERMINATIONDATE
static memberEMPLOYMENTRECORD_TOTALYEARSEXPERIENCE
static memberEXPENSEACCOUNT
static memberEXPENSEACCOUNT_ACCOUNTCODE
static memberEXPENSEACCOUNT_AMOUNT
static memberEXPENSEACCOUNTS
static memberEXPENSEACCOUNTS_EXPENSEACCOUNT
static memberFEDERALTAXID
static memberFEDERALTAXID_CODE
static memberFINANCIALACCOUNT
static memberFINANCIALACCOUNT_ACCOUNTNUMBER
static memberFINANCIALACCOUNT_CREATIONDATE
static memberFINANCIALACCOUNT_CREATIONTIME
static memberFINANCIALACCOUNT_DESCRIPTION
static memberFINANCIALACCOUNT_FINANCIALCLASSREFID
static memberFINANCIALACCOUNT_NAME
static memberFINANCIALACCOUNT_REFID
static memberFINANCIALACCOUNT_SIF_EXTENDEDELEMENTS
static memberFINANCIALACCOUNT_SIF_METADATA
static memberFINANCIALACCOUNTACCOUNTINGPERIODLOCATIONINFO
static memberFINANCIALACCOUNTACCOUNTINGPERIODLOCATIONINFO_ACCOUNTINGPERIODREFID
static memberFINANCIALACCOUNTACCOUNTINGPERIODLOCATIONINFO_FINANCIALACCOUNTREFID
static memberFINANCIALACCOUNTACCOUNTINGPERIODLOCATIONINFO_LOCATIONINFOREFID
static memberFINANCIALACCOUNTACCOUNTINGPERIODLOCATIONINFO_REFID
static memberFINANCIALACCOUNTACCOUNTINGPERIODLOCATIONINFO_SIF_EXTENDEDELEMENTS
static memberFINANCIALACCOUNTACCOUNTINGPERIODLOCATIONINFO_SIF_METADATA
static memberFINANCIALANNUAL
static memberFINANCIALANNUAL_ANNUALITEMS
static memberFINANCIALANNUAL_FISCALYEAR
static memberFINANCIALANNUAL_REPORTDATE
static memberFINANCIALANNUAL_SIF_EXTENDEDELEMENTS
static memberFINANCIALANNUAL_SIF_METADATA
static memberFINANCIALANNUAL_STATEPROVINCEID
static memberFINANCIALBUDGET
static memberFINANCIALBUDGET_BUDGETACCOUNTS
static memberFINANCIALBUDGET_FISCALYEAR
static memberFINANCIALBUDGET_REPORTDATE
static memberFINANCIALBUDGET_SIF_EXTENDEDELEMENTS
static memberFINANCIALBUDGET_SIF_METADATA
static memberFINANCIALBUDGET_STATEPROVINCEID
static memberFINANCIALCLASS
static memberFINANCIALCLASS_CLASSTYPE
static memberFINANCIALCLASS_DESCRIPTION
static memberFINANCIALCLASS_NAME
static memberFINANCIALCLASS_REFID
static memberFINANCIALCLASS_SIF_EXTENDEDELEMENTS
static memberFINANCIALCLASS_SIF_METADATA
static memberFINANCIALINCOMESTATEMENT
static memberFINANCIALINCOMESTATEMENT_AMOUNTS
static memberFINANCIALINCOMESTATEMENT_GENERATIONDATE
static memberFINANCIALINCOMESTATEMENT_GENERATIONTIME
static memberFINANCIALINCOMESTATEMENT_LOCATIONINFOREFID
static memberFINANCIALINCOMESTATEMENT_PERIOD
static memberFINANCIALINCOMESTATEMENT_PROGRAM
static memberFINANCIALINCOMESTATEMENT_REFID
static memberFINANCIALINCOMESTATEMENT_SIF_EXTENDEDELEMENTS
static memberFINANCIALINCOMESTATEMENT_SIF_METADATA
static memberFINANCIALTRANSACTION
static memberFINANCIALTRANSACTION_AMOUNTS
static memberFINANCIALTRANSACTION_DESCRIPTION
static memberFINANCIALTRANSACTION_PROGRAM
static memberFINANCIALTRANSACTION_REFID
static memberFINANCIALTRANSACTION_SIF_EXTENDEDELEMENTS
static memberFINANCIALTRANSACTION_SIF_METADATA
static memberFINANCIALTRANSACTION_TRANSACTIONDATE
static memberFINANCIALTRANSACTION_TRANSACTIONTIME
static memberFISAMOUNT
static memberFISAMOUNT_FINANCIALACCOUNTACCOUNTINGPERIODLOCATIONINFOREFID
static memberFISAMOUNT_FINANCIALCLASSREFID
static memberFISAMOUNTS
static memberFISAMOUNTS_AMOUNT
static memberFISCALYEAR
static memberFISCALYEAR_DESCRIPTION
static memberFISCALYEAR_ENDDATE
static memberFISCALYEAR_REFID
static memberFISCALYEAR_SIF_EXTENDEDELEMENTS
static memberFISCALYEAR_SIF_METADATA
static memberFISCALYEAR_STARTDATE
static memberFISPERIOD
static memberFISPERIOD_ENDDATE
static memberFISPERIOD_STARTDATE
static memberFTAMOUNT
static memberFTAMOUNT_FINANCIALACCOUNTACCOUNTINGPERIODLOCATIONINFOREFID
static memberFTAMOUNT_TYPE
static memberFTAMOUNTS
static memberFTAMOUNTS_AMOUNT
static memberHROTHERIDLIST
static memberHROTHERIDLIST_OTHERID
static memberHRPROGRAMTYPE
static memberHRPROGRAMTYPE_CODE
static memberHRPROGRAMTYPE_OTHERCODELIST
static memberJOBCLASSIFICATION
static memberJOBCLASSIFICATION_CODE
static memberJOBCLASSIFICATION_OTHERCODELIST
static memberLEAINFOREFID
Load()() (Overrides SdoLibraryImpl.Load()().)
static memberLOCATIONINFO
static memberLOCATIONINFO_ADDRESSLIST
static memberLOCATIONINFO_DESCRIPTION
static memberLOCATIONINFO_IDENTIFICATIONINFOLIST
static memberLOCATIONINFO_LEAINFOREFID
static memberLOCATIONINFO_LOCALID
static memberLOCATIONINFO_LOCATIONTYPE
static memberLOCATIONINFO_NAME
static memberLOCATIONINFO_NCESID
static memberLOCATIONINFO_OTHERLEAS
static memberLOCATIONINFO_PARENTLOCATIONINFO
static memberLOCATIONINFO_PHONENUMBERLIST
static memberLOCATIONINFO_REFID
static memberLOCATIONINFO_SCHOOLINFOREFID
static memberLOCATIONINFO_SIF_EXTENDEDELEMENTS
static memberLOCATIONINFO_SIF_METADATA
static memberLOCATIONINFO_SITECATEGORY
static memberLOCATIONINFO_STATEPROVINCEID
static memberOTHERLEAS
static memberOTHERLEAS_LEAINFOREFID
static memberPARENTLOCATIONINFO
static memberPARENTLOCATIONINFO_SIF_REFOBJECT
static memberPAYMENT
static memberPAYMENT_BILLINGREFID
static memberPAYMENT_ENTITYID
static memberPAYMENT_RECEIVEDAMOUNT
static memberPAYMENT_RECEIVEDDATE
static memberPAYMENT_RECEIVEDTRANSACTIONID
static memberPAYMENT_REFID
static memberPAYMENT_SIF_EXTENDEDELEMENTS
static memberPAYMENT_SIF_METADATA
static memberPAYMENT_TRANSACTIONDESCRIPTION
static memberPAYRATE
static memberPAYRATE_AMOUNT
static memberPAYRATE_PERCENTAGE
static memberPAYRATE_TYPE
static memberPAYRATES
static memberPAYRATES_PAYRATE
static memberPERIOD
static memberPERIOD_ENDDATE
static memberPERIOD_STARTDATE
static memberPURCHASING
static memberPURCHASING_EMPLOYEEPERSONALREFID
static memberPURCHASING_FISCALYEARREFID
static memberPURCHASING_FORMNUMBER
static memberPURCHASING_FORMTYPE
static memberPURCHASING_LOCATIONINFOREFID
static memberPURCHASING_PURCHASINGITEMS
static memberPURCHASING_REFID
static memberPURCHASING_SIF_EXTENDEDELEMENTS
static memberPURCHASING_SIF_METADATA
static memberPURCHASING_VENDORINFOREFID
static memberPURCHASINGITEM
static memberPURCHASINGITEM_EXPENSEACCOUNTS
static memberPURCHASINGITEM_ITEMDESCRIPTION
static memberPURCHASINGITEM_ITEMNUMBER
static memberPURCHASINGITEM_QUANTITY
static memberPURCHASINGITEM_UNITCOST
static memberPURCHASINGITEMS
static memberPURCHASINGITEMS_PURCHASINGITEM
static memberRECEIVEDAMOUNT
static memberRECEIVEDAMOUNT_CURRENCY
static memberSCHOOL
static memberSCHOOL_SCHOOLINFOREFID
static memberTIMEWORKED
static memberTIMEWORKED_EMPLOYEEPERSONALREFID
static memberTIMEWORKED_JOBFUNCTION
static memberTIMEWORKED_LOCATIONINFOREFID
static memberTIMEWORKED_OVERTIMEHOURS
static memberTIMEWORKED_PAYPERIOD
static memberTIMEWORKED_REFID
static memberTIMEWORKED_REGULARHOURS
static memberTIMEWORKED_SIF_EXTENDEDELEMENTS
static memberTIMEWORKED_SIF_METADATA
static memberUNITCOST
static memberUNITCOST_CURRENCY
static memberVENDORINFO
static memberVENDORINFO_ADDRESS
static memberVENDORINFO_CONTACTINFO
static memberVENDORINFO_CONTACTNAME
static memberVENDORINFO_CUSTOMERID
static memberVENDORINFO_EMAIL
static memberVENDORINFO_EMPLOYEEPERSONALREFID
static memberVENDORINFO_FEDERALTAXID
static memberVENDORINFO_NAME
static memberVENDORINFO_PHONENUMBER
static memberVENDORINFO_REFID
static memberVENDORINFO_SEND1099
static memberVENDORINFO_SIF_EXTENDEDELEMENTS
static memberVENDORINFO_SIF_METADATA
static memberW4
static memberW4_EMPLOYEEPERSONALREFID
static memberW4_EXEMPT
static memberW4_FEDERALALLOWANCESNUMBER
static memberW4_MARITALSTATUSRATE
static memberW4_SIF_EXTENDEDELEMENTS
static memberW4_SIF_METADATA
static memberW4_STATEALLOWANCESNUMBER
static memberW4_STATEPROVINCE
static memberW4_W4DATE
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
 HrfinDTD

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