com.edustructures.sifworks.instr
Class StatementCodes

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<StatementCode>
                  com.edustructures.sifworks.instr.StatementCodes

All Implemented Interfaces:

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

public class StatementCodes
extends SIFKeyedList<StatementCode>

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

StatementCodes()
Constructor

StatementCodes(StatementCode statementCode)
Constructor that accepts values for all mandatory fields

Method Summary

void	addStatementCode(java.lang.String value) Adds a new <StatementCode> repeatable 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
StatementCode	getStatementCode(java.lang.String value) Gets a StatementCode object instance.
StatementCode[]	getStatementCodes() Gets all StatementCode object instances.
void	removeStatementCode(java.lang.String value) Removes a StatementCode object instance.
void	setStatementCodes(StatementCode[] statementcodes) Sets an array of StatementCode 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, 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

StatementCodes

public StatementCodes()

Constructor

StatementCodes

public StatementCodes(StatementCode statementCode)

Constructor that accepts values for all mandatory fields

Parameters:

statementCode - An alphanumeric ID code as defined by the organization to identify the statement.

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

addStatementCode

public void addStatementCode(java.lang.String value)

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

Parameters:

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

Since:

1.5r1

removeStatementCode

public void removeStatementCode(java.lang.String value)

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

Parameters:

value - Identifies the StatementCode object to remove by its Value value

Since:

1.5r1

getStatementCode

public StatementCode getStatementCode(java.lang.String value)

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

Parameters:

value - Identifies the StatementCode object to return by its "Value" attribute value

Returns:

A StatementCode object

Since:

1.5r1

getStatementCodes

public StatementCode[] getStatementCodes()

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

Returns:

An array of StatementCode objects

Since:

1.5r1

setStatementCodes

public void setStatementCodes(StatementCode[] statementcodes)

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

Since:

1.5r1