com.edustructures.sifworks.infra
Class SIF_SIFNodes

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<SIF_SIFNode>
                  com.edustructures.sifworks.infra.SIF_SIFNodes

All Implemented Interfaces:

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

public class SIF_SIFNodes
extends SIFKeyedList<SIF_SIFNode>

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

SIF_SIFNodes()
Constructor

SIF_SIFNodes(SIF_SIFNode sifsifNode)
Constructor that accepts values for all mandatory fields

Method Summary

void	addSIF_SIFNode(SIF_SIFNodeType type, java.lang.String sifName, java.lang.String sifSourceId, SIFMode sifMode, java.lang.Integer sifMaxBufferSize, YesNo sifSleeping) Adds a new <SIF_SIFNode> repeatable element.
SIF_SIFNode	getSIF_SIFNode(SIF_SIFNodeType type) Gets a SIF_SIFNode object instance.
SIF_SIFNode[]	getSIF_SIFNodes() Gets all SIF_SIFNode object instances.
void	removeSIF_SIFNode(SIF_SIFNodeType type) Removes a SIF_SIFNode object instance.
void	setSIF_SIFNodes(SIF_SIFNode[] sif_sifnodes) Sets an array of SIF_SIFNode 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_SIFNodes

public SIF_SIFNodes()

Constructor

SIF_SIFNodes

public SIF_SIFNodes(SIF_SIFNode sifsifNode)

Constructor that accepts values for all mandatory fields

Parameters:

sifsifNode -

Method Detail

addSIF_SIFNode

public void addSIF_SIFNode(SIF_SIFNodeType type,
                           java.lang.String sifName,
                           java.lang.String sifSourceId,
                           SIFMode sifMode,
                           java.lang.Integer sifMaxBufferSize,
                           YesNo sifSleeping)

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

Parameters:

type - The type of node ("Agent" or "ZIS")

sifName - The descriptive name of the SIF node (i.e. Ramsey Food Services).

sifSourceId - The agent or ZIS identifier. This is the same value that the SIF node would place in any SIF_Header that it would create.

sifMode - Specifies the communication mode (Pull or Push) as chosen by the message sender.

sifMaxBufferSize - Specifies that the ZIS should never send packets larger than this value. Query responses from other providers are controlled by the SIF_MaxBufferSize attribute in the SIF_Request message.

sifSleeping - This element shows whether the SIF node is ready to process messages.

Since:

1.1

removeSIF_SIFNode

public void removeSIF_SIFNode(SIF_SIFNodeType type)

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

Parameters:

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

Since:

1.1

getSIF_SIFNode

public SIF_SIFNode getSIF_SIFNode(SIF_SIFNodeType type)

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

Parameters:

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

Returns:

A SIF_SIFNode object

Since:

1.1

getSIF_SIFNodes

public SIF_SIFNode[] getSIF_SIFNodes()

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

Returns:

An array of SIF_SIFNode objects

Since:

1.1

setSIF_SIFNodes

public void setSIF_SIFNodes(SIF_SIFNode[] sif_sifnodes)

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

Since:

1.1