com.edustructures.sifworks.infra
Class SIF_ChangePublishers

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<SIF_Publisher>
                  com.edustructures.sifworks.infra.SIF_ChangePublishers

All Implemented Interfaces:

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

public class SIF_ChangePublishers
extends SIFKeyedList<SIF_Publisher>

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

SIF_ChangePublishers(SIF_Publisher sifPublisher)
Constructor that accepts values for all mandatory fields

Method Summary

void	addSIF_Publisher(java.lang.String sourceId) Adds a new <SIF_Publisher> repeatable element.
SIF_Publisher	getSIF_Publisher(java.lang.String sourceId) Gets a SIF_Publisher object instance.
SIF_Publisher[]	getSIF_Publishers() Gets all SIF_Publisher object instances.
void	removeSIF_Publisher(java.lang.String sourceId) Removes a SIF_Publisher object instance.
void	setSIF_Publishers(SIF_Publisher[] sif_publishers) Sets an array of SIF_Publisher 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_ChangePublishers

public SIF_ChangePublishers()

Constructor

SIF_ChangePublishers

public SIF_ChangePublishers(SIF_Publisher sifPublisher)

Constructor that accepts values for all mandatory fields

Parameters:

sifPublisher -

Method Detail

addSIF_Publisher

public void addSIF_Publisher(java.lang.String sourceId)

Adds a new <SIF_Publisher> repeatable element. This form of setSIF_Publisher is provided as a convenience method that is functionally equivalent to the version of setSIF_Publisher that accepts a single SIF_Publisher 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_Publisher

public void removeSIF_Publisher(java.lang.String sourceId)

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

Parameters:

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

Since:

2.0

getSIF_Publisher

public SIF_Publisher getSIF_Publisher(java.lang.String sourceId)

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

Parameters:

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

Returns:

A SIF_Publisher object

Since:

2.0

getSIF_Publishers

public SIF_Publisher[] getSIF_Publishers()

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

Returns:

An array of SIF_Publisher objects

Since:

2.0

setSIF_Publishers

public void setSIF_Publishers(SIF_Publisher[] sif_publishers)

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

Since:

2.0