com.edustructures.sifworks.reporting
Class SIF_ReportObject

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.reporting.SIF_ReportObject

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SIF_ReportObject
extends SIFDataObject

This object is an envelope used to send other data objects, typically reports, to authorities such as state departments of education, district offices, other schools, etc. It is also used to signal a data collector agent that a report is compiled and ready to be requested. SIF_ReportObject contains a data object, which is either complete or partial (a partial data object is one that contains a subset of the elements for the data object). One or a series of SIF_ReportObjects contained within one or a series of related SIF_Response messages makes up a complete report. SIF_Events are reported.

Since:

1.5r1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

SIF_ReportObject()
Constructor

SIF_ReportObject(java.lang.String refId)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
java.lang.String	getRefId() Gets the value of the RefId attribute.
ReportData	getReportData() Gets the value of the <ReportData> element.
ReportInfo	getReportInfo() Gets the value of the <ReportInfo> element.
SIF_ExtendedQueryResults	getSIF_ExtendedQueryResults() Gets the value of the <SIF_ExtendedQueryResults> element.
void	removeReportData() Removes the ReportData child element previously created by calling setReportData
void	removeReportInfo() Removes the ReportInfo child element previously created by calling setReportInfo
void	removeSIF_ExtendedQueryResults() Removes the SIF_ExtendedQueryResults child element previously created by calling setSIF_ExtendedQueryResults
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setReportData(ReportData value) Sets the value of the <ReportData> element.
void	setReportData(java.lang.String value) Sets the value of the <ReportData> child element.
void	setReportInfo(ReportInfo value) Sets the value of the <ReportInfo> element.
void	setReportInfo(java.lang.String reportManifestRefId, java.util.Calendar calculationDate, java.lang.Integer submissionNumber, SubmissionReason submissionReason) Sets the value of the <ReportInfo> child element.
void	setSIF_ExtendedQueryResults(SIF_ExtendedQueryResults value) Sets the value of the <SIF_ExtendedQueryResults> element.
void	setSIF_ExtendedQueryResults(SIFColumnHeader sifColumnHeaders, SIF_Rows sifRows) Sets the value of the <SIF_ExtendedQueryResults> child element.

Methods inherited from class com.edustructures.sifworks.SIFDataObject

addSIFExtendedElement, clone, getElementOrAttribute, getObjectTag, getObjectType, getSIFExtendedElement, getSIFExtendedElements, getSIFExtendedElementsContainer, getSIFMetadata, getSIFVersion, setElementOrAttribute, setElementOrAttribute, setElementOrAttribute, setSIFExtendedElements, setSIFExtendedElementsContainer, setSIFMetadata, setSIFVersion, toXML

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, setTextValue, setXmlId, tag

Methods inherited from class com.edustructures.sifworks.Element

compareTo, getElementDef, getParent, getRoot, isChanged, isDoNotEncode, isEmpty, setChanged, setDoNotEncode, setElementDef, setEmpty, setParent, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SIF_ReportObject

public SIF_ReportObject()

Constructor

SIF_ReportObject

public SIF_ReportObject(java.lang.String refId)

Constructor that accepts values for all mandatory fields

Parameters:

refId - The ID (GUID) that uniquely identifies this instance of a report.

Method Detail

getKey

public java.lang.String getKey()

Gets the key of this object

Overrides:

getKey in class SIFElement

Returns:

The value of the object's Mandatory or Required attribute. If an object has more than one such attribute, the key is a period- delimited concatenation of the attribute values in sequential order

getKeyFields

public ElementDef[] getKeyFields()

Gets the metadata fields that make up the key of this object

Returns:

an array of metadata fields that make up the object's key

getRefId

public java.lang.String getRefId()

Gets the value of the RefId attribute.

The SIF specification defines the meaning of this attribute as: "The ID (GUID) that uniquely identifies this instance of a report."

Overrides:

getRefId in class SIFDataObject

Returns:

The RefId attribute of this object.

Since:

1.5r1

setRefId

public void setRefId(java.lang.String value)

Sets the value of the RefId attribute.

The SIF specification defines the meaning of this attribute as: "The ID (GUID) that uniquely identifies this instance of a report."

Parameters:

value - A String object

Since:

1.5r1

setReportInfo

public void setReportInfo(ReportInfo value)

Sets the value of the <ReportInfo> element.

