com.edustructures.sifworks.instr
Class Titles

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<Title>
                  com.edustructures.sifworks.instr.Titles

All Implemented Interfaces:

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

public class Titles
extends SIFKeyedList<Title>

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

Titles()
Constructor

Titles(Title title)
Constructor that accepts values for all mandatory fields

Method Summary

void	addTitle(java.lang.String value) Adds a new <Title> 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
Title	getTitle(java.lang.String value) Gets a Title object instance.
Title[]	getTitles() Gets all Title object instances.
void	removeTitle(java.lang.String value) Removes a Title object instance.
void	setTitles(Title[] titles) Sets an array of Title 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

Titles

public Titles()

Constructor

Titles

public Titles(Title title)

Constructor that accepts values for all mandatory fields

Parameters:

title - Name of this type of curriculum object (e.g., "American Revolutionary War")

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

addTitle

public void addTitle(java.lang.String value)

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

Parameters:

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

Since:

1.5r1

removeTitle

public void removeTitle(java.lang.String value)

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

Parameters:

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

Since:

1.5r1

getTitle

public Title getTitle(java.lang.String value)

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

Parameters:

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

Returns:

A Title object

Since:

1.5r1

getTitles

public Title[] getTitles()

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

Returns:

An array of Title objects

Since:

1.5r1

setTitles

public void setTitles(Title[] titles)

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

Since:

1.5r1