com.edustructures.sifworks.reporting
Class ReportAuthorityInfo

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ReportAuthorityInfo
extends SIFDataObject

This object contains information on authorities that provide ReportManifest objects and/or collect SIF_ReportObject objects, such as state departments of education, regional service agencies, or other report collecting agencies. 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

ReportAuthorityInfo()
Constructor

ReportAuthorityInfo(java.lang.String refId, java.lang.String authorityName, java.lang.String authorityId, AuthorityLevel authorityLevel)
Constructor that accepts values for all mandatory fields

Method Summary

Address	getAddress() Gets the value of the <Address> element.
java.lang.String	getAuthorityDepartment() Gets the value of the <AuthorityDepartment> element.
java.lang.String	getAuthorityId() Gets the value of the <AuthorityId> element.
java.lang.String	getAuthorityLevel() Gets the value of the <AuthorityLevel> element.
java.lang.String	getAuthorityName() Gets the value of the <AuthorityName> 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.
java.lang.String	getRefId() Gets the value of the RefId attribute.
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	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	setAuthorityDepartment(java.lang.String value) Sets the value of the <AuthorityDepartment> element.
void	setAuthorityId(java.lang.String value) Sets the value of the <AuthorityId> element.
void	setAuthorityLevel(AuthorityLevel value) Sets the value of the <AuthorityLevel> element.
void	setAuthorityLevel(java.lang.String value) Sets the value of the <AuthorityLevel> element as a String.
void	setAuthorityName(java.lang.String value) Sets the value of the <AuthorityName> 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	setRefId(java.lang.String value) Sets the value of the RefId attribute.

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

ReportAuthorityInfo

public ReportAuthorityInfo()

Constructor

ReportAuthorityInfo

public ReportAuthorityInfo(java.lang.String refId,
                           java.lang.String authorityName,
                           java.lang.String authorityId,
                           AuthorityLevel authorityLevel)

Constructor that accepts values for all mandatory fields

Parameters:

refId - The unique identifier for this agency/report authority.

authorityName - Name of the agency/report authority.

authorityId - The zone unique case-sensitive identifier for the authority. This will be the contents of the SIF_SourceId element in the header of requests for reports.

authorityLevel - Level of the authority.

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 unique identifier for this agency/report authority."

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 unique identifier for this agency/report authority."

Parameters:

value - A String object

Since:

1.5r1

getAuthorityName

public java.lang.String getAuthorityName()

Gets the value of the <AuthorityName> element.

The SIF specification defines the meaning of this element as: "Name of the agency/report authority."

Returns:

The AuthorityName element of this object.

Since:

1.5r1

setAuthorityName

public void setAuthorityName(java.lang.String value)

Sets the value of the <AuthorityName> element.

The SIF specification defines the meaning of this element as: "Name of the agency/report authority."

Parameters:

value - A String object

Since:

1.5r1

getAuthorityId

public java.lang.String getAuthorityId()

Gets the value of the <AuthorityId> element.

The SIF specification defines the meaning of this element as: "The zone unique case-sensitive identifier for the authority. This will be the contents of the SIF_SourceId element in the header of requests for reports."

Returns:

The AuthorityId element of this object.

Since:

1.5r1

setAuthorityId

public void setAuthorityId(java.lang.String value)

Sets the value of the <AuthorityId> element.

The SIF specification defines the meaning of this element as: "The zone unique case-sensitive identifier for the authority. This will be the contents of the SIF_SourceId element in the header of requests for reports."

Parameters:

value - A String object

Since:

1.5r1

getAuthorityDepartment

public java.lang.String getAuthorityDepartment()

Gets the value of the <AuthorityDepartment> element.

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

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	"AuthorityDept"
SIF2.0	"AuthorityDepartment"

Returns:

The AuthorityDepartment element of this object.

Since:

1.5r1

setAuthorityDepartment

public void setAuthorityDepartment(java.lang.String value)

Sets the value of the <AuthorityDepartment> element.

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

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	"AuthorityDept"
SIF2.0	"AuthorityDepartment"

Parameters:

value - A String object

Since:

1.5r1

getAuthorityLevel

public java.lang.String getAuthorityLevel()

Gets the value of the <AuthorityLevel> element.

The SIF specification defines the meaning of this element as: "Level of the authority."

Returns:

The AuthorityLevel element of this object.

Since:

1.5r1

setAuthorityLevel

public void setAuthorityLevel(AuthorityLevel value)

Sets the value of the <AuthorityLevel> element.

The SIF specification defines the meaning of this element as: "Level of the authority."

Parameters:

value - A constant defined by the AuthorityLevel class

Since:

1.5r1

setAuthorityLevel

public void setAuthorityLevel(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "Level of the authority."

Parameters:

value - The value as a String

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."

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."

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 Address."

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 Address."

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