Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| ### OSCI2-StarterKit
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## eu.osci.messagetypes
Class OSCIMsgBoxStatusListRequest

    java.lang.Object
      eu.osci.messagetypes.OSCIMessage
          eu.osci.messagetypes.OSCIRequestParent
              eu.osci.messagetypes.OSCIMsgBoxStatusListRequest

    public class OSCIMsgBoxStatusListRequest

extends OSCIRequestParent

This class gets the status list of OSCI messages from the requested OSCI message box. The selection rules must be set and the next period of the list can be fetched by the `OSCIMsgBoxGetNextRequest` message.
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`

Constructor Summary
`OSCIMsgBoxStatusListRequest(EndpointLocator endpointLocator, javax.xml.ws.WebServiceFeature... _features)` Constructor for endpointLocator parameter with all necessary information.
`OSCIMsgBoxStatusListRequest(OSCIRequestParent parent)` This constructor is normally used by the client.
`OSCIMsgBoxStatusListRequest(java.net.URL _wsdlURL, javax.xml.namespace.QName _serviceQName, javax.xml.namespace.QName _portQName, javax.xml.ws.WebServiceFeature... _features)` Constructor with the necessary parameters.

Method Summary
`eu.osci.ws._2008._05.transport.MsgBoxStatusListRequestType` | `getMsgBoxStatusListRequestType()` Returns the created selections for the request.
`OSCIMsgBoxStatusListResponse` | `sendRequest()` Sends the request to present server.
`void` | `setMsgBoxStatusListRequestType(eu.osci.ws._2008._05.transport.MsgBoxStatusListRequestType _msgBoxStatusListRequestType)` Please use the setSelection* methods to configure the fetch status list request.
`void` | `setReplyTo(org.w3._2005._08.addressing.EndpointReferenceType _replyTo)` Sets the addressing 'ReplyTo' attribute on the OSCI message.
`void` | `setSelectionAll(boolean onlyNewElements, org.w3._2005._08.addressing.EndpointReferenceType endpoint, int maxListItems)` Selects a list of OSCI status lists for the given endpoint.
`void` | `setSelectionByDate(java.util.Date from, java.util.Date to, boolean onlyNewElements, org.w3._2005._08.addressing.EndpointReferenceType endpoint, int maxListItems)` Selects a list of OSCI status lists for the given endpoint by using the creation time of the stored messages.
`void` | `setSelectionByMessageId(java.lang.String[] messageIDList, org.w3._2005._08.addressing.EndpointReferenceType endpoint, int maxListItems)` Selects a list of OSCI status lists for the given endpoint by using the the given messageIds of the stored messages.
`void` | `setSelectionByRelatesTo(java.lang.String[] relatesToList, org.w3._2005._08.addressing.EndpointReferenceType endpoint, int maxListItems)` Selects a list of OSCI status lists for the given endpoint by using addressing 'RelatesTo' element.

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, getMessageId, getTo, setAction, setAdditionalHeaderList, setMessageId, setTo`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### OSCIMsgBoxStatusListRequest

    public OSCIMsgBoxStatusListRequest(java.net.URL _wsdlURL,
                                       javax.xml.namespace.QName _serviceQName,
                                       javax.xml.namespace.QName _portQName,
                                       javax.xml.ws.WebServiceFeature... _features)

  Constructor with the necessary parameters. The URL to WSDL is given and the service and port out of it.

  Parameters:
    `_wsdlURL` - The URL to the WSDL.
    `_serviceQName` - The service that will be used.
    `_portQName` - The port name that will be used
    `_features` - To add other features for the endpoint (see Metro Api-Doc).

### OSCIMsgBoxStatusListRequest

    public OSCIMsgBoxStatusListRequest(OSCIRequestParent parent)

  This constructor is normally used by the client. The previous request will be given as parameter.

  Parameters:
    `parent` - The previous request.

