C# Class OpenADK.Library.au.Infrastructure.InfrastructureDTD

Metadata for the Schools Interoperability Framework (SIF)

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.STUDENTPERSONALIdentifies the StudentPersonal data object SIFDTD.SCHOOLINFOIdentifies 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 IZone.SetSubscriber method is an IElementDef: myZone.setSubscriber( SIFDTD.BUSINFO, this, ADKFlags.PROV_SUBSCRIBE ); ElementDef also identifies child elements and attributes as demonstrated by the Query.AddCondition method: 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 Adk.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

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 null and cannot be referenced. For example, given the SDO Libraries loaded above, attempting to reference the SIFDTD.LIBRARYPATRONSTATUS object from the Library Automation Working Group would result in a NullPointerException:

SifDtd.LIBRARYPATRONSTATUS.Name;
Inheritance: OpenADK.Library.Impl.SdoLibraryImpl
Mostra file Open project: open-adk/OpenADK-csharp

Public Properties

Property Type Description
IDENTITY IElementDef
IDENTITYASSERTION IElementDef
IDENTITYASSERTIONS IElementDef
IDENTITYASSERTIONS_IDENTITYASSERTION IElementDef
IDENTITYASSERTION_SCHEMANAME IElementDef
IDENTITY_AUTHENTICATIONSOURCE IElementDef
IDENTITY_AUTHENTICATIONSOURCEGLOBALUID IElementDef
IDENTITY_IDENTITYASSERTIONS IElementDef
IDENTITY_PASSWORDLIST IElementDef
IDENTITY_REFID IElementDef
IDENTITY_SIF_EXTENDEDELEMENTS IElementDef
IDENTITY_SIF_METADATA IElementDef
IDENTITY_SIF_REFID IElementDef
PASSWORDLIST IElementDef
PASSWORDLIST_PASSWORD IElementDef

Public Methods

Method Description
AddElementMappings ( IElementDef>.IDictionary dictionary ) : void
Load ( ) : void

Method Details

AddElementMappings() public method

public AddElementMappings ( IElementDef>.IDictionary dictionary ) : void
dictionary IElementDef>.IDictionary
return void

Load() public method

public Load ( ) : void
return void

Property Details

IDENTITY public_oe static_oe property

public static IElementDef IDENTITY
return IElementDef

IDENTITYASSERTION public_oe static_oe property

public static IElementDef IDENTITYASSERTION
return IElementDef

IDENTITYASSERTIONS public_oe static_oe property

public static IElementDef IDENTITYASSERTIONS
return IElementDef

IDENTITYASSERTIONS_IDENTITYASSERTION public_oe static_oe property

public static IElementDef IDENTITYASSERTIONS_IDENTITYASSERTION
return IElementDef

IDENTITYASSERTION_SCHEMANAME public_oe static_oe property

public static IElementDef IDENTITYASSERTION_SCHEMANAME
return IElementDef

IDENTITY_AUTHENTICATIONSOURCE public_oe static_oe property

public static IElementDef IDENTITY_AUTHENTICATIONSOURCE
return IElementDef

IDENTITY_AUTHENTICATIONSOURCEGLOBALUID public_oe static_oe property

public static IElementDef IDENTITY_AUTHENTICATIONSOURCEGLOBALUID
return IElementDef

IDENTITY_IDENTITYASSERTIONS public_oe static_oe property

public static IElementDef IDENTITY_IDENTITYASSERTIONS
return IElementDef

IDENTITY_PASSWORDLIST public_oe static_oe property

public static IElementDef IDENTITY_PASSWORDLIST
return IElementDef

IDENTITY_REFID public_oe static_oe property

public static IElementDef IDENTITY_REFID
return IElementDef

IDENTITY_SIF_EXTENDEDELEMENTS public_oe static_oe property

public static IElementDef IDENTITY_SIF_EXTENDEDELEMENTS
return IElementDef

IDENTITY_SIF_METADATA public_oe static_oe property

public static IElementDef IDENTITY_SIF_METADATA
return IElementDef

IDENTITY_SIF_REFID public_oe static_oe property

public static IElementDef IDENTITY_SIF_REFID
return IElementDef

PASSWORDLIST public_oe static_oe property

public static IElementDef PASSWORDLIST
return IElementDef

PASSWORDLIST_PASSWORD public_oe static_oe property

public static IElementDef PASSWORDLIST_PASSWORD
return IElementDef