com.edustructures.sifworks
Class TrackQueryResultsData

java.lang.Object
  com.edustructures.sifworks.TrackQueryResultsData

public class TrackQueryResultsData
extends java.lang.Object

Encapsulates result data returned by the TrackQueryResults class. For each SIF_Response message received by TrackQueryResults, an instance of this class is returned by the next method.

Version:

ADK 1.0

Constructor Summary

TrackQueryResultsData(DataObjectInputStream data, Zone zone, SIFMessageInfo info)
Constructor

TrackQueryResultsData(SIF_Error error, ElementDef objectType, Zone zone, SIFMessageInfo info)
Constructor for a response with errors

Method Summary

DataObjectInputStream	getData() Gets the array of SIFDataObjects received from the SIF_Response message.
SIF_Error	getError() Gets the SIF_Error element received from the SIF_Response message, if applicable.
SIFMessageInfo	getMessageInfo() Gets the SIFMessageInfo object describing additional information about the SIF Response message, including SIF header fields and optionally the XML content of the message.
Zone	getZone() Gets the zone from which the SIF Response data was received

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TrackQueryResultsData

public TrackQueryResultsData(DataObjectInputStream data,
                             Zone zone,
                             SIFMessageInfo info)

Constructor

Parameters:

data - The array of SIFDataObjects received from the SIF_Response message

zone - The zone from which the SIF Response data was received

info - The SIFMessageInfo object describing additional information about the SIF_Response message, including SIF header fields and optionally the XML content of the message.

TrackQueryResultsData

public TrackQueryResultsData(SIF_Error error,
                             ElementDef objectType,
                             Zone zone,
                             SIFMessageInfo info)

Constructor for a response with errors

Parameters:

error - The SIF_Error object contained in the SIF_Response message

objectType - A constant from the SIFDTD class identifying the SIF Data Object type associated with this response

zone - The zone from which the SIF Response data was received

info - The SIFMessageInfo object describing additional information about the SIF_Response message, including SIF header fields and optionally the XML content of the message.

Method Detail

getZone

public Zone getZone()

Gets the zone from which the SIF Response data was received

getMessageInfo

public SIFMessageInfo getMessageInfo()

Gets the SIFMessageInfo object describing additional information about the SIF Response message, including SIF header fields and optionally the XML content of the message.

getData

public DataObjectInputStream getData()

Gets the array of SIFDataObjects received from the SIF_Response message. If the query resulted in zero results, or if an error occurred, the stream may return a null value. However, this method will always return a valid stream from which to read.

See Also:

getError()

getError

public SIF_Error getError()

Gets the SIF_Error element received from the SIF_Response message, if applicable. If no error was returned with the SIF_Response, this method returns a null value. Agents should always check for the presence of an error, in which case no SIF Data Objects should be expected.

See Also:

getData()