com.edustructures.sifworks.common
Class LanguageList

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<Language>
                  com.edustructures.sifworks.common.LanguageList

All Implemented Interfaces:

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

public class LanguageList
extends SIFKeyedList<Language>

Since:

1.1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

LanguageList()
Constructor

LanguageList(Language language)
Constructor that accepts values for all mandatory fields

Method Summary

void	addLanguage(LanguageCode code) Adds a new <Language> repeatable element.
Language	getLanguage(LanguageCode code) Gets a Language object instance.
Language[]	getLanguages() Gets all Language object instances.
void	removeLanguage(LanguageCode code) Removes a Language object instance.
void	setLanguages(Language[] languages) Sets an array of Language 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

LanguageList

public LanguageList()

Constructor

LanguageList

public LanguageList(Language language)

Constructor that accepts values for all mandatory fields

Parameters:

language -

Method Detail

addLanguage

public void addLanguage(LanguageCode code)

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

Parameters:

code - This is the code that specifies the person's language.

Since:

1.1

removeLanguage

public void removeLanguage(LanguageCode code)

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

Parameters:

code - Identifies the Language object to remove by its Code value

Since:

1.1

getLanguage

public Language getLanguage(LanguageCode code)

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

Parameters:

code - Identifies the Language object to return by its "Code" attribute value

Returns:

A Language object

Since:

1.1

getLanguages

public Language[] getLanguages()

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

Returns:

An array of Language objects

Since:

1.1

setLanguages

public void setLanguages(Language[] languages)

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

Since:

1.1