com.edustructures.sifworks.infra
Class SIF_Publisher

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.infra.SIF_Publisher

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SIF_Publisher
extends SIFKeyedElement

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

SIF_Publisher(java.lang.String sourceId)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
SIF_ObjectList	getSIF_ObjectList() Gets the value of the <SIF_ObjectList> element.
java.lang.String	getSourceId() Gets the value of the SourceId attribute.
void	removeSIF_ObjectList() Removes the SIF_ObjectList child element previously created by calling setSIF_ObjectList
void	setSIF_ObjectList(SIF_ObjectList value) Sets the value of the <SIF_ObjectList> element.
void	setSourceId(java.lang.String value) Sets the value of the SourceId attribute.

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, 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

Constructor Detail

SIF_Publisher

public SIF_Publisher()

Constructor

SIF_Publisher

public SIF_Publisher(java.lang.String sourceId)

Constructor that accepts values for all mandatory fields

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.

Method Detail

getKey

public java.lang.String getKey()

Gets the key of this object

Overrides:

getKey in class SIFElement

Returns:

The value of the object's Mandatory or Required attribute. If an object has more than one such attribute, the key is a period- delimited concatenation of the attribute values in sequential order

getKeyFields

public ElementDef[] getKeyFields()

Gets the metadata fields that make up the key of this object

Returns:

an array of metadata fields that make up the object's key

getSourceId

public java.lang.String getSourceId()

Gets the value of the SourceId attribute.

The SIF specification defines the meaning of this attribute as: "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."

Returns:

The SourceId attribute of this object.

Since:

2.0

setSourceId

public void setSourceId(java.lang.String value)

Sets the value of the SourceId attribute.

The SIF specification defines the meaning of this attribute as: "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."

Parameters:

value - A String object

Since:

2.0

setSIF_ObjectList

public void setSIF_ObjectList(SIF_ObjectList value)

Sets the value of the <SIF_ObjectList> element.

Parameters:

value - A SIF_ObjectList object

Since:

2.0

getSIF_ObjectList

public SIF_ObjectList getSIF_ObjectList()

Gets the value of the <SIF_ObjectList> element.

Returns:

A SIF_ObjectList object

Since:

2.0

removeSIF_ObjectList

public void removeSIF_ObjectList()

Removes the SIF_ObjectList child element previously created by calling setSIF_ObjectList

Since:

2.0