From 20e3096362c4a34eaff090ad8eeb42f0c84d95f5 Mon Sep 17 00:00:00 2001
From: Jan Zickermann <jan.zickermann@dataport.de>
Date: Mon, 9 Sep 2024 12:34:01 +0200
Subject: [PATCH] OZG-6240 KOP-2627 Add javadoc to getMessage

---
 src/main/java/de/ozgcloud/xta/client/XtaClient.java | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/main/java/de/ozgcloud/xta/client/XtaClient.java b/src/main/java/de/ozgcloud/xta/client/XtaClient.java
index ea84475..8fd91ea 100644
--- a/src/main/java/de/ozgcloud/xta/client/XtaClient.java
+++ b/src/main/java/de/ozgcloud/xta/client/XtaClient.java
@@ -53,6 +53,13 @@ public class XtaClient {
 		return service.getStatusList(clientIdentifier, config.getMaxListItems());
 	}
 
+	/**
+	 * Fetch the message content, close the message, and then the fetch transport report
+	 * for the given {@code messageId} for the reader with identifier {@code clientIdentifier}.
+	 * @param clientIdentifier Identifier of the reading client
+	 * @param messageId Identifier of the message to fetch
+	 * @return The message and transport report
+	 */
 	public XtaMessageAndTransportReport getMessage(@NotBlank String clientIdentifier, @NotBlank String messageId)
 			throws XTAWSTechnicalProblemException, PermissionDeniedException, InvalidMessageIDException {
 		var identifier = deriveIdentifier(clientIdentifier);
-- 
GitLab