OSCI2-StarterKit


eu.osci.messagetypes
Class OSCIRequestParent

java.lang.Object
  extended by eu.osci.messagetypes.OSCIMessage
      extended by eu.osci.messagetypes.OSCIRequestParent
Direct Known Subclasses:
OSCIMsgBoxCloseRequest, OSCIMsgBoxFetchRequest, OSCIMsgBoxGetNextRequest, OSCIMsgBoxStatusListRequest, OSCIRequest

public abstract class OSCIRequestParent
extends OSCIMessage

This is the parent class for all OSCIRequest messages. All common fields with setters and getters and the common methods for preparing and interpreting the SOAP message are offered.
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).


Field Summary
 
Fields inherited from class eu.osci.messagetypes.OSCIMessage
text
 
Method Summary
 org.w3._2005._08.addressing.EndpointReferenceType getFaultTo()
          Returns the addressing 'FaultTo' field.
 java.lang.String getFetchIteratorID()
          Returns the fetchIteratorID in case of OSCI fetch messages.
 org.w3._2005._08.addressing.EndpointReferenceType getFrom()
          Returns the addressing 'From' field.
 org.w3._2005._08.addressing.EndpointReferenceType getReplyTo()
          Returns the addressing 'ReplyTo' field.
 java.lang.String getTypeOfBusinessScenario()
          Returns the OSCI 'TypeOfBusinessScenario'.
 void setFaultTo(org.w3._2005._08.addressing.EndpointReferenceType _faultTo)
          Sets the addressing 'FaultTo' attribute.
 void setFrom(org.w3._2005._08.addressing.EndpointReferenceType _from)
          Sets the addressing 'From' attribute.
 void setTypeOfBusinessScenario(java.lang.String typeOfBusinessScenario)
          Sets the OSCI 'TypeOfBusinessScenario' attribute.
 
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
 

Method Detail

getTypeOfBusinessScenario

public java.lang.String getTypeOfBusinessScenario()
Returns the OSCI 'TypeOfBusinessScenario'. In most cases the value out of the WSDL will be used.


setTypeOfBusinessScenario

public void setTypeOfBusinessScenario(java.lang.String typeOfBusinessScenario)
Sets the OSCI 'TypeOfBusinessScenario' attribute. This setter has no sense in most cases because the 'TypeOfBusinessScenario' attribute out of the WSDL will be used. Be careful with this setter because if the framework will put a 'typeOfBusinessScenario' header into the SOAP message there will be two headers available.

Parameters:
typeOfBusinessScenario - The 'TypeOfBusinessScenario' element that will be used.

getFrom

public org.w3._2005._08.addressing.EndpointReferenceType getFrom()
Returns the addressing 'From' field.


setFrom

public void setFrom(org.w3._2005._08.addressing.EndpointReferenceType _from)
Sets the addressing 'From' attribute.

Parameters:
_from - The 'From' element that will be used.

getFetchIteratorID

public java.lang.String getFetchIteratorID()
Returns the fetchIteratorID in case of OSCI fetch messages.


getReplyTo

public org.w3._2005._08.addressing.EndpointReferenceType getReplyTo()
Returns the addressing 'ReplyTo' field. In case of symmetrical binding like HTTP this value must be 'http://www.w3.org/2005/08/addressing/anonymous'. Be careful with this setter because if the framework will put a 'ReplyTo' header into the SOAP message there will be two headers available.


getFaultTo

public org.w3._2005._08.addressing.EndpointReferenceType getFaultTo()
Returns the addressing 'FaultTo' field.


setFaultTo

public void setFaultTo(org.w3._2005._08.addressing.EndpointReferenceType _faultTo)
Sets the addressing 'FaultTo' attribute. Should not be used with HTTP binding because the fault will be returned on the back-channel. May force an exception from the framework if this setter will be used with HTTP binding.

Parameters:
_faultTo - The 'FaultTo' element that will be used.

OSCI2-StarterKit


Copyright © 2010 Freie Hansestadt Bremen.