com.edustructures.sifworks.infra
Class SIF_Register

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SIF_Register
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_Register()
Constructor

Method Summary

void	addSIF_Version(SIF_Version value) Adds a new <SIF_Version> child element.
SIF_Application	getSIF_Application() Gets the value of the <SIF_Application> element.
SIF_Header	getSIF_Header() Gets the value of the <SIF_Header> element.
java.lang.String	getSIF_Icon() Gets the value of the <SIF_Icon> element.
java.lang.Integer	getSIF_MaxBufferSize() Gets the value of the <SIF_MaxBufferSize> element.
java.lang.String	getSIF_Mode() Gets the value of the <SIF_Mode> element.
java.lang.String	getSIF_Name() Gets the value of the <SIF_Name> element.
java.lang.String	getSIF_NodeVendor() Gets the value of the <SIF_NodeVendor> element.
java.lang.String	getSIF_NodeVersion() Gets the value of the <SIF_NodeVersion> element.
SIF_Protocol	getSIF_Protocol() Gets the value of the <SIF_Protocol> element.
SIF_Version	getSIF_Version(java.lang.String value) Gets a SIF_Version object instance.
SIF_Version[]	getSIF_Versions() Gets all SIF_Version object instances.
void	removeSIF_Application() Removes the SIF_Application child element previously created by calling setSIF_Application
void	removeSIF_Header() Removes the SIF_Header child element previously created by calling setSIF_Header
void	removeSIF_Protocol() Removes the SIF_Protocol child element previously created by calling setSIF_Protocol
void	removeSIF_Version(java.lang.String value) Removes a SIF_Version object instance.
void	setSIF_Application(SIF_Application value) Sets the value of the <SIF_Application> element.
void	setSIF_Header(SIF_Header value) Sets the value of the <SIF_Header> element.
void	setSIF_Icon(java.lang.String value) Sets the value of the <SIF_Icon> element.
void	setSIF_MaxBufferSize(java.lang.Integer value) Sets the value of the <SIF_MaxBufferSize> element.
void	setSIF_Mode(SIFMode value) Sets the value of the <SIF_Mode> element.
void	setSIF_Mode(java.lang.String value) Sets the value of the <SIF_Mode> element as a String.
void	setSIF_Name(java.lang.String value) Sets the value of the <SIF_Name> element.
void	setSIF_NodeVendor(java.lang.String value) Sets the value of the <SIF_NodeVendor> element.
void	setSIF_NodeVersion(java.lang.String value) Sets the value of the <SIF_NodeVersion> element.
void	setSIF_Protocol(SIF_Protocol value) Sets the value of the <SIF_Protocol> element.
void	setSIF_Versions(SIF_Version[] sif_versions) Sets an array of SIF_Version 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_Register

public SIF_Register()

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

getSIF_Name

public java.lang.String getSIF_Name()

Gets the value of the <SIF_Name> element.

The SIF specification defines the meaning of this element as: "This is the descriptive name of the agent that is registering (i.e. Ramsey Media Center)."

Returns:

The SIF_Name element of this object.

Since:

1.1

setSIF_Name

public void setSIF_Name(java.lang.String value)

Sets the value of the <SIF_Name> element.

The SIF specification defines the meaning of this element as: "This is the descriptive name of the agent that is registering (i.e. Ramsey Media Center)."

Parameters:

value - A String object

Since:

1.1

addSIF_Version

public void addSIF_Version(SIF_Version value)

Adds a new <SIF_Version> child element.

The SIF specification defines the meaning of this element as: "Specifies which SIF Specification version(s) the agent supports. If the ZIS cannot communicate in this format, it should reject the request."

Parameters:

value - A SIF_Version object

Since:

1.1

removeSIF_Version

public void removeSIF_Version(java.lang.String value)

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

Parameters:

value - Identifies the SIF_Version object to remove by its Value value

Since:

1.1

getSIF_Version

public SIF_Version getSIF_Version(java.lang.String value)

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

Parameters:

value - Identifies the SIF_Version object to return by its "Value" attribute value

Returns:

A SIF_Version object

Since:

1.1

getSIF_Versions

public SIF_Version[] getSIF_Versions()

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

Returns:

An array of SIF_Version objects

Since:

1.1

setSIF_Versions

public void setSIF_Versions(SIF_Version[] sif_versions)

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

Since:

1.1

getSIF_MaxBufferSize

public java.lang.Integer getSIF_MaxBufferSize()

Gets the value of the <SIF_MaxBufferSize> element.

The SIF specification defines the meaning of this element as: "Specifies the maximum size of a packet to be returned by the ZIS. The ZIS may return packets smaller than, or equal to, the maximum value."

Returns:

