com.edustructures.sifworks.infra
Class SIF_Ack

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SIF_Ack
extends SIFMessagePayload

Contains one of the SIF message types.

Since:

1.1

Version:

2.0

See Also:

Serialized Form

Field Summary

SIFMessagePayload

message

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

SIF_Ack()
Constructor

Method Summary

SIF_Error	getSIF_Error() Gets the value of the <SIF_Error> element.
SIF_Header	getSIF_Header() Gets the value of the <SIF_Header> element.
java.lang.String	getSIF_OriginalMsgId() Gets the value of the <SIF_OriginalMsgId> element.
java.lang.String	getSIF_OriginalSourceId() Gets the value of the <SIF_OriginalSourceId> element.
SIF_Status	getSIF_Status() Gets the value of the <SIF_Status> element.
boolean	hasError() Determines if this SIF_Ack communicates an error
boolean	hasError(int category, int code) Determines if this SIF_Ack contains the specified error code
boolean	hasStatusCode(int code) Determines if this SIF_Ack has a specific status code.
void	LogRecv(org.apache.log4j.Category log) Utility method called by the class framework to log this SIF_Message upon receipt from a zone.
void	LogSend(org.apache.log4j.Category log) Utility method called by the class framework to log this SIF_Message prior to sending it to a zone.
void	removeSIF_Error() Removes the SIF_Error child element previously created by calling setSIF_Error
void	removeSIF_Header() Removes the SIF_Header child element previously created by calling setSIF_Header
void	removeSIF_Status() Removes the SIF_Status child element previously created by calling setSIF_Status
void	setSIF_Error(SIF_Error value) Sets the value of the <SIF_Error> element.
void	setSIF_Header(SIF_Header value) Sets the value of the <SIF_Header> element.
void	setSIF_OriginalMsgId(java.lang.String value) Sets the value of the <SIF_OriginalMsgId> element.
void	setSIF_OriginalSourceId(java.lang.String value) Sets the value of the <SIF_OriginalSourceId> element.
void	setSIF_Status(SIF_Status value) Sets the value of the <SIF_Status> 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, 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

Field Detail

message

public SIFMessagePayload message

Constructor Detail

SIF_Ack

public SIF_Ack()

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_OriginalSourceId

public java.lang.String getSIF_OriginalSourceId()

Gets the value of the <SIF_OriginalSourceId> element.

The SIF specification defines the meaning of this element as: "The SIF_SourceId of the infrastructure message for which the SIF_Ack serves as a response."

Returns:

The SIF_OriginalSourceId element of this object.

Since:

1.1

setSIF_OriginalSourceId

public void setSIF_OriginalSourceId(java.lang.String value)

Sets the value of the <SIF_OriginalSourceId> element.

The SIF specification defines the meaning of this element as: "The SIF_SourceId of the infrastructure message for which the SIF_Ack serves as a response."

Parameters:

value - A String object

Since:

1.1

getSIF_OriginalMsgId

public java.lang.String getSIF_OriginalMsgId()

Gets the value of the <SIF_OriginalMsgId> element.

The SIF specification defines the meaning of this element as: "The SIF_MsgId of the infrastructure message for which the SIF_Ack message serves as a response."

Returns:

The SIF_OriginalMsgId element of this object.

Since:

1.1

setSIF_OriginalMsgId

public void setSIF_OriginalMsgId(java.lang.String value)

Sets the value of the <SIF_OriginalMsgId> element.

The SIF specification defines the meaning of this element as: "The SIF_MsgId of the infrastructure message for which the SIF_Ack message serves as a response."

Parameters:

value - A String object

Since:

1.1

setSIF_Status

public void setSIF_Status(SIF_Status value)

Sets the value of the <SIF_Status> element.

The SIF specification defines the meaning of this element as: "This element is used to signal a successful response."

Parameters:

value - A SIF_Status object

Since:

1.1

getSIF_Status

public SIF_Status getSIF_Status()

Gets the value of the <SIF_Status> element.

The SIF specification defines the meaning of this element as: "This element is used to signal a successful response."

Returns:

A SIF_Status object

Since:

1.1

removeSIF_Status

public void removeSIF_Status()

Removes the SIF_Status child element previously created by calling setSIF_Status

Since:

1.1

setSIF_Error

public void setSIF_Error(SIF_Error value)

Sets the value of the <SIF_Error> element.

The SIF specification defines the meaning of this element as: "This element is used to signal an unsuccessful response."

Parameters:

value - A SIF_Error object

Since:

1.1

getSIF_Error

public SIF_Error getSIF_Error()

Gets the value of the <SIF_Error> element.

The SIF specification defines the meaning of this element as: "This element is used to signal an unsuccessful response."

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

hasStatusCode

public boolean hasStatusCode(int code)

Determines if this SIF_Ack has a specific status code.

Parameters:

code - The status code to test for

Returns:

true if the SIF_Ack has one or more SIF_Status children and one of those contains the status code

hasError

public boolean hasError()

Determines if this SIF_Ack communicates an error

Returns:

true if there is at least one SIF_Error child of SIF_Ack

hasError

public boolean hasError(int category,
                        int code)

Determines if this SIF_Ack contains the specified error code

Parameters:

category - The error category

code - The error code

Returns:

true if the SIF_Ack contains this error

LogSend

public void LogSend(org.apache.log4j.Category log)

Description copied from class: SIFMessagePayload

Utility method called by the class framework to log this SIF_Message prior to sending it to a zone.

Overrides:

LogSend in class SIFMessagePayload

Parameters:

log - The Log4j Category instance representing the destination Zone

LogRecv

public void LogRecv(org.apache.log4j.Category log)

Description copied from class: SIFMessagePayload

Utility method called by the class framework to log this SIF_Message upon receipt from a zone.

Overrides:

LogRecv in class SIFMessagePayload

Parameters:

log - The Log4j Category instance representing the source Zone