The SIF specification defines the meaning of this element as: "Identifies the manifest for the report and characteristics of the submission. This element is a conditional element. This element is included or the ReportData element is included but never both at the same time within an instance of this object. See examples of the usage of the object below"

Parameters:

value - A ReportInfo object

Since:

1.5r1

setReportInfo

public void setReportInfo(java.lang.String reportManifestRefId,
                          java.util.Calendar calculationDate,
                          java.lang.Integer submissionNumber,
                          SubmissionReason submissionReason)

Sets the value of the <ReportInfo> child element. This form of setReportInfo is provided as a convenience method that is functionally equivalent to the version of setReportInfo that accepts a single ReportInfo object.

Parameters:

reportManifestRefId - The report manifest corresponding to this report.

calculationDate - The date on which the report was calculated.

submissionNumber - A number that identifies the submission; beginning at 1 and incremented each time a submission is done for a particular report; used to indicate resubmission(s).

submissionReason - Reason for the report submission.

Since:

1.5r1

getReportInfo

public ReportInfo getReportInfo()

Gets the value of the <ReportInfo> element.

The SIF specification defines the meaning of this element as: "Identifies the manifest for the report and characteristics of the submission. This element is a conditional element. This element is included or the ReportData element is included but never both at the same time within an instance of this object. See examples of the usage of the object below"

Returns:

A ReportInfo object

Since:

1.5r1

removeReportInfo

public void removeReportInfo()

Removes the ReportInfo child element previously created by calling setReportInfo

Since:

1.5r1

setReportData

public void setReportData(ReportData value)

Sets the value of the <ReportData> element.

The SIF specification defines the meaning of this element as: "Container element for the report content; one valid SIF object can occur as a child here. This element is conditional. This element or ReportInfo or SIF_ExtendedQueryResults is included but never at the same time. See examples of the usage of the object below."

Parameters:

value - A ReportData object

Since:

1.5r1

setReportData

public void setReportData(java.lang.String value)

Sets the value of the <ReportData> child element. This form of setReportData is provided as a convenience method that is functionally equivalent to the version of setReportData that accepts a single ReportData object.

Parameters:

value - Gets or sets the content value of the <ReportData> element

Since:

1.5r1

getReportData

public ReportData getReportData()

Gets the value of the <ReportData> element.

The SIF specification defines the meaning of this element as: "Container element for the report content; one valid SIF object can occur as a child here. This element is conditional. This element or ReportInfo or SIF_ExtendedQueryResults is included but never at the same time. See examples of the usage of the object below."

Returns:

A ReportData object

Since:

1.5r1

removeReportData

public void removeReportData()

Removes the ReportData child element previously created by calling setReportData

Since:

1.5r1

setSIF_ExtendedQueryResults

public void setSIF_ExtendedQueryResults(SIF_ExtendedQueryResults value)

Sets the value of the <SIF_ExtendedQueryResults> element.

The SIF specification defines the meaning of this element as: "The report content resulting from a SIF_ExtendedQuery-based report. This element is conditional. This element or ReportInfo or ReportData is included but never at the same time. "

Parameters:

value - A SIF_ExtendedQueryResults object

Since:

2.0

setSIF_ExtendedQueryResults

public void setSIF_ExtendedQueryResults(SIFColumnHeader sifColumnHeaders,
                                        SIF_Rows sifRows)

Sets the value of the <SIF_ExtendedQueryResults> child element. This form of setSIF_ExtendedQueryResults is provided as a convenience method that is functionally equivalent to the version of setSIF_ExtendedQueryResults that accepts a single SIF_ExtendedQueryResults object.

Parameters:

sifColumnHeaders -

sifRows -

Since:

2.0

getSIF_ExtendedQueryResults

public SIF_ExtendedQueryResults getSIF_ExtendedQueryResults()

Gets the value of the <SIF_ExtendedQueryResults> element.

The SIF specification defines the meaning of this element as: "The report content resulting from a SIF_ExtendedQuery-based report. This element is conditional. This element or ReportInfo or ReportData is included but never at the same time. "

Returns:

A SIF_ExtendedQueryResults object

Since:

2.0

removeSIF_ExtendedQueryResults

public void removeSIF_ExtendedQueryResults()

Removes the SIF_ExtendedQueryResults child element previously created by calling setSIF_ExtendedQueryResults

Since:

2.0