com.edustructures.sifworks.infra
Class SIF_Request

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SIF_Request
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_Request()
Constructor

Method Summary

void	addSIF_Version(SIF_Version value) Adds a new <SIF_Version> child element.
SIF_ExtendedQuery	getSIF_ExtendedQuery() Gets the value of the <SIF_ExtendedQuery> element.
SIF_Header	getSIF_Header() Gets the value of the <SIF_Header> element.
java.lang.Integer	getSIF_MaxBufferSize() Gets the value of the <SIF_MaxBufferSize> element.
SIF_Query	getSIF_Query() Gets the value of the <SIF_Query> 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.
SIFVersion[]	parseRequestVersions(org.apache.log4j.Logger failureLog) Parses the list of SIF_Version elements and returns an array of SIFVersions
void	removeSIF_ExtendedQuery() Removes the SIF_ExtendedQuery child element previously created by calling setSIF_ExtendedQuery
void	removeSIF_Header() Removes the SIF_Header child element previously created by calling setSIF_Header
void	removeSIF_Query() Removes the SIF_Query child element previously created by calling setSIF_Query
void	removeSIF_Version(java.lang.String value) Removes a SIF_Version object instance.
void	setSIF_ExtendedQuery(SIF_ExtendedQuery value) Sets the value of the <SIF_ExtendedQuery> element.
void	setSIF_Header(SIF_Header value) Sets the value of the <SIF_Header> element.
void	setSIF_MaxBufferSize(java.lang.Integer value) Sets the value of the <SIF_MaxBufferSize> element.
void	setSIF_Query(SIF_Query value) Sets the value of the <SIF_Query> 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_Request

public SIF_Request()

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_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 should be used when returning the response data; wildcards are allowed. The version specified by SIF_Message/@Version SHOULD be the preferred version to return if it exists in the list, either explicitly or implicitly via a wildcard. Otherwise the responding agent can return data in any version it chooses that matches/satisfies one of the versions in the list. "

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 response packet to be returned to the requester. The responder may return packets smaller than, or equal to, the maximum value. If the maximum size is too small to contain a single whole response object, the responder should reject the SIF_Request. To guarantee delivery of response packets, requesting agents must not specify a SIF_MaxBufferSize greater than its registered SIF_Register/SIF_MaxBufferSize."

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 response packet to be returned to the requester. The responder may return packets smaller than, or equal to, the maximum value. If the maximum size is too small to contain a single whole response object, the responder should reject the SIF_Request. To guarantee delivery of response packets, requesting agents must not specify a SIF_MaxBufferSize greater than its registered SIF_Register/SIF_MaxBufferSize."

Parameters:

value - A Integer object

Since:

1.1

setSIF_Query

public void setSIF_Query(SIF_Query value)

Sets the value of the <SIF_Query> element.

The SIF specification defines the meaning of this element as: "Either SIF_Query or SIF_ExtendedQuery must be specified, which contain the criteria to be used to match response objects."

Parameters:

value - A SIF_Query object

Since:

1.1

getSIF_Query

public SIF_Query getSIF_Query()

Gets the value of the <SIF_Query> element.

The SIF specification defines the meaning of this element as: "Either SIF_Query or SIF_ExtendedQuery must be specified, which contain the criteria to be used to match response objects."

Returns:

A SIF_Query object

Since:

1.1

removeSIF_Query

public void removeSIF_Query()

Removes the SIF_Query child element previously created by calling setSIF_Query

Since:

1.1

setSIF_ExtendedQuery

public void setSIF_ExtendedQuery(SIF_ExtendedQuery value)

Sets the value of the <SIF_ExtendedQuery> element.

Parameters:

value - A SIF_ExtendedQuery object

Since:

2.0

getSIF_ExtendedQuery

public SIF_ExtendedQuery getSIF_ExtendedQuery()

Gets the value of the <SIF_ExtendedQuery> element.

Returns:

A SIF_ExtendedQuery object

Since:

2.0

removeSIF_ExtendedQuery

public void removeSIF_ExtendedQuery()

Removes the SIF_ExtendedQuery child element previously created by calling setSIF_ExtendedQuery

Since:

2.0

parseRequestVersions

public SIFVersion[] parseRequestVersions(org.apache.log4j.Logger failureLog)

Parses the list of SIF_Version elements and returns an array of SIFVersions

Parameters:

failureLog - The log to write failures to, if any of the SIFVersions fail to be parsed.

Returns:

An array of SIFVersion elements. This will never be null