MarkDocumentSetRead

The MarkDocumentSetRead operation is used by the recipient of a DocumentSet to denote the event that it has been consumed and processed to the point where it can be categorised as being READ, whether it be by the human eye or by a processing executable etc.

It has a simple method signature, requiring only the UID of the DocumentSet to be marked as being read / processed, with only the owner of the DocumentSet having the permissions to locate and set this event attribute.

The scope or classification that consitutes a READ event is interpreted completely by the consumer of the ReferralNet service. In the context of the Java desktop client, a DocumentSet that can be successfully retrieved, decrypted, parsed and finally physically viewed by the recipient user through the on-click event of an inbox item, initiates a MarkDocumentSetRead invocation.

A MarkDocumentSetRead operation can be applied against a DocumentSet 1..n times to reflect that it may have been retrieved and processed on additional machines etc.

Note: Every successful MarkDocumentSetRead operation causes the ReferralNet service to generate an internal read-receipt message and addressed to the sender of the DocumentSet.

<MarkDocumentSetRead xmlns="urn:global-health:referralnet">urn:1211uguv</MarkDocumentSetRead>
<ns3:RegistryResponse status="Success" xmlns:ns3="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0"></ns3:RegistryResponse>

An error response is returned if the DocumentSet cannot be located due to the UID being invalid or the target DocumentSet is not owned by the user attempting to set the event, or has been marked as logically deleted.

<ns3:RegistryResponse status="Failure" xmlns:ns3="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0">
   <ns3:RegistryErrorList>
      <ns3:RegistryError codeContext="Unable to locate documentSet with id urn:1211uguva" errorCode="DocumentSetException" severity="Error"></ns3:RegistryError>
   </ns3:RegistryErrorList>
</ns3:RegistryResponse>
 
dev/refnet_markdocumentsetread.txt · Last modified: 2009/01/20 00:13 by byron