com.edustructures.sifworks.reporting
Class ReportSubmitterInfo

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ReportSubmitterInfo
extends SIFKeyedElement

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.

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

ReportSubmitterInfo()
Constructor

ReportSubmitterInfo(java.lang.String submitterName)
Constructor that accepts values for all mandatory fields

Method Summary

Address	getAddress() Gets the value of the <Address> element.
ContactInfo	getContactInfo() Gets the value of the <ContactInfo> 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
PhoneNumber	getPhoneNumber() Gets the value of the <PhoneNumber> element.
SIF_RefId	getSIF_RefId() Gets the value of the <SIF_RefId> element.
java.lang.String	getSubmitterDepartment() Gets the value of the <SubmitterDepartment> element.
java.lang.String	getSubmitterName() Gets the value of the <SubmitterName> element.
java.lang.String	getSubmitterNotes() Gets the value of the <SubmitterNotes> element.
void	removeAddress() Removes the Address child element previously created by calling setAddress
void	removeContactInfo() Removes the ContactInfo child element previously created by calling setContactInfo
void	removePhoneNumber() Removes the PhoneNumber child element previously created by calling setPhoneNumber
void	removeSIF_RefId() Removes the SIF_RefId child element previously created by calling setSIF_RefId
void	setAddress(Address value) Sets the value of the <Address> element.
void	setAddress(AddressType type, Street street, java.lang.String city, StatePrCode stateProvince, CountryCode country, java.lang.String postalCode) Sets the value of the <Address> child element.
void	setContactInfo(ContactInfo value) Sets the value of the <ContactInfo> element.
void	setContactInfo(Name name) Sets the value of the <ContactInfo> child element.
void	setPhoneNumber(PhoneNumber value) Sets the value of the <PhoneNumber> element.
void	setPhoneNumber(PhoneNumberType type, java.lang.String number) Sets the value of the <PhoneNumber> child element.
void	setSIF_RefId(SIF_RefId value) Sets the value of the <SIF_RefId> element.
void	setSIF_RefId(java.lang.String sifRefObject, java.lang.String value) Sets the value of the <SIF_RefId> child element.
void	setSubmitterDepartment(java.lang.String value) Sets the value of the <SubmitterDepartment> element.
void	setSubmitterName(java.lang.String value) Sets the value of the <SubmitterName> element.
void	setSubmitterNotes(java.lang.String value) Sets the value of the <SubmitterNotes> 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

ReportSubmitterInfo

public ReportSubmitterInfo()

Constructor

ReportSubmitterInfo

public ReportSubmitterInfo(java.lang.String submitterName)

Constructor that accepts values for all mandatory fields

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.

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

setSIF_RefId

public void setSIF_RefId(SIF_RefId value)

Sets the value of the <SIF_RefId> element.

The SIF specification defines the meaning of this element as: "If the submitter is described by another SIF data object such as a SchoolInfo or LEAInfo instance, this element references that object by RefId."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"SifEntity"
SIF2.0	"SIF_RefId"

Parameters:

value - A SIF_RefId object

Since:

1.5r1

setSIF_RefId

public void setSIF_RefId(java.lang.String sifRefObject,
                         java.lang.String value)

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

Parameters:

sifRefObject -

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

Since:

1.5r1

getSIF_RefId

public SIF_RefId getSIF_RefId()

Gets the value of the <SIF_RefId> element.

The SIF specification defines the meaning of this element as: "If the submitter is described by another SIF data object such as a SchoolInfo or LEAInfo instance, this element references that object by RefId."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"SifEntity"
SIF2.0	"SIF_RefId"

Returns:

A SIF_RefId object

Since:

1.5r1

removeSIF_RefId

public void removeSIF_RefId()

Removes the SIF_RefId child element previously created by calling setSIF_RefId

Since:

1.5r1

getSubmitterName

public java.lang.String getSubmitterName()

Gets the value of the <SubmitterName> element.

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

Returns:

The SubmitterName element of this object.

Since:

1.5r1

setSubmitterName

public void setSubmitterName(java.lang.String value)

Sets the value of the <SubmitterName> element.

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

Parameters:

value - A String object

Since:

1.5r1

getSubmitterDepartment

public java.lang.String getSubmitterDepartment()

Gets the value of the <SubmitterDepartment> element.

