com.edustructures.sifworks.infra
Class SIF_Response

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SIF_Response
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_Response()
Constructor

Method Summary

SIF_Error	getSIF_Error() Gets the value of the <SIF_Error> element.
SIF_ExtendedQueryResults	getSIF_ExtendedQueryResults() Gets the value of the <SIF_ExtendedQueryResults> element.
SIF_Header	getSIF_Header() Gets the value of the <SIF_Header> element.
java.lang.String	getSIF_MorePackets() Gets the value of the <SIF_MorePackets> element.
SIF_ObjectData	getSIF_ObjectData() Gets the value of the <SIF_ObjectData> element.
java.lang.Integer	getSIF_PacketNumber() Gets the value of the <SIF_PacketNumber> element.
java.lang.String	getSIF_RequestMsgId() Gets the value of the <SIF_RequestMsgId> element.
void	removeSIF_Error() Removes the SIF_Error child element previously created by calling setSIF_Error
void	removeSIF_ExtendedQueryResults() Removes the SIF_ExtendedQueryResults child element previously created by calling setSIF_ExtendedQueryResults
void	removeSIF_Header() Removes the SIF_Header child element previously created by calling setSIF_Header
void	removeSIF_ObjectData() Removes the SIF_ObjectData child element previously created by calling setSIF_ObjectData
void	setSIF_Error(SIF_Error value) Sets the value of the <SIF_Error> element.
void	setSIF_ExtendedQueryResults(SIF_ExtendedQueryResults value) Sets the value of the <SIF_ExtendedQueryResults> element.
void	setSIF_Header(SIF_Header value) Sets the value of the <SIF_Header> element.
void	setSIF_MorePackets(java.lang.String value) Sets the value of the <SIF_MorePackets> element as a String.
void	setSIF_MorePackets(YesNo value) Sets the value of the <SIF_MorePackets> element.
void	setSIF_ObjectData(SIF_ObjectData value) Sets the value of the <SIF_ObjectData> element.
void	setSIF_PacketNumber(java.lang.Integer value) Sets the value of the <SIF_PacketNumber> element.
void	setSIF_RequestMsgId(java.lang.String value) Sets the value of the <SIF_RequestMsgId> element.

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_Response

public SIF_Response()

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. The SIF_DestinationId needs to be the SIF_SourceId of the original SIF_Request message being processed."

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. The SIF_DestinationId needs to be the SIF_SourceId of the original SIF_Request message being processed."

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_RequestMsgId

public java.lang.String getSIF_RequestMsgId()

Gets the value of the <SIF_RequestMsgId> element.

The SIF specification defines the meaning of this element as: "This is the message ID of the SIF_Request message being processed. It provides a unique match between a SIF_Response and a previous SIF_Request. Since the ID of each message from an agent is unique, the receiver of a SIF_Response message will be able to relate the SIF_Response to a SIF_Request that it sent out previously."

Returns:

The SIF_RequestMsgId element of this object.

Since:

1.1

setSIF_RequestMsgId

public void setSIF_RequestMsgId(java.lang.String value)

Sets the value of the <SIF_RequestMsgId> element.

The SIF specification defines the meaning of this element as: "This is the message ID of the SIF_Request message being processed. It provides a unique match between a SIF_Response and a previous SIF_Request. Since the ID of each message from an agent is unique, the receiver of a SIF_Response message will be able to relate the SIF_Response to a SIF_Request that it sent out previously."

Parameters:

value - A String object

Since:

1.1

setSIF_Error

public void setSIF_Error(SIF_Error value)

Sets the value of the <SIF_Error> element.

Parameters:

value - A SIF_Error object

Since:

1.1

getSIF_Error

public SIF_Error getSIF_Error()

Gets the value of the <SIF_Error> element.

Returns:

A SIF_Error object

Since:

1.1

removeSIF_Error

public void removeSIF_Error()

Removes the SIF_Error child element previously created by calling setSIF_Error

Since:

1.1

getSIF_PacketNumber

