com.edustructures.sifworks.common
Class Language

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.common.Language

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Language
extends SIFKeyedElement

The student's 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

Language()
Constructor

Language(LanguageCode code)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getCode() Gets the value of the Code attribute.
java.lang.String	getDialect() Gets the value of the <Dialect> 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
java.lang.String	getLanguageType() Gets the value of the <LanguageType> element.
OtherCodeList	getOtherCodeList() Gets the value of the <OtherCodeList> element.
void	removeOtherCodeList() Removes the OtherCodeList child element previously created by calling setOtherCodeList
void	setCode(LanguageCode value) Sets the value of the Code attribute.
void	setCode(java.lang.String value) Sets the value of the Code attribute as a String.
void	setDialect(java.lang.String value) Sets the value of the <Dialect> element.
void	setLanguageType(LanguageType value) Sets the value of the <LanguageType> element.
void	setLanguageType(java.lang.String value) Sets the value of the <LanguageType> element as a String.
void	setOtherCodeList(OtherCodeList value) Sets the value of the <OtherCodeList> element.
java.lang.String	toString() Returns the value of the Code attribute

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, 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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Language

public Language()

Constructor

Language

public Language(LanguageCode code)

Constructor that accepts values for all mandatory fields

Parameters:

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

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

getCode

public java.lang.String getCode()

Gets the value of the Code attribute.

The SIF specification defines the meaning of this attribute as: "This is the code that specifies the person's language."

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.1	"Type"
SIF2.0	"Code"

Returns:

The Code attribute of this object.

Since:

1.1

setCode

public void setCode(LanguageCode value)

Sets the value of the Code attribute.

The SIF specification defines the meaning of this attribute as: "This is the code that specifies the person's language."

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.1	"Type"
SIF2.0	"Code"

Parameters:

value - A constant defined by the LanguageCode class

Since:

1.1

setCode

public void setCode(java.lang.String value)

Sets the value of the Code attribute as a String.

The SIF specification defines the meaning of this attribute as: "This is the code that specifies the person's language."

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.1	"Type"
SIF2.0	"Code"

Parameters:

value - The value as a String

Since:

1.1

setOtherCodeList

public void setOtherCodeList(OtherCodeList value)

Sets the value of the <OtherCodeList> element.

Parameters:

value - A OtherCodeList object

Since:

2.0

getOtherCodeList

public OtherCodeList getOtherCodeList()

Gets the value of the <OtherCodeList> element.

Returns:

An OtherCodeList object

Since:

2.0

removeOtherCodeList

public void removeOtherCodeList()

Removes the OtherCodeList child element previously created by calling setOtherCodeList

Since:

2.0

getLanguageType

public java.lang.String getLanguageType()

Gets the value of the <LanguageType> element.

The SIF specification defines the meaning of this element as: "An indication of the function and context in which an individual uses a language to communicate."

Returns:

The LanguageType element of this object.

Since:

2.0

setLanguageType

public void setLanguageType(LanguageType value)

Sets the value of the <LanguageType> element.

The SIF specification defines the meaning of this element as: "An indication of the function and context in which an individual uses a language to communicate."

Parameters:

value - A constant defined by the LanguageType class

Since:

2.0

setLanguageType

public void setLanguageType(java.lang.String value)

Sets the value of the <LanguageType> element as a String.

The SIF specification defines the meaning of this element as: "An indication of the function and context in which an individual uses a language to communicate."

Parameters:

value - The value as a String

Since:

2.0

getDialect

public java.lang.String getDialect()

Gets the value of the <Dialect> element.

The SIF specification defines the meaning of this element as: " All Language Types from the SIF Specification are not represented here. Please use the wrap method to wrap any string in a LanguageType object. "

Returns:

The Dialect element of this object.

Since:

2.0

setDialect

public void setDialect(java.lang.String value)

Sets the value of the <Dialect> element.

The SIF specification defines the meaning of this element as: " All Language Types from the SIF Specification are not represented here. Please use the wrap method to wrap any string in a LanguageType object. "

Parameters:

value - A String object

Since:

2.0

toString

public java.lang.String toString()

Returns the value of the Code attribute

Overrides:

toString in class Element

Returns:

The text value of this element if applicable