com.edustructures.sifworks.reporting
Class ReportManifest

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ReportManifest
extends SIFDataObject

This object provides a way to define a report within a SIF zone. It contains metadata about the report. This object represents a mutual agreement between senders and receivers of the 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

ReportManifest()
Constructor

ReportManifest(java.lang.String refId, java.lang.String sifVersion, java.lang.Integer sifMaxBufferSize, java.lang.String reportName, ReportDefinitionSource reportDefinitionSource)
Constructor that accepts values for all mandatory fields

Method Summary

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
ReceivingAuthority	getReceivingAuthority() Gets the value of the <ReceivingAuthority> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
java.lang.String	getReportAuthorityInfoRefId() Gets the value of the ReportAuthorityInfoRefId attribute.
ReportDefinitionSource	getReportDefinitionSource() Gets the value of the <ReportDefinitionSource> element.
ReportFormatList	getReportFormatList() Gets the value of the <ReportFormatList> element.
ReportingPeriod	getReportingPeriod() Gets the value of the <ReportingPeriod> element.
java.lang.String	getReportName() Gets the value of the <ReportName> element.
SIF_ExtendedQuery	getSIF_ExtendedQuery() Gets the value of the <SIF_ExtendedQuery> element.
java.lang.Integer	getSIF_MaxBufferSize() Gets the value of the <SIF_MaxBufferSize> element.
SIF_QueryGroup	getSIF_QueryGroup() Gets the value of the <SIF_QueryGroup> element.
java.lang.String	getSIF_Version() Gets the value of the <SIF_Version> element.
void	removeReceivingAuthority() Removes the ReceivingAuthority child element previously created by calling setReceivingAuthority
void	removeReportDefinitionSource() Removes the ReportDefinitionSource child element previously created by calling setReportDefinitionSource
void	removeReportFormatList() Removes the ReportFormatList child element previously created by calling setReportFormatList
void	removeReportingPeriod() Removes the ReportingPeriod child element previously created by calling setReportingPeriod
void	removeSIF_ExtendedQuery() Removes the SIF_ExtendedQuery child element previously created by calling setSIF_ExtendedQuery
void	removeSIF_QueryGroup() Removes the SIF_QueryGroup child element previously created by calling setSIF_QueryGroup
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setReceivingAuthority(ReceivingAuthority value) Sets the value of the <ReceivingAuthority> element.
void	setReceivingAuthority(java.lang.String sifRefObject, java.lang.String value) Sets the value of the <ReceivingAuthority> child element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setReportAuthorityInfoRefId(java.lang.String value) Sets the value of the ReportAuthorityInfoRefId attribute.
void	setReportDefinitionSource(ReportDefinitionSource value) Sets the value of the <ReportDefinitionSource> element.
void	setReportDefinitionSource(ReportDefinitionSourceType type, java.lang.String value) Sets the value of the <ReportDefinitionSource> child element.
void	setReportFormatList(ReportFormatList value) Sets the value of the <ReportFormatList> element.
void	setReportingPeriod(ReportingPeriod value) Sets the value of the <ReportingPeriod> element.
void	setReportName(java.lang.String value) Sets the value of the <ReportName> element.
void	setSIF_ExtendedQuery(SIF_ExtendedQuery value) Sets the value of the <SIF_ExtendedQuery> element.
void	setSIF_ExtendedQuery(SIF_Select sifSelect, SIF_From sifFrom) Sets the value of the <SIF_ExtendedQuery> child element.
void	setSIF_MaxBufferSize(java.lang.Integer value) Sets the value of the <SIF_MaxBufferSize> element.
void	setSIF_QueryGroup(SIF_QueryGroup value) Sets the value of the <SIF_QueryGroup> element.
void	setSIF_Version(java.lang.String value) Sets the value of the <SIF_Version> 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

ReportManifest

public ReportManifest()

Constructor

ReportManifest

public ReportManifest(java.lang.String refId,
                      java.lang.String sifVersion,
                      java.lang.Integer sifMaxBufferSize,
                      java.lang.String reportName,
                      ReportDefinitionSource reportDefinitionSource)

Constructor that accepts values for all mandatory fields

Parameters:

refId - The unique identifier for this report manifest.

sifVersion - Specifies which SIF Specification version should be used when returning the report data; wildcards are allowed. When a wildcard is specified, the responding agent SHOULD attempt to return the report data in the version specified by SIF_Message/@Version, if that version matches the wildcard version. If not, the responding agent can return the data in any version it chooses that matches the wildcard version.

sifMaxBufferSize - Specifies the maximum size of a packet to be returned to the report authority.

reportName - The authority's accepted name for the report.