The SIF_MaxBufferSize element of this object.

Since:

1.1

setSIF_MaxBufferSize

public void setSIF_MaxBufferSize(java.lang.Integer value)

Sets the value of the <SIF_MaxBufferSize> element.

The SIF specification defines the meaning of this element as: "Specifies the maximum size of a packet to be returned by the ZIS. The ZIS may return packets smaller than, or equal to, the maximum value."

Parameters:

value - A Integer object

Since:

1.1

getSIF_Mode

public java.lang.String getSIF_Mode()

Gets the value of the <SIF_Mode> element.

The SIF specification defines the meaning of this element as: "Specifies the communication mode (Pull or Push) as chosen by the message sender."

Returns:

The SIF_Mode element of this object.

Since:

1.1

setSIF_Mode

public void setSIF_Mode(SIFMode value)

Sets the value of the <SIF_Mode> element.

The SIF specification defines the meaning of this element as: "Specifies the communication mode (Pull or Push) as chosen by the message sender."

Parameters:

value - A constant defined by the SIFMode class

Since:

1.1

setSIF_Mode

public void setSIF_Mode(java.lang.String value)

Sets the value of the <SIF_Mode> element as a String.

The SIF specification defines the meaning of this element as: "Specifies the communication mode (Pull or Push) as chosen by the message sender."

Parameters:

value - The value as a String

Since:

1.1

setSIF_Protocol

public void setSIF_Protocol(SIF_Protocol value)

Sets the value of the <SIF_Protocol> element.

Parameters:

value - A SIF_Protocol object

Since:

1.1

getSIF_Protocol

public SIF_Protocol getSIF_Protocol()

Gets the value of the <SIF_Protocol> element.

Returns:

A SIF_Protocol object

Since:

1.1

removeSIF_Protocol

public void removeSIF_Protocol()

Removes the SIF_Protocol child element previously created by calling setSIF_Protocol

Since:

1.1

getSIF_NodeVendor

public java.lang.String getSIF_NodeVendor()

Gets the value of the <SIF_NodeVendor> element.

The SIF specification defines the meaning of this element as: "The vendor of the SIF agent."

Returns:

The SIF_NodeVendor element of this object.

Since:

2.0

setSIF_NodeVendor

public void setSIF_NodeVendor(java.lang.String value)

Sets the value of the <SIF_NodeVendor> element.

The SIF specification defines the meaning of this element as: "The vendor of the SIF agent."

Parameters:

value - A String object

Since:

2.0

getSIF_NodeVersion

public java.lang.String getSIF_NodeVersion()

Gets the value of the <SIF_NodeVersion> element.

The SIF specification defines the meaning of this element as: " The agent version number. The format of this field is undefined, but it should match the format used in the agent's conformance statement, if the agent is SIF Certified. "

Returns:

The SIF_NodeVersion element of this object.

Since:

2.0

setSIF_NodeVersion

public void setSIF_NodeVersion(java.lang.String value)

Sets the value of the <SIF_NodeVersion> element.

The SIF specification defines the meaning of this element as: " The agent version number. The format of this field is undefined, but it should match the format used in the agent's conformance statement, if the agent is SIF Certified. "

Parameters:

value - A String object

Since:

2.0

setSIF_Application

public void setSIF_Application(SIF_Application value)

Sets the value of the <SIF_Application> element.

Parameters:

value - A SIF_Application object

Since:

2.0

getSIF_Application

public SIF_Application getSIF_Application()

Gets the value of the <SIF_Application> element.

Returns:

A SIF_Application object

Since:

2.0

removeSIF_Application

public void removeSIF_Application()

Removes the SIF_Application child element previously created by calling setSIF_Application

Since:

2.0

getSIF_Icon

public java.lang.String getSIF_Icon()

Gets the value of the <SIF_Icon> element.

The SIF specification defines the meaning of this element as: " HTTP URL referencing an icon for graphical representation of the application/agent. Should range from 16x16 pixels to 128x128 pixels and be of an image MIME type commonly supported by Web browsers (e.g. PNG, JPEG, GIF). Agents may optionally follow the more restrictive guidelines at [FAVICON]. "

Returns:

The SIF_Icon element of this object.

Since:

2.0

setSIF_Icon

public void setSIF_Icon(java.lang.String value)

Sets the value of the <SIF_Icon> element.

The SIF specification defines the meaning of this element as: " HTTP URL referencing an icon for graphical representation of the application/agent. Should range from 16x16 pixels to 128x128 pixels and be of an image MIME type commonly supported by Web browsers (e.g. PNG, JPEG, GIF). Agents may optionally follow the more restrictive guidelines at [FAVICON]. "

Parameters:

value - A String object

Since:

2.0