The SIF® Zone
creating, assimilating, and promoting excellence in SIF® agent development

Java Packages

Java Packages

 

The ADK is comprised of hundreds of Java classes and interfaces organized into 18 packages. Most core classes are found in the com.edustructures.sifworks package, while the remaining packages represent SIF Data Object (SDO) classes organized by SIF Working Group for consistency with the SIF Specification.

Browse the Javadoc to learn more about each package and the classes and interfaces they contain.

Package / Contents

com.edustructures.sifworks

Core classes and interfaces of the SIFWorks ADK. Here you'll find essential classes like ADK, ADKException, Agent, AgentProperties, Event, Query, SIFDataObject, SIFMessageInfo, and Zone, as well as message handler interfaces Subscriber, Publisher, ReportPublisher and QueryResults,

com.edustructures.sifworks.assessment

Classes to model Assessment Working Group Objects. Here you'll find classes like Assessment, AssessmentPackage, and AssessmentForm.

com.edustructures.sifworks.common

Classes to model Common Elements. Here you'll find classes like Name, PhoneNumber, and Demographics

com.edustructures.sifworks.dw

Classes to model Data Warehouse & Reporting Working Group Objects. Here you'll find classes like AggregateStatisticInfo, AggregateStatisticFact, and AggregateCharacteristicInfo

com.edustructures.sifworks.etranscript

Classes to model Student Record Exchange Working Group Objects. Here you'll find classes like StudentRecordExchange, StudentDemographicRecord, and StudentAcademicRecord

com.edustructures.sifworks.food

Classes to model Food Services Working Group Objects. Here you'll find classes like StudentMeal, StaffMeal, and FoodsericeItem

com.edustructures.sifworks.gradebook

Classes to model Grade Book Working Group Objects. Here you'll find classes like GradingAssignment, MarkInfo, and StudentPeriodAttendance.

com.edustructures.sifworks.hrfin

Classes to model Human Resources & Financials Working Group Objects. Here you'll find classes like EmployeePersonal, LocationInfo, and Payment

com.edustructures.sifworks.infra

Classes to model SIF Infrastructure Objects (primarily for internal use by the ADK). Some of the ADK's public interfaces pass an instance of the SIF_Error class as a method parameter, so often times you will import this package to access that class.

com.edustructures.sifworks.instr

Classes to model Instructional Services Working Group Objects. Here you'll find classes like Activity, Assignment, and Lesson

com.edustructures.sifworks.library

Classes to model Library Automation Working Group Objects. Here you'll find the LibraryPatronStatus class.

com.edustructures.sifworks.log

Classes and interfaces for the ADK's logging infrastructure. (Note: The classes found here are currently for server-side logging only. The open source Apache Log4j framework handles all client logging. In the future, client logging will be abstracted and placed in this package so that developers can use other logging frameworks besides Log4j.)

com.edustructures.sifworks.profdev

Classes and interfaces to model Professional Development Working Group Objects. Here you'll find the EmployeeCredential and EmployeeCredit classes, among others.

com.edustructures.sifworks.programs

Classes and interfaces to model Special Programs Working Group Objects. Here you'll find the StudentParticipation and StudentPlacement classes, among others.

com.edustructures.sifworks.reporting

Classes and interfaces to model Vertical Reporting Task Force Objects. Here you'll find the ReportManifest, StudentLocator, and SIF_ReportObject classes

com.edustructures.sifworks.student

Classes and interfaces to model Student Information Working Group Objects. Here you'll find classes like StudentPersonal, SchoolInfo, and StudentSchoolEnrollment

com.edustructures.sifworks.tools

Optional high-level classes for Configuration Files, Mappings, Query Formatters, Load Balancers, and other tools commonly used in the development of agents but outside the scope of the core ADK Class Framework

com.edustructures.sifworks.tools.cfg

The AgentConfig class implements an XML-based configuration file parser that agents can use as-is or as the basis for custom parsers

com.edustructures.sifworks.tools.mapping

The Mappings class simplifies the task of mapping field values between the local application's data structures and SIF Data Objects

com.edustructures.sifworks.tools.metadata

The ADKMetadata class allows custom SIF objects to be defined for use with the ADK.

com.edustructures.sifworks.tools.queries

The QueryFormatter class simplifies the task of converting SIF_Query elements to other forms such as SQL statements

com.edustructures.sifworks.tools.xpath

The SIFXPathContext class allows XPath queries to be run against ADK SIF Data Objects

com.edustructures.sifworks.trans

Classes to model Transportation & Geographic Information Working Group Objects. Here you'll find classes like BusInfo, BusRouteDetail, and BusRouteInfo

com.edustructures.util

        String, GUID, and XML utility routines

 

 

Recent Comments

Leave the first comment for this page.
Copyright ©2006-2009 sifzone.com
Sponsored by Edustructures
We Connect the Systems that Power Education
 
SIF and Schools Interoperability Framework are trademarks of the Schools Interoperability Framework Association.