com.edustructures.sifworks.infra
Class SIF_Subscribers

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<SIF_Subscriber>
                  com.edustructures.sifworks.infra.SIF_Subscribers

All Implemented Interfaces:

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

public class SIF_Subscribers
extends SIFKeyedList<SIF_Subscriber>

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_Subscribers()
Constructor

SIF_Subscribers(SIF_Subscriber sifSubscriber)
Constructor that accepts values for all mandatory fields

Method Summary

void	addSIF_Subscriber(java.lang.String sourceId, SIF_ObjectList sifObjectList) Adds a new <SIF_Subscriber> repeatable element.
SIF_Subscriber	getSIF_Subscriber(java.lang.String sourceId) Gets a SIF_Subscriber object instance.
SIF_Subscriber[]	getSIF_Subscribers() Gets all SIF_Subscriber object instances.
void	removeSIF_Subscriber(java.lang.String sourceId) Removes a SIF_Subscriber object instance.
void	setSIF_Subscribers(SIF_Subscriber[] sif_subscribers) Sets an array of SIF_Subscriber 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_Subscribers

public SIF_Subscribers()

Constructor

SIF_Subscribers

public SIF_Subscribers(SIF_Subscriber sifSubscriber)

Constructor that accepts values for all mandatory fields

Parameters:

sifSubscriber -

Method Detail

addSIF_Subscriber

public void addSIF_Subscriber(java.lang.String sourceId,
                              SIF_ObjectList sifObjectList)

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

Parameters:

sourceId - The identifier of the SIF node that is subscribing to the object events. This is the agent or ZIS identifier that would appear in the SIF_SourceId field of any SIF_Header created by the SIF node.

sifObjectList - The name of the object being subscribed to by this SIF_SIFNode

Since:

1.1

removeSIF_Subscriber

public void removeSIF_Subscriber(java.lang.String sourceId)

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

Parameters:

sourceId - Identifies the SIF_Subscriber object to remove by its SourceId value

Since:

1.1

getSIF_Subscriber

public SIF_Subscriber getSIF_Subscriber(java.lang.String sourceId)

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

Parameters:

sourceId - Identifies the SIF_Subscriber object to return by its "SourceId" attribute value

Returns:

A SIF_Subscriber object

Since:

1.1

getSIF_Subscribers

public SIF_Subscriber[] getSIF_Subscribers()

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

Returns:

An array of SIF_Subscriber objects

Since:

1.1

setSIF_Subscribers

public void setSIF_Subscribers(SIF_Subscriber[] sif_subscribers)

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

Since:

1.1