de.osci.osci12.messagetypes
Class FetchProcessCard

java.lang.Object
  |
  +--de.osci.osci12.messagetypes.OSCIMessage
        |
        +--de.osci.osci12.messagetypes.OSCIRequest
              |
              +--de.osci.osci12.messagetypes.FetchProcessCard

public class FetchProcessCard
extends OSCIRequest

Laufzettelabholauftrag

Mit dieser Klasse werden Nachrichtenobjekte für Laufzettelabholaufträge angelegt. Clients können hiermit Laufzettel eingegangener Nachrichten vom Intermediär abrufen. Als Antwort auf diese Nachricht erhalten sie vom Intermediär ein ResponseToFetchProcessCard-Nachrichtenobjekt, welches eine Rückmeldung über den Erfolg der Operation und ggf. die gewünschten Laufzettel enthält.

Copyright: Copyright (c) 2003

Organisation: bremen online services GmbH & Co. KG

Version:
1.0
See Also:
ResponseToFetchProcessCard

Field Summary
 
Fields inherited from class de.osci.osci12.messagetypes.OSCIMessage
ACCEPT_DELIVERY, attachments, contentContainer, contentID, desiredLanguagesH, dialogHandler, encryptedData, EXIT_DIALOG, FETCH_DELIVERY, FETCH_PROCESS_CARD, FORWARD_DELIVERY, GET_MESSAGE_ID, hashableMsgPart, INIT_DIALOG, intermediaryCertificatesH, MEDIATE_DELIVERY, NO_SELECTION_RULE, nonIntermediaryCertificatesH, PROCESS_DELIVERY, qualityOfTimestampTypeCreation, qualityOfTimestampTypeReception, RESPONSE_TO_ACCEPT_DELIVERY, RESPONSE_TO_EXIT_DIALOG, RESPONSE_TO_FETCH_DELIVERY, RESPONSE_TO_FETCH_PROCESS_CARD, RESPONSE_TO_FORWARD_DELIVERY, RESPONSE_TO_GET_MESSAGE_ID, RESPONSE_TO_INIT_DIALOG, RESPONSE_TO_MEDIATE_DELIVERY, RESPONSE_TO_PROCESS_DELIVERY, RESPONSE_TO_STORE_DELIVERY, SELECT_BY_DATE_OF_RECEPTION, SELECT_BY_MESSAGE_ID, SELECT_BY_RECENT_MODIFICATION, signatureHeader, SOAP_FAULT_MESSAGE, SOAP_MESSAGE_ENCRYPTED, STORE_DELIVERY, TYPE_UNDEFINED
 
Constructor Summary
FetchProcessCard(DialogHandler dh)
          Legt ein Nachrichtenobjekt für einen Laufzettelabholauftrag an.
 
Method Summary
 long getQuantityLimit()
          Liefert die maximale Anzahl zurückzugebender Laufzettel.
 int getSelectionMode()
          Liefert den gesetzten Auswahlmodus.
 java.lang.String getSelectionRule()
          Liefert die gesetzte Auswahlregel.
 ResponseToFetchProcessCard send()
          Versendet die Nachricht und liefert die Antwortnachricht zurück.
 ResponseToFetchProcessCard send(java.io.OutputStream storeOutput, java.io.OutputStream storeInput)
          Versendet die Nachricht und liefert die Antwortnachricht zurück.
 void setQuantityLimit(long quantityLimit)
          Legt die maximale Anzahl zurückzugebender Laufzettel fest.
 void setSelectionMode(int selectionMode)
          Setzt den Auswahlmodus.
 void setSelectionRule(java.lang.String selectionRule)
          Setzt die Auswahlregel für die abzuholende Nachricht.
 
Methods inherited from class de.osci.osci12.messagetypes.OSCIRequest
getDesiredLanguages
 
Methods inherited from class de.osci.osci12.messagetypes.OSCIMessage
addCustomHeader, addRole, formatISO8601, getAddressee, getCustomHeaders, getDialogHandler, getMessageType, getOriginator, getOtherAuthors, getOtherReaders, getRoleForRefID, main, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FetchProcessCard

public FetchProcessCard(DialogHandler dh)
                 throws java.security.NoSuchAlgorithmException
Legt ein Nachrichtenobjekt für einen Laufzettelabholauftrag an.

