com.edustructures.sifworks.reporting
Class ReportFormatList

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<ReportFormat>
                  com.edustructures.sifworks.reporting.ReportFormatList

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<ReportFormat>, java.util.Collection<ReportFormat>

public class ReportFormatList
extends SIFKeyedList<ReportFormat>

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

ReportFormatList()
Constructor

ReportFormatList(ReportFormat reportFormat)
Constructor that accepts values for all mandatory fields

Method Summary

void	addReportFormat(ReportFormatType type, java.lang.String value) Adds a new <ReportFormat> repeatable element.
ReportFormat	getReportFormat(ReportFormatType type) Gets a ReportFormat object instance.
ReportFormat[]	getReportFormats() Gets all ReportFormat object instances.
void	removeReportFormat(ReportFormatType type) Removes a ReportFormat object instance.
void	setReportFormats(ReportFormat[] reportformats) Sets an array of ReportFormat objects.

Methods inherited from class com.edustructures.sifworks.SIFKeyedList

getChild, getChild

Methods inherited from class com.edustructures.sifworks.SIFList

add, addAll, clear, contains, containsAll, get, iterator, remove, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getKey, 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

Methods inherited from interface java.util.Collection

equals, hashCode, isEmpty

Constructor Detail

ReportFormatList

public ReportFormatList()

Constructor

ReportFormatList

public ReportFormatList(ReportFormat reportFormat)

Constructor that accepts values for all mandatory fields

Parameters:

reportFormat - A third-party format that describes the visual representation of the report data.

Method Detail

addReportFormat

public void addReportFormat(ReportFormatType type,
                            java.lang.String value)

Adds a new <ReportFormat> repeatable element. This form of setReportFormat is provided as a convenience method that is functionally equivalent to the version of setReportFormat that accepts a single ReportFormat object.

Parameters:

type - This attribute indicates the encoding of the format reference.

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

Since:

1.5r1

removeReportFormat

public void removeReportFormat(ReportFormatType type)

Removes a ReportFormat object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

type - Identifies the ReportFormat object to remove by its Type value

Since:

1.5r1

getReportFormat

public ReportFormat getReportFormat(ReportFormatType type)

Gets a ReportFormat object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

type - Identifies the ReportFormat object to return by its "Type" attribute value

Returns:

A ReportFormat object

Since:

1.5r1

getReportFormats

public ReportFormat[] getReportFormats()

Gets all ReportFormat object instances. More than one instance can be defined for this object because it is a repeatable field element.

Returns:

An array of ReportFormat objects

Since:

1.5r1

setReportFormats

public void setReportFormats(ReportFormat[] reportformats)

Sets an array of ReportFormat objects. All existing ReportFormat instances are removed and replaced with this list. Calling this method with the parameter value set to null removes all ReportFormats.

Since:

1.5r1