com.edustructures.sifworks.infra
Class SIF_Responders

java.lang.Object
  extended by com.edustructures.sifworks.Element
      extended by com.edustructures.sifworks.SIFElement
          extended by com.edustructures.sifworks.SIFList<T>
              extended by com.edustructures.sifworks.SIFKeyedList<SIF_Responder>
                  extended by com.edustructures.sifworks.infra.SIF_Responders
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<SIF_Responder>, java.util.Collection<SIF_Responder>

public class SIF_Responders
extends SIFKeyedList<SIF_Responder>

Since:
2.0
Version:
2.0
See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.edustructures.sifworks.Element
CURRENT_SERIALIZE_VERSION
 
Constructor Summary
SIF_Responders()
          Constructor
SIF_Responders(SIF_Responder sifResponder)
          Constructor that accepts values for all mandatory fields
 
Method Summary
 void addSIF_Responder(java.lang.String sourceId)
          Adds a new <SIF_Responder> repeatable element.
 SIF_Responder getSIF_Responder(java.lang.String sourceId)
          Gets a SIF_Responder object instance.
 SIF_Responder[] getSIF_Responders()
          Gets all SIF_Responder object instances.
 void removeSIF_Responder(java.lang.String sourceId)
          Removes a SIF_Responder object instance.
 void setSIF_Responders(SIF_Responder[] sif_responders)
          Sets an array of SIF_Responder 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

SIF_Responders

public SIF_Responders()
Constructor


SIF_Responders

public SIF_Responders(SIF_Responder sifResponder)
Constructor that accepts values for all mandatory fields

Parameters:
sifResponder -
Method Detail

addSIF_Responder

public void addSIF_Responder(java.lang.String sourceId)
Adds a new <SIF_Responder> repeatable element. This form of setSIF_Responder is provided as a convenience method that is functionally equivalent to the version of setSIF_Responder that accepts a single SIF_Responder object.

Parameters:
sourceId - The identifier of the SIF node that is providing objects. This is the agent or ZIS identifier that would appear in the SIF_SourceId field of any SIF_Header created by the SIF node.
Since:
2.0

removeSIF_Responder

public void removeSIF_Responder(java.lang.String sourceId)
Removes a SIF_Responder object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:
sourceId - Identifies the SIF_Responder object to remove by its SourceId value
Since:
2.0

getSIF_Responder

public SIF_Responder getSIF_Responder(java.lang.String sourceId)
Gets a SIF_Responder object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:
sourceId - Identifies the SIF_Responder object to return by its "SourceId" attribute value
Returns:
A SIF_Responder object
Since:
2.0

getSIF_Responders

public SIF_Responder[] getSIF_Responders()
Gets all SIF_Responder object instances. More than one instance can be defined for this object because it is a repeatable field element.

Returns:
An array of SIF_Responder objects
Since:
2.0

setSIF_Responders

public void setSIF_Responders(SIF_Responder[] sif_responders)
Sets an array of SIF_Responder objects. All existing SIF_Responder instances are removed and replaced with this list. Calling this method with the parameter value set to null removes all SIF_Responders.

Since:
2.0


Copyright © 2001-2007 Edustructures LLC. All Rights Reserved. SIFWorks® and ADK® are registered trademarks of Edustructures LLC. SIF™ and Schools Interoperability Framework are trademarks of the Schools Interoperability Framework Association.