Parameters:
dh - DialogHandler-Objekt des Dialogs, innerhalb dessen die Nachricht versendet werden soll.
See Also:
DialogHandler
Method Detail

send

public ResponseToFetchProcessCard send()
                                throws java.io.IOException,
                                       OSCIException,
                                       java.security.NoSuchAlgorithmException
Versendet die Nachricht und liefert die Antwortnachricht zurück. Diese Methode wirft eine Exception, wenn beim Aufbau oder Versand der Nachricht ein Fehler auftritt. Fehlermeldungen vom Intermediär müssen dem Feedback der Antwortnachricht entnommen werden.

Returns:
das Antwortnachricht-Objekt
Throws:
java.io.IOException - bei Ein-/Ausgabefehlern
OSCIException - bei OSCI-Fehlern
java.security.NoSuchAlgorithmException
See Also:
send(OutputStream, OutputStream)

send

public ResponseToFetchProcessCard send(java.io.OutputStream storeOutput,
                                       java.io.OutputStream storeInput)
                                throws java.io.IOException,
                                       OSCIException,
                                       java.security.NoSuchAlgorithmException
Versendet die Nachricht und liefert die Antwortnachricht zurück. Die aus- und eingehenden Daten werden zusätzlich in die übergebenen Streams geschrieben (unverschlüsselte Auftragsdaten). Diese Parameter dürfen null sein.

Parameters:
storeOutput - Stream, in den die versendete Nachricht geschrieben wird
storeInput - Stream, in den die empfangene Antwortnachricht geschrieben wird
Returns:
das Antwortnachricht-Objekt
Throws:
java.io.IOException - bei Ein-/Ausgabefehlern
OSCIException - bei OSCI-Fehlern
java.security.NoSuchAlgorithmException
See Also:
send()

setSelectionRule

public void setSelectionRule(java.lang.String selectionRule)
Setzt die Auswahlregel für die abzuholende Nachricht. Der Inhalt des übergebenen Strings hängt vom gewählten Auswahlmodus ab und kann entweder in einer Base64-codierten Message-Id oder einem Datum bestehen. Das Format eines Datums muß dem XML-Schema nach http://www.w3.org/TR/xmlschema-2/#dateTime (ISO 8601-Format) entsprechen.

Parameters:
selectionRule - Message-Id oder Datum
See Also:
setSelectionMode(int), getSelectionRule(), OSCIMessage.formatISO8601(java.util.Date)

getSelectionRule

public java.lang.String getSelectionRule()
Liefert die gesetzte Auswahlregel. Wurde keine Regel gesetzt, wird als default null zurückgegeben.

Returns:
die Auswahlregel (Message-Id oder Datum)
See Also:
setSelectionRule(String), setSelectionMode(int)

setSelectionMode

public void setSelectionMode(int selectionMode)
Setzt den Auswahlmodus. Mögliche Werte sind SELECT_BY_MESSAGE_ID, SELECT_BY_DATE_OF_RECEPTION, SELECT_BY_RECENT_MODIFICATION oder NO_SELECTION_RULE (default).

Parameters:
selectionMode - Auswahlmodus
See Also:
OSCIMessage.SELECT_BY_MESSAGE_ID, OSCIMessage.SELECT_BY_DATE_OF_RECEPTION, OSCIMessage.SELECT_BY_RECENT_MODIFICATION, OSCIMessage.NO_SELECTION_RULE, setSelectionRule(String)

getSelectionMode

public int getSelectionMode()
Liefert den gesetzten Auswahlmodus.

Returns:
den Auswahlmodus SELECT_BY_MESSAGE_ID, SELECT_BY_DATE_OF_RECEPTION, SELECT_BY_RECENT_MODIFICATION oder NO_SELECTION_RULE
See Also:
setSelectionRule(String), getSelectionMode()

getQuantityLimit

public long getQuantityLimit()
Liefert die maximale Anzahl zurückzugebender Laufzettel.

Returns:
gesetzte maximale Anzahl

setQuantityLimit

public void setQuantityLimit(long quantityLimit)
Legt die maximale Anzahl zurückzugebender Laufzettel fest.

Parameters:
quantityLimit - gewünschte maximale Anzahl


Copyright © 2004. All Rights Reserved.