com.edustructures.sifworks.infra
Class SIF_Subscribe

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFMessagePayload
              com.edustructures.sifworks.infra.SIF_Subscribe

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SIF_Subscribe
extends SIFMessagePayload

Contains one of the SIF message types.

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

Method Summary

void	addSIF_Object(SIF_Object value) Adds a new <SIF_Object> child element.
SIF_Header	getSIF_Header() Gets the value of the <SIF_Header> element.
SIF_Object	getSIF_Object(java.lang.String objectName) Gets a SIF_Object object instance.
SIF_Object[]	getSIF_Objects() Gets all SIF_Object object instances.
void	removeSIF_Header() Removes the SIF_Header child element previously created by calling setSIF_Header
void	removeSIF_Object(java.lang.String objectName) Removes a SIF_Object object instance.
void	setSIF_Header(SIF_Header value) Sets the value of the <SIF_Header> element.
void	setSIF_Objects(SIF_Object[] sif_objects) Sets an array of SIF_Object objects.

Methods inherited from class com.edustructures.sifworks.SIFMessagePayload

ackError, ackError, ackError, ackError, ackFinal, ackImmediate, ackIntermediate, ackStatus, getDestinationId, getHeader, getMsgId, getSIFContexts, getSIFVersion, getSourceId, getTimestamp, getVersionAttribute, getXmlns, LogRecv, LogSend, setSIFVersion, setVersionAttribute, setXmlns

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, getKey, getSIFValue, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, 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_Subscribe

public SIF_Subscribe()

Constructor

Method Detail

setSIF_Header

public void setSIF_Header(SIF_Header value)

Sets the value of the <SIF_Header> element.

The SIF specification defines the meaning of this element as: "Header information associated with this message."

Parameters:

value - A SIF_Header object

Since:

1.1

getSIF_Header

public SIF_Header getSIF_Header()

Gets the value of the <SIF_Header> element.

The SIF specification defines the meaning of this element as: "Header information associated with this message."

Returns:

A SIF_Header object

Since:

1.1

removeSIF_Header

public void removeSIF_Header()

Removes the SIF_Header child element previously created by calling setSIF_Header

Since:

1.1

addSIF_Object

public void addSIF_Object(SIF_Object value)

Adds a new <SIF_Object> child element.

Parameters:

value - A SIF_Object object

Since:

1.1

removeSIF_Object

public void removeSIF_Object(java.lang.String objectName)

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

Parameters:

objectName - Identifies the SIF_Object object to remove by its ObjectName value

Since:

1.1

getSIF_Object

public SIF_Object getSIF_Object(java.lang.String objectName)

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

Parameters:

objectName - Identifies the SIF_Object object to return by its "ObjectName" attribute value

Returns:

A SIF_Object object

Since:

1.1

getSIF_Objects

public SIF_Object[] getSIF_Objects()

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

Returns:

An array of SIF_Object objects

Since:

1.1

setSIF_Objects

public void setSIF_Objects(SIF_Object[] sif_objects)

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

Since:

1.1