SIFWorks ADK 2.0
LibraryDTD Class
NamespacesEdustructures.SifWorks.LibraryLibraryDTD

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

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



IconMemberDescription
LibraryDTDLibraryDTDNew()()
AddElementMappings(IDictionary<(Of <String, IElementDef>)>) (Overrides SdoLibraryImpl.AddElementMappings(IDictionary<(Of <String, IElementDef>)>).)
static memberCHECKOUTINFO
static memberCHECKOUTINFO_RETURNBY
static memberFINEAMOUNT
static memberFINEAMOUNT_CURRENCY
static memberFINEINFO
static memberFINEINFO_AMOUNT
static memberFINEINFO_ASSESSED
static memberFINEINFO_DESCRIPTION
static memberFINEINFO_REFERENCE
static memberFINEINFO_TYPE
static memberFINEINFOLIST
static memberFINEINFOLIST_FINEINFO
static memberHOLDINFO
static memberHOLDINFO_DATENEEDED
static memberHOLDINFO_DATEPLACED
static memberHOLDINFO_EXPIRES
static memberHOLDINFO_MADEAVAILABLE
static memberHOLDINFO_TYPE
static memberHOLDINFOLIST
static memberHOLDINFOLIST_HOLDINFO
static memberITEMINFO
static memberITEMINFO_AUTHOR
static memberITEMINFO_CALLNUMBER
static memberITEMINFO_ELECTRONICID
static memberITEMINFO_PRICE
static memberITEMINFO_TITLE
static memberITEMINFO_TYPE
static memberLIBRARYPATRONSTATUS
static memberLIBRARYPATRONSTATUS_ELECTRONICIDLIST
static memberLIBRARYPATRONSTATUS_FINEAMOUNT
static memberLIBRARYPATRONSTATUS_LIBRARYTYPE
static memberLIBRARYPATRONSTATUS_MESSAGELIST
static memberLIBRARYPATRONSTATUS_NUMBEROFCHECKOUTS
static memberLIBRARYPATRONSTATUS_NUMBEROFFINES
static memberLIBRARYPATRONSTATUS_NUMBEROFOVERDUES
static memberLIBRARYPATRONSTATUS_NUMBEROFREFUNDS
static memberLIBRARYPATRONSTATUS_REFUNDAMOUNT
static memberLIBRARYPATRONSTATUS_SIF_EXTENDEDELEMENTS
static memberLIBRARYPATRONSTATUS_SIF_METADATA
static memberLIBRARYPATRONSTATUS_SIF_REFID
static memberLIBRARYPATRONSTATUS_SIF_REFOBJECT
static memberLIBRARYPATRONSTATUS_TRANSACTIONLIST
Load()() (Overrides SdoLibraryImpl.Load()().)
static memberMESSAGE
static memberMESSAGE_PRIORITY
static memberMESSAGE_SENT
static memberMESSAGE_TEXT
static memberMESSAGELIST
static memberMESSAGELIST_MESSAGE
static memberREFUNDAMOUNT
static memberREFUNDAMOUNT_CURRENCY
static memberTRANSACTION
static memberTRANSACTION_CHECKOUTINFO
static memberTRANSACTION_FINEINFOLIST
static memberTRANSACTION_HOLDINFOLIST
static memberTRANSACTION_ITEMINFO
static memberTRANSACTIONLIST
static memberTRANSACTIONLIST_TRANSACTION
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
 LibraryDTD

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