com.edustructures.sifworks.infra
Class SIF_Providers

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<SIF_Provider>
                  com.edustructures.sifworks.infra.SIF_Providers

All Implemented Interfaces:

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

public class SIF_Providers
extends SIFKeyedList<SIF_Provider>

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

SIF_Providers(SIF_Provider sifProvider)
Constructor that accepts values for all mandatory fields

Method Summary

void	addSIF_Provider(java.lang.String sourceId, SIF_ObjectList sifObjectList) Adds a new <SIF_Provider> repeatable element.
SIF_Provider	getSIF_Provider(java.lang.String sourceId) Gets a SIF_Provider object instance.
SIF_Provider[]	getSIF_Providers() Gets all SIF_Provider object instances.
void	removeSIF_Provider(java.lang.String sourceId) Removes a SIF_Provider object instance.
void	setSIF_Providers(SIF_Provider[] sif_providers) Sets an array of SIF_Provider 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_Providers

public SIF_Providers()

Constructor

SIF_Providers

public SIF_Providers(SIF_Provider sifProvider)

Constructor that accepts values for all mandatory fields

Parameters:

sifProvider -

Method Detail

addSIF_Provider

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

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

sifObjectList - The name of the object that is being provided by this SIF_SIFNode

Since:

1.1

removeSIF_Provider

public void removeSIF_Provider(java.lang.String sourceId)

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

Parameters:

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

Since:

1.1

getSIF_Provider

public SIF_Provider getSIF_Provider(java.lang.String sourceId)

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

Parameters:

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

Returns:

A SIF_Provider object

Since:

1.1

getSIF_Providers

public SIF_Provider[] getSIF_Providers()

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

Returns:

An array of SIF_Provider objects

Since:

1.1

setSIF_Providers

public void setSIF_Providers(SIF_Provider[] sif_providers)

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

Since:

1.1