OSCI2-StarterKit


eu.osci.messagetypes
Class OSCIMsgBoxGetNextRequest

java.lang.Object
  extended by eu.osci.messagetypes.OSCIMessage
      extended by eu.osci.messagetypes.OSCIRequestParent
          extended by eu.osci.messagetypes.OSCIMsgBoxGetNextRequest

public class OSCIMsgBoxGetNextRequest
extends OSCIRequestParent

The OSCIMsgBoxGetNextRequest will be used to get the next result set from a previous MsgBoxFetch or MsgBoxStatusList request. With this class a next block/page of the previous request will be returned.
Copyright © 2010 Freie Hansestadt Bremen.
Created by bremen online services Entwicklungs- und Betriebsgesellschaft mbH & Co. KG.
This library (Starter Kit) can be used by anybody according to the Bremer Lizenz für freie Softwarebibliotheken. The license terms can be viewed at www.osci.de or can be ordered at the OSCI-Leitstelle (Die Senatorin für Finanzen, Freie Hansestadt Bremen, Postfach 10 15 40, 28015 Bremen).


Nested Class Summary
static class OSCIMsgBoxGetNextRequest.TypeOfGetNextRequest
           
 
Field Summary
 
Fields inherited from class eu.osci.messagetypes.OSCIMessage
text
 
Constructor Summary
OSCIMsgBoxGetNextRequest(OSCIRequestParent parent)
          This constructor is normally used by the client.
 
Method Summary
 eu.osci.ws._2008._05.transport.MsgBoxGetNextRequestType getMsgBoxGetNextRequestType()
          Returns the created or set MsgBoxGetNextRequest for further processing.
 OSCIMsgBoxGetNextRequest.TypeOfGetNextRequest getTypeOfGetNextRequest()
           
 OSCIMsgBoxFetchResponse sendFetchRequest(java.lang.String... commitReceivedMessages)
          Sends the request to present server.
 OSCIMsgBoxStatusListResponse sendStatusListRequest()
          Sends the request to present server.
 void setMsgBoxGetNextRequestType(eu.osci.ws._2008._05.transport.MsgBoxGetNextRequestType _msgBoxGetNextRequestType)
          Sets the MsgBoxGetNextRequest object.
 void setReplyTo(org.w3._2005._08.addressing.EndpointReferenceType _replyTo)
          Sets the addressing 'ReplyTo' attribute on the OSCI message.
 void setTypeOfGetNextRequest(OSCIMsgBoxGetNextRequest.TypeOfGetNextRequest typeOfGetNextRequest)
           
 
Methods inherited from class eu.osci.messagetypes.OSCIRequestParent
getFaultTo, getFetchIteratorID, getFrom, getReplyTo, getTypeOfBusinessScenario, setFaultTo, setFrom, setTypeOfBusinessScenario
 
Methods inherited from class eu.osci.messagetypes.OSCIMessage
getAction, getAdditionalHeaderList, getBindingProvider, getMessageId, getTo, setAction, setAdditionalHeaderList, setMessageId, setTo
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OSCIMsgBoxGetNextRequest

public OSCIMsgBoxGetNextRequest(OSCIRequestParent parent)
This constructor is normally used by the client. The previous request will be given as parameter. If a OSCIMsgBoxFetchRequest, OSCIMsgBoxGetNextRequest and than a OSCIMsgBoxCloseRequest will be sent, than the previous OSCI message could be given to this constructor because the configuration is the same.

Parameters:
parent - The previous request object.
Method Detail

getTypeOfGetNextRequest

public OSCIMsgBoxGetNextRequest.TypeOfGetNextRequest getTypeOfGetNextRequest()

setTypeOfGetNextRequest

public void setTypeOfGetNextRequest(OSCIMsgBoxGetNextRequest.TypeOfGetNextRequest typeOfGetNextRequest)

getMsgBoxGetNextRequestType

public eu.osci.ws._2008._05.transport.MsgBoxGetNextRequestType getMsgBoxGetNextRequestType()
Returns the created or set MsgBoxGetNextRequest for further processing.

Returns:
The created or set MsgBoxGetNextRequest or a IllegalStateException if there is no object present.

setMsgBoxGetNextRequestType

public void setMsgBoxGetNextRequestType(eu.osci.ws._2008._05.transport.MsgBoxGetNextRequestType _msgBoxGetNextRequestType)
Sets the MsgBoxGetNextRequest object. In most cases this method makes no sense. Use the constructor with the OSCIRequestParent and the send* methods instead.

Parameters:
_msgBoxGetNextRequestType - The MsgBoxGetNextRequest for selection. If there is an object already set a IllegalStateException will be thrown

setReplyTo

public void setReplyTo(org.w3._2005._08.addressing.EndpointReferenceType _replyTo)
Sets the addressing 'ReplyTo' attribute on the OSCI message. Including the URL for reply messages.
Be careful with this setter because if the framework will put a 'ReplyTo' header into the SOAP message there will be two headers available.

Parameters:
_replyTo - The 'ReplyTo' attribute.

sendFetchRequest

public OSCIMsgBoxFetchResponse sendFetchRequest(java.lang.String... commitReceivedMessages)
                                         throws javax.xml.bind.JAXBException
Sends the request to present server. A SOAP message will be sent and the response message with the fetched message will be created.

Parameters:
commitReceivedMessages - Previous messages that will be marked as committed.
Returns:
The created response message.
Throws:
javax.xml.bind.JAXBException - In the case of serialisation errors.

sendStatusListRequest

public OSCIMsgBoxStatusListResponse sendStatusListRequest()
                                                   throws javax.xml.bind.JAXBException
Sends the request to present server. A SOAP message will be sent and the response message with the fetched status list will be created.

Returns:
The created response message
Throws:
javax.xml.bind.JAXBException - In the case of serialisation errors.

OSCI2-StarterKit


Copyright © 2010 Freie Hansestadt Bremen.