com.edustructures.sifworks.common
Class ElectronicIdList

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<ElectronicId>
                  com.edustructures.sifworks.common.ElectronicIdList

All Implemented Interfaces:

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

public class ElectronicIdList
extends SIFKeyedList<ElectronicId>

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

ElectronicIdList()
Constructor

ElectronicIdList(ElectronicId electronicId)
Constructor that accepts values for all mandatory fields

Method Summary

void	addElectronicId(ElectronicIdType type, java.lang.String value) Adds a new <ElectronicId> repeatable element.
ElectronicId	getElectronicId(ElectronicIdType type) Gets an ElectronicId object instance.
ElectronicId[]	getElectronicIds() Gets all ElectronicId object instances.
void	removeElectronicId(ElectronicIdType type) Removes an ElectronicId object instance.
void	setElectronicIds(ElectronicId[] electronicids) Sets an array of ElectronicId 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

ElectronicIdList

public ElectronicIdList()

Constructor

ElectronicIdList

public ElectronicIdList(ElectronicId electronicId)

Constructor that accepts values for all mandatory fields

Parameters:

electronicId - Barcode, Magstripe or PIN associated with this item. Refer to 5.1.7 ElectronicId.

Method Detail

addElectronicId

public void addElectronicId(ElectronicIdType type,
                            java.lang.String value)

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

Parameters:

type - Electronic ID type.

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

Since:

1.1

removeElectronicId

public void removeElectronicId(ElectronicIdType type)

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

Parameters:

type - Identifies the ElectronicId object to remove by its Type value

Since:

1.1

getElectronicId

public ElectronicId getElectronicId(ElectronicIdType type)

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

Parameters:

type - Identifies the ElectronicId object to return by its "Type" attribute value

Returns:

An ElectronicId object

Since:

1.1

getElectronicIds

public ElectronicId[] getElectronicIds()

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

Returns:

An array of ElectronicId objects

Since:

1.1

setElectronicIds

public void setElectronicIds(ElectronicId[] electronicids)

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

Since:

1.1