SIFWorks ADK 2.0
InfraDTD Class
NamespacesEdustructures.SifWorks.InfraInfraDTD

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

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



IconMemberDescription
InfraDTDInfraDTDNew()()
AddElementMappings(IDictionary<(Of <String, IElementDef>)>) (Overrides SdoLibraryImpl.AddElementMappings(IDictionary<(Of <String, IElementDef>)>).)
static memberAUTHENTICATION
static memberAUTHENTICATION_AUTHENTICATIONINFO
static memberAUTHENTICATION_REFID
static memberAUTHENTICATION_SIF_EXTENDEDELEMENTS
static memberAUTHENTICATION_SIF_METADATA
static memberAUTHENTICATION_SIF_REFID
static memberAUTHENTICATION_SIF_REFOBJECT
static memberAUTHENTICATIONINFO
static memberAUTHENTICATIONINFO_DISTINGUISHEDNAME
static memberAUTHENTICATIONINFO_PASSWORDLIST
static memberAUTHENTICATIONINFO_SYSTEM
static memberAUTHENTICATIONINFO_USERNAME
static memberAUTHSYSTEM
static memberAUTHSYSTEM_TYPE
static memberC
Load()() (Overrides SdoLibraryImpl.Load()().)
static memberPASSWORD
static memberPASSWORD_ALGORITHM
static memberPASSWORD_KEYNAME
static memberPASSWORDLIST
static memberPASSWORDLIST_PASSWORD
static memberR
static memberR_C
static memberSIF_ACK
static memberSIF_ACK_SIF_ERROR
static memberSIF_ACK_SIF_HEADER
static memberSIF_ACK_SIF_ORIGINALMSGID
static memberSIF_ACK_SIF_ORIGINALSOURCEID
static memberSIF_ACK_SIF_STATUS
static memberSIF_ADDPUBLISHERS
static memberSIF_ADDPUBLISHERS_SIF_PUBLISHER
static memberSIF_AGENTACL
static memberSIF_AGENTACL_SIF_EXTENDEDELEMENTS
static memberSIF_AGENTACL_SIF_METADATA
static memberSIF_AGENTACL_SIF_PROVIDEACCESS
static memberSIF_AGENTACL_SIF_PUBLISHADDACCESS
static memberSIF_AGENTACL_SIF_PUBLISHCHANGEACCESS
static memberSIF_AGENTACL_SIF_PUBLISHDELETEACCESS
static memberSIF_AGENTACL_SIF_REQUESTACCESS
static memberSIF_AGENTACL_SIF_RESPONDACCESS
static memberSIF_AGENTACL_SIF_SUBSCRIBEACCESS
static memberSIF_APPLICATION
static memberSIF_APPLICATION_SIF_PRODUCT
static memberSIF_APPLICATION_SIF_VENDOR
static memberSIF_APPLICATION_SIF_VERSION
static memberSIF_CHANGEPUBLISHERS
static memberSIF_CHANGEPUBLISHERS_SIF_PUBLISHER
static memberSIF_COLUMNHEADERS
static memberSIF_COLUMNHEADERS_SIF_ELEMENT
static memberSIF_CONDITION
static memberSIF_CONDITION_SIF_ELEMENT
static memberSIF_CONDITION_SIF_OPERATOR
static memberSIF_CONDITION_SIF_VALUE
static memberSIF_CONDITIONGROUP
static memberSIF_CONDITIONGROUP_SIF_CONDITIONS
static memberSIF_CONDITIONGROUP_TYPE
static memberSIF_CONDITIONS
static memberSIF_CONDITIONS_SIF_CONDITION
static memberSIF_CONDITIONS_TYPE
static memberSIF_CONTEXT
static memberSIF_CONTEXTS
static memberSIF_CONTEXTS_SIF_CONTEXT
static memberSIF_DATA
static memberSIF_DELETEPUBLISHERS
static memberSIF_DELETEPUBLISHERS_SIF_PUBLISHER
static memberSIF_ELEMENT
static memberSIF_ERROR
static memberSIF_ERROR_SIF_CATEGORY
static memberSIF_ERROR_SIF_CODE
static memberSIF_ERROR_SIF_DESC
static memberSIF_ERROR_SIF_EXTENDEDDESC
static memberSIF_EVENT
static memberSIF_EVENT_SIF_HEADER
static memberSIF_EVENT_SIF_OBJECTDATA
static memberSIF_EVENTOBJECT
static memberSIF_EVENTOBJECT_ACTION
static memberSIF_EVENTOBJECT_OBJECTNAME
static memberSIF_EXAMPLE
static memberSIF_EXTENDEDQUERY
static memberSIF_EXTENDEDQUERY_SIF_DESTINATIONPROVIDER
static memberSIF_EXTENDEDQUERY_SIF_FROM
static memberSIF_EXTENDEDQUERY_SIF_ORDERBY
static memberSIF_EXTENDEDQUERY_SIF_SELECT
static memberSIF_EXTENDEDQUERY_SIF_WHERE
static memberSIF_EXTENDEDQUERYRESULTS
static memberSIF_EXTENDEDQUERYRESULTS_SIF_COLUMNHEADERS
static memberSIF_EXTENDEDQUERYRESULTS_SIF_ROWS
static memberSIF_FROM
static memberSIF_FROM_OBJECTNAME
static memberSIF_FROM_SIF_JOIN
static memberSIF_FROM_SIF_OBJECT
static memberSIF_GETAGENTACL
static memberSIF_GETMESSAGE
static memberSIF_GETZONESTATUS
static memberSIF_HEADER
static memberSIF_HEADER_SIF_CONTEXTS
static memberSIF_HEADER_SIF_DESTINATIONID
static memberSIF_HEADER_SIF_MSGID
static memberSIF_HEADER_SIF_SECURITY
static memberSIF_HEADER_SIF_SOURCEID
static memberSIF_HEADER_SIF_TIMESTAMP
static memberSIF_JOIN
static memberSIF_JOIN_SIF_JOINON
static memberSIF_JOIN_TYPE
static memberSIF_JOINON
static memberSIF_JOINON_SIF_LEFTELEMENT
static memberSIF_JOINON_SIF_RIGHTELEMENT
static memberSIF_LEFTELEMENT
static memberSIF_LEFTELEMENT_OBJECTNAME
static memberSIF_LOGENTRY
static memberSIF_LOGENTRY_LOGLEVEL
static memberSIF_LOGENTRY_SIF_APPLICATIONCODE
static memberSIF_LOGENTRY_SIF_CATEGORY
static memberSIF_LOGENTRY_SIF_CODE
static memberSIF_LOGENTRY_SIF_DESC
static memberSIF_LOGENTRY_SIF_EXTENDEDDESC
static memberSIF_LOGENTRY_SIF_EXTENDEDELEMENTS
static memberSIF_LOGENTRY_SIF_LOGENTRYHEADER
static memberSIF_LOGENTRY_SIF_LOGOBJECTS
static memberSIF_LOGENTRY_SIF_METADATA
static memberSIF_LOGENTRY_SIF_ORIGINALHEADER
static memberSIF_LOGENTRY_SOURCE
static memberSIF_LOGENTRYHEADER
static memberSIF_LOGENTRYHEADER_SIF_HEADER
static memberSIF_LOGOBJECT
static memberSIF_LOGOBJECT_OBJECTNAME
static memberSIF_LOGOBJECTS
static memberSIF_LOGOBJECTS_SIF_LOGOBJECT
static memberSIF_OBJECT
static memberSIF_OBJECT_OBJECTNAME
static memberSIF_OBJECT_SIF_CONTEXTS
static memberSIF_OBJECT_SIF_EXTENDEDQUERYSUPPORT
static memberSIF_OBJECTDATA
static memberSIF_OBJECTDATA_SIF_EVENTOBJECT
static memberSIF_OBJECTLIST
static memberSIF_OBJECTLIST_SIF_OBJECT
static memberSIF_ORDERBY
static memberSIF_ORDERBY_SIF_ELEMENT
static memberSIF_ORIGINALHEADER
static memberSIF_ORIGINALHEADER_SIF_HEADER
static memberSIF_PING
static memberSIF_PROPERTY
static memberSIF_PROPERTY_SIF_NAME
static memberSIF_PROPERTY_SIF_VALUE
static memberSIF_PROTOCOL
static memberSIF_PROTOCOL_SECURE
static memberSIF_PROTOCOL_SIF_PROPERTY
static memberSIF_PROTOCOL_SIF_URL
static memberSIF_PROTOCOL_TYPE
static memberSIF_PROTOCOLNAME
static memberSIF_PROVIDE
static memberSIF_PROVIDE_SIF_HEADER
static memberSIF_PROVIDE_SIF_OBJECT
static memberSIF_PROVIDEACCESS
static memberSIF_PROVIDEACCESS_SIF_OBJECT
static memberSIF_PROVIDEOBJECTS
static memberSIF_PROVIDEOBJECTS_SIF_OBJECT
static memberSIF_PROVIDER
static memberSIF_PROVIDER_SIF_OBJECTLIST
static memberSIF_PROVIDER_SOURCEID
static memberSIF_PROVIDERS
static memberSIF_PROVIDERS_SIF_PROVIDER
static memberSIF_PROVISION
static memberSIF_PROVISION_SIF_HEADER
static memberSIF_PROVISION_SIF_PROVIDEOBJECTS
static memberSIF_PROVISION_SIF_PUBLISHADDOBJECTS
static memberSIF_PROVISION_SIF_PUBLISHCHANGEOBJECTS
static memberSIF_PROVISION_SIF_PUBLISHDELETEOBJECTS
static memberSIF_PROVISION_SIF_REQUESTOBJECTS
static memberSIF_PROVISION_SIF_RESPONDOBJECTS
static memberSIF_PROVISION_SIF_SUBSCRIBEOBJECTS
static memberSIF_PUBLISHADDACCESS
static memberSIF_PUBLISHADDACCESS_SIF_OBJECT
static memberSIF_PUBLISHADDOBJECTS
static memberSIF_PUBLISHADDOBJECTS_SIF_OBJECT
static memberSIF_PUBLISHCHANGEACCESS
static memberSIF_PUBLISHCHANGEACCESS_SIF_OBJECT
static memberSIF_PUBLISHCHANGEOBJECTS
static memberSIF_PUBLISHCHANGEOBJECTS_SIF_OBJECT
static memberSIF_PUBLISHDELETEACCESS
static memberSIF_PUBLISHDELETEACCESS_SIF_OBJECT
static memberSIF_PUBLISHDELETEOBJECTS
static memberSIF_PUBLISHDELETEOBJECTS_SIF_OBJECT
static memberSIF_PUBLISHER
static memberSIF_PUBLISHER_SIF_OBJECTLIST
static memberSIF_PUBLISHER_SOURCEID
static memberSIF_QUERY
static memberSIF_QUERY_SIF_CONDITIONGROUP
static memberSIF_QUERY_SIF_EXAMPLE
static memberSIF_QUERY_SIF_QUERYOBJECT
static memberSIF_QUERYOBJECT
static memberSIF_QUERYOBJECT_OBJECTNAME
static memberSIF_QUERYOBJECT_SIF_ELEMENT
static memberSIF_REGISTER
static memberSIF_REGISTER_SIF_APPLICATION
static memberSIF_REGISTER_SIF_HEADER
static memberSIF_REGISTER_SIF_ICON
static memberSIF_REGISTER_SIF_MAXBUFFERSIZE
static memberSIF_REGISTER_SIF_MODE
static memberSIF_REGISTER_SIF_NAME
static memberSIF_REGISTER_SIF_NODEVENDOR
static memberSIF_REGISTER_SIF_NODEVERSION
static memberSIF_REGISTER_SIF_PROTOCOL
static memberSIF_REGISTER_SIF_VERSION
static memberSIF_REQUEST
static memberSIF_REQUEST_SIF_EXTENDEDQUERY
static memberSIF_REQUEST_SIF_HEADER
static memberSIF_REQUEST_SIF_MAXBUFFERSIZE
static memberSIF_REQUEST_SIF_QUERY
static memberSIF_REQUEST_SIF_VERSION
static memberSIF_REQUESTACCESS
static memberSIF_REQUESTACCESS_SIF_OBJECT
static memberSIF_REQUESTER
static memberSIF_REQUESTER_SIF_OBJECTLIST
static memberSIF_REQUESTER_SOURCEID
static memberSIF_REQUESTERS
static memberSIF_REQUESTERS_SIF_REQUESTER
static memberSIF_REQUESTOBJECTS
static memberSIF_REQUESTOBJECTS_SIF_OBJECT
static memberSIF_RESPONDACCESS
static memberSIF_RESPONDACCESS_SIF_OBJECT
static memberSIF_RESPONDER
static memberSIF_RESPONDER_SIF_OBJECTLIST
static memberSIF_RESPONDER_SOURCEID
static memberSIF_RESPONDERS
static memberSIF_RESPONDERS_SIF_RESPONDER
static memberSIF_RESPONDOBJECTS
static memberSIF_RESPONDOBJECTS_SIF_OBJECT
static memberSIF_RESPONSE
static memberSIF_RESPONSE_SIF_ERROR
static memberSIF_RESPONSE_SIF_EXTENDEDQUERYRESULTS
static memberSIF_RESPONSE_SIF_HEADER
static memberSIF_RESPONSE_SIF_MOREPACKETS
static memberSIF_RESPONSE_SIF_OBJECTDATA
static memberSIF_RESPONSE_SIF_PACKETNUMBER
static memberSIF_RESPONSE_SIF_REQUESTMSGID
static memberSIF_RIGHTELEMENT
static memberSIF_RIGHTELEMENT_OBJECTNAME
static memberSIF_ROWS
static memberSIF_ROWS_R
static memberSIF_SECURECHANNEL
static memberSIF_SECURECHANNEL_SIF_AUTHENTICATIONLEVEL
static memberSIF_SECURECHANNEL_SIF_ENCRYPTIONLEVEL
static memberSIF_SECURITY
static memberSIF_SECURITY_SIF_SECURECHANNEL
static memberSIF_SELECT
static memberSIF_SELECT_DISTINCT
static memberSIF_SELECT_ROWCOUNT
static memberSIF_SELECT_SIF_ELEMENT
static memberSIF_SIFNODE
static memberSIF_SIFNODE_SIF_APPLICATION
static memberSIF_SIFNODE_SIF_AUTHENTICATIONLEVEL
static memberSIF_SIFNODE_SIF_DYNAMICCONNECTIONDATA
static memberSIF_SIFNODE_SIF_ENCRYPTIONLEVEL
static memberSIF_SIFNODE_SIF_ICON
static memberSIF_SIFNODE_SIF_MAXBUFFERSIZE
static memberSIF_SIFNODE_SIF_MODE
static memberSIF_SIFNODE_SIF_NAME
static memberSIF_SIFNODE_SIF_NODEVENDOR
static memberSIF_SIFNODE_SIF_NODEVERSION
static memberSIF_SIFNODE_SIF_PROTOCOL
static memberSIF_SIFNODE_SIF_SLEEPING
static memberSIF_SIFNODE_SIF_SOURCEID
static memberSIF_SIFNODE_SIF_VERSIONLIST
static memberSIF_SIFNODE_TYPE
static memberSIF_SIFNODES
static memberSIF_SIFNODES_SIF_SIFNODE
static memberSIF_SLEEP
static memberSIF_STATUS
static memberSIF_STATUS_SIF_CODE
static memberSIF_STATUS_SIF_DATA
static memberSIF_STATUS_SIF_DESC
static memberSIF_SUBSCRIBE
static memberSIF_SUBSCRIBE_SIF_HEADER
static memberSIF_SUBSCRIBE_SIF_OBJECT
static memberSIF_SUBSCRIBEACCESS
static memberSIF_SUBSCRIBEACCESS_SIF_OBJECT
static memberSIF_SUBSCRIBEOBJECTS
static memberSIF_SUBSCRIBEOBJECTS_SIF_OBJECT
static memberSIF_SUBSCRIBER
static memberSIF_SUBSCRIBER_SIF_OBJECTLIST
static memberSIF_SUBSCRIBER_SOURCEID
static memberSIF_SUBSCRIBERS
static memberSIF_SUBSCRIBERS_SIF_SUBSCRIBER
static memberSIF_SUPPORTEDAUTHENTICATION
static memberSIF_SUPPORTEDAUTHENTICATION_SIF_PROTOCOLNAME
static memberSIF_SUPPORTEDPROTOCOLS
static memberSIF_SUPPORTEDPROTOCOLS_SIF_PROTOCOL
static memberSIF_SUPPORTEDVERSIONS
static memberSIF_SUPPORTEDVERSIONS_SIF_VERSION
static memberSIF_SYSTEMCONTROL
static memberSIF_SYSTEMCONTROL_SIF_HEADER
static memberSIF_SYSTEMCONTROL_SIF_SYSTEMCONTROLDATA
static memberSIF_SYSTEMCONTROLDATA
static memberSIF_UNPROVIDE
static memberSIF_UNPROVIDE_SIF_HEADER
static memberSIF_UNPROVIDE_SIF_OBJECT
static memberSIF_UNREGISTER
static memberSIF_UNREGISTER_SIF_HEADER
static memberSIF_UNSUBSCRIBE
static memberSIF_UNSUBSCRIBE_SIF_HEADER
static memberSIF_UNSUBSCRIBE_SIF_OBJECT
static memberSIF_VENDOR
static memberSIF_VENDOR_SIF_NAME
static memberSIF_VENDOR_SIF_PRODUCT
static memberSIF_VENDOR_SIF_VERSION
static memberSIF_VERSION
static memberSIF_VERSIONLIST
static memberSIF_VERSIONLIST_SIF_VERSION
static memberSIF_WAKEUP
static memberSIF_WHERE
static memberSIF_WHERE_SIF_CONDITIONGROUP
static memberSIF_ZONESTATUS
static memberSIF_ZONESTATUS_SIF_ADDPUBLISHERS
static memberSIF_ZONESTATUS_SIF_ADMINISTRATIONURL
static memberSIF_ZONESTATUS_SIF_CHANGEPUBLISHERS
static memberSIF_ZONESTATUS_SIF_CONTEXTS
static memberSIF_ZONESTATUS_SIF_DELETEPUBLISHERS
static memberSIF_ZONESTATUS_SIF_EXTENDEDELEMENTS
static memberSIF_ZONESTATUS_SIF_ICON
static memberSIF_ZONESTATUS_SIF_METADATA
static memberSIF_ZONESTATUS_SIF_NAME
static memberSIF_ZONESTATUS_SIF_PROVIDERS
static memberSIF_ZONESTATUS_SIF_REQUESTERS
static memberSIF_ZONESTATUS_SIF_RESPONDERS
static memberSIF_ZONESTATUS_SIF_SIFNODES
static memberSIF_ZONESTATUS_SIF_SUBSCRIBERS
static memberSIF_ZONESTATUS_SIF_SUPPORTEDAUTHENTICATION
static memberSIF_ZONESTATUS_SIF_SUPPORTEDPROTOCOLS
static memberSIF_ZONESTATUS_SIF_SUPPORTEDVERSIONS
static memberSIF_ZONESTATUS_SIF_VENDOR
static memberSIF_ZONESTATUS_ZONEID
static memberSIFCOLUMNHEADER
static memberSIFCOLUMNHEADER_ALIAS
static memberSIFCOLUMNHEADER_OBJECTNAME
static memberSIFCOLUMNHEADER_XSITYPE
static memberSIFORDERBYELEMENT
static memberSIFORDERBYELEMENT_OBJECTNAME
static memberSIFORDERBYELEMENT_ORDERING
static memberSIFSELECTELEMENT
static memberSIFSELECTELEMENT_ALIAS
static memberSIFSELECTELEMENT_OBJECTNAME
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
 InfraDTD

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