reportDefinitionSource - Indicates where the report definition can be found. If Type is Embedded or Base64Binary, this element's value contains the report definition. If Type is URL, this element's value is the location of the external definition. A Type value of SIF_Query indicates that the SIF_QueryGroup element contains the definition.

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

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

Parameters:

value - A String object

Since:

1.5r1

getReportAuthorityInfoRefId

public java.lang.String getReportAuthorityInfoRefId()

Gets the value of the ReportAuthorityInfoRefId attribute.

The SIF specification defines the meaning of this attribute as: "ID (GUID) of the authority providing this manifest."

Returns:

The ReportAuthorityInfoRefId attribute of this object.

Since:

1.5r1

setReportAuthorityInfoRefId

public void setReportAuthorityInfoRefId(java.lang.String value)

Sets the value of the ReportAuthorityInfoRefId attribute.

The SIF specification defines the meaning of this attribute as: "ID (GUID) of the authority providing this manifest."

Parameters:

value - A String object

Since:

1.5r1

getSIF_Version

public java.lang.String getSIF_Version()

Gets the value of the <SIF_Version> element.

The SIF specification defines the meaning of this element as: "Specifies which SIF Specification version should be used when returning the report data; wildcards are allowed. When a wildcard is specified, the responding agent SHOULD attempt to return the report data in the version specified by SIF_Message/@Version, if that version matches the wildcard version. If not, the responding agent can return the data in any version it chooses that matches the wildcard version."

Returns:

The SIF_Version element of this object.

Since:

1.5r1

setSIF_Version

public void setSIF_Version(java.lang.String value)

Sets the value of the <SIF_Version> element.

The SIF specification defines the meaning of this element as: "Specifies which SIF Specification version should be used when returning the report data; wildcards are allowed. When a wildcard is specified, the responding agent SHOULD attempt to return the report data in the version specified by SIF_Message/@Version, if that version matches the wildcard version. If not, the responding agent can return the data in any version it chooses that matches the wildcard version."

Parameters:

value - A String object

Since:

1.5r1

getSIF_MaxBufferSize

public java.lang.Integer getSIF_MaxBufferSize()

Gets the value of the <SIF_MaxBufferSize> element.

The SIF specification defines the meaning of this element as: "Specifies the maximum size of a packet to be returned to the report authority."

Returns:

The SIF_MaxBufferSize element of this object.

Since:

1.5r1

setSIF_MaxBufferSize

public void setSIF_MaxBufferSize(java.lang.Integer value)

Sets the value of the <SIF_MaxBufferSize> element.

The SIF specification defines the meaning of this element as: "Specifies the maximum size of a packet to be returned to the report authority."

Parameters:

value - A Integer object

Since:

1.5r1

setReceivingAuthority

public void setReceivingAuthority(ReceivingAuthority value)

Sets the value of the <ReceivingAuthority> element.

The SIF specification defines the meaning of this element as: "The authority for whom the report is intended, usually the same authority that defines this manifest."

Parameters:

value - A ReceivingAuthority object

Since:

1.5r1

setReceivingAuthority

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

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

Parameters:

sifRefObject - The name of the object referenced.

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

Since:

1.5r1

getReceivingAuthority

public ReceivingAuthority getReceivingAuthority()

Gets the value of the <ReceivingAuthority> element.

The SIF specification defines the meaning of this element as: "The authority for whom the report is intended, usually the same authority that defines this manifest."

Returns:

A ReceivingAuthority object

Since:

1.5r1

removeReceivingAuthority

public void removeReceivingAuthority()

Removes the ReceivingAuthority child element previously created by calling setReceivingAuthority

Since:

1.5r1

getReportName

public java.lang.String getReportName()

Gets the value of the <ReportName> element.

The SIF specification defines the meaning of this element as: "The authority's accepted name for the report."

Returns:

The ReportName element of this object.

Since:

1.5r1

setReportName

public void setReportName(java.lang.String value)

Sets the value of the <ReportName> element.

The SIF specification defines the meaning of this element as: "The authority's accepted name for the report."

Parameters:

value - A String object

Since:

1.5r1

getDescription

public java.lang.String getDescription()

Gets the value of the <Description> element.

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

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.

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

Parameters:

value - A String object

Since:

1.5r1

setReportingPeriod

public void setReportingPeriod(ReportingPeriod value)

Sets the value of the <ReportingPeriod> element.

The SIF specification defines the meaning of this element as: "Information on the period of time over which the report spans."

Parameters:

value - A ReportingPeriod object

Since:

1.5r1

getReportingPeriod

public ReportingPeriod getReportingPeriod()

Gets the value of the <ReportingPeriod> element.

The SIF specification defines the meaning of this element as: "Information on the period of time over which the report spans."

