com.edustructures.sifworks.reporting
Class ReportInfo

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.reporting.ReportInfo

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ReportInfo
extends SIFKeyedElement

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.

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

ReportInfo()
Constructor

ReportInfo(java.lang.String reportManifestRefId, java.util.Calendar calculationDate, java.lang.Integer submissionNumber, SubmissionReason submissionReason)
Constructor that accepts values for all mandatory fields

Method Summary

java.util.Calendar	getCalculationDate() Gets the value of the <CalculationDate> element.
java.lang.String	getDescription() Gets the value of the <Description> element.
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	getReportManifestRefId() Gets the value of the ReportManifestRefId attribute.
ReportSubmitterInfo	getReportSubmitterInfo() Gets the value of the <ReportSubmitterInfo> element.
java.lang.Integer	getSubmissionNumber() Gets the value of the <SubmissionNumber> element.
java.lang.String	getSubmissionReason() Gets the value of the <SubmissionReason> element.
void	removeReportSubmitterInfo() Removes the ReportSubmitterInfo child element previously created by calling setReportSubmitterInfo
void	setCalculationDate(java.util.Calendar value) Sets the value of the <CalculationDate> element.
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setReportManifestRefId(java.lang.String value) Sets the value of the ReportManifestRefId attribute.
void	setReportSubmitterInfo(ReportSubmitterInfo value) Sets the value of the <ReportSubmitterInfo> element.
void	setReportSubmitterInfo(java.lang.String submitterName) Sets the value of the <ReportSubmitterInfo> child element.
void	setSubmissionNumber(java.lang.Integer value) Sets the value of the <SubmissionNumber> element.
void	setSubmissionReason(java.lang.String value) Sets the value of the <SubmissionReason> element as a String.
void	setSubmissionReason(SubmissionReason value) Sets the value of the <SubmissionReason> element.

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getSIFVersion, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, setSIFVersion, 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

ReportInfo

public ReportInfo()

Constructor

ReportInfo

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

Constructor that accepts values for all mandatory fields

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.

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

getReportManifestRefId

public java.lang.String getReportManifestRefId()

Gets the value of the ReportManifestRefId attribute.

The SIF specification defines the meaning of this attribute as: "The report manifest corresponding to this report."

Returns:

The ReportManifestRefId attribute of this object.

Since:

1.5r1

setReportManifestRefId

public void setReportManifestRefId(java.lang.String value)

Sets the value of the ReportManifestRefId attribute.

The SIF specification defines the meaning of this attribute as: "The report manifest corresponding to this report."

Parameters:

value - A String object

Since:

1.5r1

getCalculationDate

public java.util.Calendar getCalculationDate()

Gets the value of the <CalculationDate> element.

The SIF specification defines the meaning of this element as: "The date on which the report was calculated."

Returns:

The CalculationDate element of this object.

Since:

1.5r1

setCalculationDate

public void setCalculationDate(java.util.Calendar value)

Sets the value of the <CalculationDate> element.

The SIF specification defines the meaning of this element as: "The date on which the report was calculated."

Parameters:

value - A Calendar object

Since:

1.5r1

getSubmissionNumber

public java.lang.Integer getSubmissionNumber()

Gets the value of the <SubmissionNumber> element.

The SIF specification defines the meaning of this element as: "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)."

Returns:

The SubmissionNumber element of this object.

Since:

1.5r1

setSubmissionNumber

public void setSubmissionNumber(java.lang.Integer value)

Sets the value of the <SubmissionNumber> element.

The SIF specification defines the meaning of this element as: "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)."

Parameters:

value - A Integer object

Since:

1.5r1

getSubmissionReason

public java.lang.String getSubmissionReason()

Gets the value of the <SubmissionReason> element.

The SIF specification defines the meaning of this element as: "Reason for the report submission."

Returns:

The SubmissionReason element of this object.

Since:

1.5r1

setSubmissionReason

public void setSubmissionReason(SubmissionReason value)

Sets the value of the <SubmissionReason> element.

The SIF specification defines the meaning of this element as: "Reason for the report submission."

Parameters:

value - A constant defined by the SubmissionReason class

Since:

1.5r1

setSubmissionReason

public void setSubmissionReason(java.lang.String value)

Sets the value of the <SubmissionReason> element as a String.

The SIF specification defines the meaning of this element as: "Reason for the report submission."

Parameters:

value - The value as a String

Since:

1.5r1

setReportSubmitterInfo

public void setReportSubmitterInfo(ReportSubmitterInfo value)

Sets the value of the <ReportSubmitterInfo> element.

The SIF specification defines the meaning of this element as: "Identifies the submitter of the report.This element is conditional depending on the context in which the SIF_ReportObject is used. It must be present in the ReportInfo element when a SIF_ReportObject is sent to a report authority in a SIF_Event message. However, its presence is optional in SIF_ReportObject packets delivered to report authorities in SIF_Response messages."

Parameters:

value - A ReportSubmitterInfo object

Since:

1.5r1

setReportSubmitterInfo

public void setReportSubmitterInfo(java.lang.String submitterName)

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

Parameters:

submitterName - Name of the report submitter.This is a descriptive string that names the entity submitting the SIF_ReportObject to the report authority. It could be the name of an agency, a district, a school, the SIF_SourceId of the submitting agent, or any other string that a report authority could use to identify the submitter of a report. This element may be present regardless of the presence of the SifRefIdType and SifRefId elements. When those elements are used, it is recommended that collector agents reproduce the name of the LEA or school here.

Since:

1.5r1

getReportSubmitterInfo

public ReportSubmitterInfo getReportSubmitterInfo()

Gets the value of the <ReportSubmitterInfo> element.

The SIF specification defines the meaning of this element as: "Identifies the submitter of the report.This element is conditional depending on the context in which the SIF_ReportObject is used. It must be present in the ReportInfo element when a SIF_ReportObject is sent to a report authority in a SIF_Event message. However, its presence is optional in SIF_ReportObject packets delivered to report authorities in SIF_Response messages."

Returns:

A ReportSubmitterInfo object

Since:

1.5r1

removeReportSubmitterInfo

public void removeReportSubmitterInfo()

Removes the ReportSubmitterInfo child element previously created by calling setReportSubmitterInfo

Since:

1.5r1

getDescription

public java.lang.String getDescription()

Gets the value of the <Description> element.

Returns:

The Description element of this object.

Since:

1.5r1

setDescription

public void setDescription(java.lang.String value)

Sets the value of the <Description> element.

Parameters:

value - A String object

Since:

1.5r1