### OSCIMsgBoxStatusListRequest

    public OSCIMsgBoxStatusListRequest(EndpointLocator endpointLocator,
                                       javax.xml.ws.WebServiceFeature... _features)

  Constructor for endpointLocator parameter with all necessary information.

  Parameters:
    `endpointLocator` - The configured endpointLocator object.
    `_features` - To add other features for the endpoint (see Metro Api-Doc).

Method Detail

### getMsgBoxStatusListRequestType

    public eu.osci.ws._2008._05.transport.MsgBoxStatusListRequestType getMsgBoxStatusListRequestType()

  Returns the created selections for the request.

### setMsgBoxStatusListRequestType

    public void setMsgBoxStatusListRequestType(eu.osci.ws._2008._05.transport.MsgBoxStatusListRequestType _msgBoxStatusListRequestType)

  Please use the setSelection* methods to configure the fetch status list request. In special cases it is necessary to build the selection configuration on its own. In this case this method will be used to set the search configuration.

  Parameters:
    `_msgBoxStatusListRequestType` - The configured search configuration.

### sendRequest

    public OSCIMsgBoxStatusListResponse sendRequest()
                                             throws javax.xml.bind.JAXBException,
                                                    OSCIException

  Sends the request to present server. A SOAP message will be sent and the response message with the fetched status list will be created. Before this method can be used a 'setSelection*' method must be called.

  Returns:
    An OSCI response message including the status list.
  Throws:
    `javax.xml.bind.JAXBException` - In the case of parsing or serialisation errors.
    `OSCIException` - In the case of OSCI SOAP faults.

### setSelectionByMessageId

    public void setSelectionByMessageId(java.lang.String[] messageIDList,
                                        org.w3._2005._08.addressing.EndpointReferenceType endpoint,
                                        int maxListItems)

  Selects a list of OSCI status lists for the given endpoint by using the the given messageIds of the stored messages.

  Parameters:
    `messageIDList` - A list of messageIds that will be fetched.
    `endpoint` - The endpoint (Address and TypeOfBusinessScenario) to select.
    `maxListItems` - The limit for the search result list.

### setSelectionByRelatesTo

    public void setSelectionByRelatesTo(java.lang.String[] relatesToList,
                                        org.w3._2005._08.addressing.EndpointReferenceType endpoint,
                                        int maxListItems)

  Selects a list of OSCI status lists for the given endpoint by using addressing 'RelatesTo' element.

  Parameters:
    `relatesToList` - A list of addressing 'RelatesToList' Ids that will be fetched for.
    `endpoint` - The endpoint (Address and TypeOfBusinessScenario) to select.
    `maxListItems` - The limit for the search result list.

### 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.

### setSelectionAll

    public void setSelectionAll(boolean onlyNewElements,
                                org.w3._2005._08.addressing.EndpointReferenceType endpoint,
                                int maxListItems)

  Selects a list of OSCI status lists for the given endpoint.

  Parameters:
    `onlyNewElements` - Indicates that only new (unfetched) status lists will be returned, in the case of 'true'.
    `endpoint` - The endpoint (Address and TypeOfBusinessScenario) to select.
    `maxListItems` - The limit for the search result list.

### setSelectionByDate

    public void setSelectionByDate(java.util.Date from,
                                   java.util.Date to,
                                   boolean onlyNewElements,
                                   org.w3._2005._08.addressing.EndpointReferenceType endpoint,
                                   int maxListItems)
                            throws javax.xml.datatype.DatatypeConfigurationException

  Selects a list of OSCI status lists for the given endpoint by using the creation time of the stored messages.

  Parameters:
    `from` - Starting date/time for the selection.
    `to` - End date/time for the selection.
    `onlyNewElements` - Indicates that only new (unfetched) status lists will be returned, in the case of 'true'.
    `endpoint` - The endpoint (Address and TypeOfBusinessScenario) to select.
    `maxListItems` - The limit for the search result list.
  Throws:
    `javax.xml.datatype.DatatypeConfigurationException` - If there are converting errors with the date objects.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| ### OSCI2-StarterKit
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2010 Freie Hansestadt Bremen.