org.openvpms.esci.service
Interface InboxService

All Known Implementing Classes:
InboxWebService

@BindingType(value="http://schemas.xmlsoap.org/wsdl/soap/http")
public interface InboxService

A service for retrieving documents from suppliers. These may be unsolicited documents, or responses to requests.

Version:
$LastChangedDate: $
Author:
OpenVPMS Team

Method Summary
 void acknowledge(DocumentReferenceType reference)
          Acknowledges a document.
 Document getDocument(DocumentReferenceType reference)
          Returns the document with the specified reference.
 List<DocumentReferenceType> getDocuments()
          Returns a list of document references, in the order that they were received.
 

Method Detail

getDocuments

List<DocumentReferenceType> getDocuments()
Returns a list of document references, in the order that they were received.

Each reference uniquely identifies a single document.

Returns:
a list of document references

getDocument

Document getDocument(DocumentReferenceType reference)
Returns the document with the specified reference.

Parameters:
reference - the document reference
Returns:
the corresponding document, or null if the document is not found

acknowledge

void acknowledge(DocumentReferenceType reference)
                 throws DocumentNotFoundException
Acknowledges a document.

Once acknowledged, the document will no longer be returned by getDocuments() nor getDocument(org.openvpms.esci.ubl.common.aggregate.DocumentReferenceType).

Parameters:
reference - the document reference
Throws:
DocumentNotFoundException - if the reference doesn't refer to a valid document


Copyright © 2010-2011 OpenVPMS. All Rights Reserved..