com.edustructures.sifworks.common
Class IdentificationInfo

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class IdentificationInfo
extends SIFKeyedElement

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

IdentificationInfo()
Constructor

IdentificationInfo(IdentificationSystem code, java.lang.String value)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getCode() Gets the value of the Code attribute.
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	getValue() Gets the value of the <Value> element.
void	setCode(IdentificationSystem 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	setValue(java.lang.String value) Sets the value of the <Value> element.

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, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentificationInfo

public IdentificationInfo()

Constructor

IdentificationInfo

public IdentificationInfo(IdentificationSystem code,
                          java.lang.String value)

Constructor that accepts values for all mandatory fields

Parameters:

code - Code indicating which identification system is used.

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

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

getValue

public java.lang.String getValue()

Gets the value of the <Value> element.

The SIF specification defines the meaning of this element as: "Gets or sets the content value of the <IdentificationInfo> element"

Returns:

The Value element of this object.

Since:

1.1

setValue

public void setValue(java.lang.String value)

Sets the value of the <Value> element.

The SIF specification defines the meaning of this element as: "Gets or sets the content value of the <IdentificationInfo> element"

Parameters:

value - A String object

Since:

1.1

getCode

public java.lang.String getCode()

Gets the value of the Code attribute.

The SIF specification defines the meaning of this attribute as: "Code indicating which identification system is used."

Returns:

The Code attribute of this object.

Since:

1.1

setCode

public void setCode(IdentificationSystem value)

Sets the value of the Code attribute.

The SIF specification defines the meaning of this attribute as: "Code indicating which identification system is used."

Parameters:

value - A constant defined by the IdentificationSystem 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: "Code indicating which identification system is used."

Parameters:

value - The value as a String

Since:

1.1