com.edustructures.sifworks
Interface ReportObjectOutputStream

public interface ReportObjectOutputStream

The ReportObjectOutputStream is implemented by the ADK to supply agents with a means of streaming arbitrarily large SIF Data Objects responses for SIF_ReportObject queries in SIF 1.5 and later. The ADK handles packetizing and storing SIF_Responses for SIF_ReportObject in a local cache for reliable delivery to the ZIS.

Since:

ADK 1.5

Version:

ADK 1.5

Method Summary

void	setReportInfo(java.lang.String reportObjectRefId, ReportInfo info, Zone zone) Assign a ReportInfo instance to the stream.
void	write(SIFDataObject data) Write a SIFDataObject to the stream

Method Detail

setReportInfo

void setReportInfo(java.lang.String reportObjectRefId,
                   ReportInfo info,
                   Zone zone)
                   throws ADKException

Assign a ReportInfo instance to the stream.

The ReportInfo object identifies the report manifest to which the SIF_ReportObject relates, as well as information about this particular submission. The requesting agent uses this information to associate the report data with a report manifest. The ReportInfo will be included in each SIF_ReportObject packet sent with the response.

This method must be called before writing any SIFDataObject data to the stream via the write method. Once called, it must not be called again for the duration of the message processing or an IllegalStateException is thrown.

Parameters:

reportObjectRefId - The RefId of the SIF_ReportObject being streamed. The agent is responsible for assigning a RefId to the SIF_ReportObject and using the same RefId to identify all SIF_ReportObject instances that comprise the report data.

info - A ReportInfo instance from the com.edustructures.sifworks.reporting package

zone - The zone that is responding to the SIF_Request for SIF_ReportObjects

Throws:

java.lang.IllegalStateException - is thrown if this method is called more than once

ADKException

write

void write(SIFDataObject data)
           throws ADKException

Write a SIFDataObject to the stream

Throws:

ADKException