The SIF specification defines the meaning of this element as: "Department, office, or subdivision of the agency submitting the report."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"SubmitterDept"
SIF2.0	"SubmitterDepartment"

Returns:

The SubmitterDepartment element of this object.

Since:

1.5r1

setSubmitterDepartment

public void setSubmitterDepartment(java.lang.String value)

Sets the value of the <SubmitterDepartment> element.

The SIF specification defines the meaning of this element as: "Department, office, or subdivision of the agency submitting the report."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"SubmitterDept"
SIF2.0	"SubmitterDepartment"

Parameters:

value - A String object

Since:

1.5r1

setContactInfo

public void setContactInfo(ContactInfo value)

Sets the value of the <ContactInfo> element.

The SIF specification defines the meaning of this element as: "Information on the contact person in this agency submitting the report. For a description of this element, see 5.1.3 ContactInfo."

Parameters:

value - A ContactInfo object

Since:

1.5r1

setContactInfo

public void setContactInfo(Name name)

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

Parameters:

name - The name of the contact person.

Since:

1.5r1

getContactInfo

public ContactInfo getContactInfo()

Gets the value of the <ContactInfo> element.

The SIF specification defines the meaning of this element as: "Information on the contact person in this agency submitting the report. For a description of this element, see 5.1.3 ContactInfo."

Returns:

A ContactInfo object

Since:

1.5r1

removeContactInfo

public void removeContactInfo()

Removes the ContactInfo child element previously created by calling setContactInfo

Since:

1.5r1

setAddress

public void setAddress(Address value)

Sets the value of the <Address> element.

The SIF specification defines the meaning of this element as: "For a description of this element, see 5.1.1 AddressAddress."

Parameters:

value - A Address object

Since:

1.5r1

setAddress

public void setAddress(AddressType type,
                       Street street,
                       java.lang.String city,
                       StatePrCode stateProvince,
                       CountryCode country,
                       java.lang.String postalCode)

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

Parameters:

type - Code that defines the location of the address. Note: A subset of specific valid values for each instance in a data object may be listed in that object.

street - The street part of the address

city - The city part of the address.

stateProvince - The state or province code.

country - The country code.

postalCode - The ZIP/postal code.

Since:

1.5r1

getAddress

public Address getAddress()

Gets the value of the <Address> element.

The SIF specification defines the meaning of this element as: "For a description of this element, see 5.1.1 AddressAddress."

Returns:

An Address object

Since:

1.5r1

removeAddress

public void removeAddress()

Removes the Address child element previously created by calling setAddress

Since:

1.5r1

setPhoneNumber

public void setPhoneNumber(PhoneNumber value)

Sets the value of the <PhoneNumber> element.

The SIF specification defines the meaning of this element as: "For a description of this element, see 5.1.22 PhoneNumber."

Parameters:

value - A PhoneNumber object

Since:

1.5r1

setPhoneNumber

public void setPhoneNumber(PhoneNumberType type,
                           java.lang.String number)

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

Parameters:

type - Code that specifies what type of phone number this is. Note: A subset of valid values may be specified in data objects.

number - Phone number. Acceptable formats:

Since:

1.5r1

getPhoneNumber

public PhoneNumber getPhoneNumber()

Gets the value of the <PhoneNumber> element.

The SIF specification defines the meaning of this element as: "For a description of this element, see 5.1.22 PhoneNumber."

Returns:

A PhoneNumber object

Since:

1.5r1

removePhoneNumber

public void removePhoneNumber()

Removes the PhoneNumber child element previously created by calling setPhoneNumber

Since:

1.5r1

getSubmitterNotes

public java.lang.String getSubmitterNotes()

Gets the value of the <SubmitterNotes> element.

The SIF specification defines the meaning of this element as: "Optional notes for the report authority, such as information about a district's reporting policies and procedures, instructions for contacting the district for technical support, etc."

Returns:

The SubmitterNotes element of this object.

Since:

1.5r1

setSubmitterNotes

public void setSubmitterNotes(java.lang.String value)

Sets the value of the <SubmitterNotes> element.

The SIF specification defines the meaning of this element as: "Optional notes for the report authority, such as information about a district's reporting policies and procedures, instructions for contacting the district for technical support, etc."

Parameters:

value - A String object

Since:

1.5r1