public java.lang.Integer getSIF_PacketNumber()

Gets the value of the <SIF_PacketNumber> element.

The SIF specification defines the meaning of this element as: "This element represents the index of the SIF_Response message in the sequence of packets that make up a complete response. Its value must be in the range of 1 through n, with n equal to the total number of packets that make up a response."

Returns:

The SIF_PacketNumber element of this object.

Since:

1.1

setSIF_PacketNumber

public void setSIF_PacketNumber(java.lang.Integer value)

Sets the value of the <SIF_PacketNumber> element.

The SIF specification defines the meaning of this element as: "This element represents the index of the SIF_Response message in the sequence of packets that make up a complete response. Its value must be in the range of 1 through n, with n equal to the total number of packets that make up a response."

Parameters:

value - A Integer object

Since:

1.1

getSIF_MorePackets

public java.lang.String getSIF_MorePackets()

Gets the value of the <SIF_MorePackets> element.

The SIF specification defines the meaning of this element as: "This element provides an indication as to whether there are more packets besides this one to make up a complete response."

Returns:

The SIF_MorePackets element of this object.

Since:

1.1

setSIF_MorePackets

public void setSIF_MorePackets(YesNo value)

Sets the value of the <SIF_MorePackets> element.

The SIF specification defines the meaning of this element as: "This element provides an indication as to whether there are more packets besides this one to make up a complete response."

Parameters:

value - A constant defined by the YesNo class

Since:

1.1

setSIF_MorePackets

public void setSIF_MorePackets(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "This element provides an indication as to whether there are more packets besides this one to make up a complete response."

Parameters:

value - The value as a String

Since:

1.1

setSIF_ObjectData

public void setSIF_ObjectData(SIF_ObjectData value)

Sets the value of the <SIF_ObjectData> element.

The SIF specification defines the meaning of this element as: " The SIF_ObjectData element contains the data objects matching the supplied criteria in the SIF_Request message if the SIF_Request contained SIF_Query. If the SIF_Request contained SIF_ExtendedQuery, include SIF_ExtendedQueryResults. If the SIF_Error element is present, this element MUST be empty. "

Parameters:

value - A SIF_ObjectData object

Since:

1.1

getSIF_ObjectData

public SIF_ObjectData getSIF_ObjectData()

Gets the value of the <SIF_ObjectData> element.

The SIF specification defines the meaning of this element as: " The SIF_ObjectData element contains the data objects matching the supplied criteria in the SIF_Request message if the SIF_Request contained SIF_Query. If the SIF_Request contained SIF_ExtendedQuery, include SIF_ExtendedQueryResults. If the SIF_Error element is present, this element MUST be empty. "

Returns:

A SIF_ObjectData object

Since:

1.1

removeSIF_ObjectData

public void removeSIF_ObjectData()

Removes the SIF_ObjectData child element previously created by calling setSIF_ObjectData

Since:

1.1

setSIF_ExtendedQueryResults

public void setSIF_ExtendedQueryResults(SIF_ExtendedQueryResults value)

Sets the value of the <SIF_ExtendedQueryResults> element.

The SIF specification defines the meaning of this element as: " This element contains the elements requested by SIF_ExtendedQuery in SIF_Request. If the SIF_Error element is present, this element MUST be empty. "

Parameters:

value - A SIF_ExtendedQueryResults object

Since:

2.0

getSIF_ExtendedQueryResults

public SIF_ExtendedQueryResults getSIF_ExtendedQueryResults()

Gets the value of the <SIF_ExtendedQueryResults> element.

The SIF specification defines the meaning of this element as: " This element contains the elements requested by SIF_ExtendedQuery in SIF_Request. If the SIF_Error element is present, this element MUST be empty. "

Returns:

A SIF_ExtendedQueryResults object

Since:

2.0

removeSIF_ExtendedQueryResults

public void removeSIF_ExtendedQueryResults()

Removes the SIF_ExtendedQueryResults child element previously created by calling setSIF_ExtendedQueryResults

Since:

2.0