Returns:

A ReportingPeriod object

Since:

1.5r1

removeReportingPeriod

public void removeReportingPeriod()

Removes the ReportingPeriod child element previously created by calling setReportingPeriod

Since:

1.5r1

setReportDefinitionSource

public void setReportDefinitionSource(ReportDefinitionSource value)

Sets the value of the <ReportDefinitionSource> element.

The SIF specification defines the meaning of this element as: "Indicates where the report definition can be found. If Type is Embedded or Base64Binary, this element's value contains the report definition. If Type is URL, this element's value is the location of the external definition. A Type value of SIF_Query indicates that the SIF_QueryGroup element contains the definition."

Parameters:

value - A ReportDefinitionSource object

Since:

1.5r1

setReportDefinitionSource

public void setReportDefinitionSource(ReportDefinitionSourceType type,
                                      java.lang.String value)

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

Parameters:

type - This attribute indicates the source of the report definition.

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

Since:

1.5r1

getReportDefinitionSource

public ReportDefinitionSource getReportDefinitionSource()

Gets the value of the <ReportDefinitionSource> element.

The SIF specification defines the meaning of this element as: "Indicates where the report definition can be found. If Type is Embedded or Base64Binary, this element's value contains the report definition. If Type is URL, this element's value is the location of the external definition. A Type value of SIF_Query indicates that the SIF_QueryGroup element contains the definition."

Returns:

A ReportDefinitionSource object

Since:

1.5r1

removeReportDefinitionSource

public void removeReportDefinitionSource()

Removes the ReportDefinitionSource child element previously created by calling setReportDefinitionSource

Since:

1.5r1

setReportFormatList

public void setReportFormatList(ReportFormatList value)

Sets the value of the <ReportFormatList> element.

The SIF specification defines the meaning of this element as: "References a third-party format that describes the visual representation of the report data."

Parameters:

value - A ReportFormatList object

Since:

1.5r1

getReportFormatList

public ReportFormatList getReportFormatList()

Gets the value of the <ReportFormatList> element.

The SIF specification defines the meaning of this element as: "References a third-party format that describes the visual representation of the report data."

Returns:

A ReportFormatList object

Since:

1.5r1

removeReportFormatList

public void removeReportFormatList()

Removes the ReportFormatList child element previously created by calling setReportFormatList

Since:

1.5r1

setSIF_QueryGroup

public void setSIF_QueryGroup(SIF_QueryGroup value)

Sets the value of the <SIF_QueryGroup> element.

The SIF specification defines the meaning of this element as: "Parent element containing the querying criteria for extracting the report information. SIF_QueryGroup subelements are the same as the SIF_Query subelement of the SIF_Request object, except that the set of valid SIF_Operator values for this object is an expanded set."

Parameters:

value - A SIF_QueryGroup object

Since:

1.5r1

getSIF_QueryGroup

public SIF_QueryGroup getSIF_QueryGroup()

Gets the value of the <SIF_QueryGroup> element.

The SIF specification defines the meaning of this element as: "Parent element containing the querying criteria for extracting the report information. SIF_QueryGroup subelements are the same as the SIF_Query subelement of the SIF_Request object, except that the set of valid SIF_Operator values for this object is an expanded set."

Returns:

A SIF_QueryGroup object

Since:

1.5r1

removeSIF_QueryGroup

public void removeSIF_QueryGroup()

Removes the SIF_QueryGroup child element previously created by calling setSIF_QueryGroup

Since:

1.5r1

setSIF_ExtendedQuery

public void setSIF_ExtendedQuery(SIF_ExtendedQuery value)

Sets the value of the <SIF_ExtendedQuery> element.

The SIF specification defines the meaning of this element as: "Query criteria for extracting the report information if ReportDefinitionSource/@Type is SIF_ExtendedQuery."

Parameters:

value - A SIF_ExtendedQuery object

Since:

2.0

setSIF_ExtendedQuery

public void setSIF_ExtendedQuery(SIF_Select sifSelect,
                                 SIF_From sifFrom)

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

Parameters:

sifSelect -

sifFrom -

Since:

2.0

getSIF_ExtendedQuery

public SIF_ExtendedQuery getSIF_ExtendedQuery()

Gets the value of the <SIF_ExtendedQuery> element.

The SIF specification defines the meaning of this element as: "Query criteria for extracting the report information if ReportDefinitionSource/@Type is SIF_ExtendedQuery."

Returns:

A SIF_ExtendedQuery object

Since:

2.0

removeSIF_ExtendedQuery

public void removeSIF_ExtendedQuery()

Removes the SIF_ExtendedQuery child element previously created by calling setSIF_ExtendedQuery

Since:

2.0