Added more documentation to client classes (#3)

skat · Nov 20, 2017 · e7cba81 · e7cba81
1 parent 0a761f3
commit e7cba81
Show file tree

Hide file tree

Showing 9 changed files with 68 additions and 17 deletions.
diff --git a/.gitignore b/.gitignore
@@ -10,6 +10,4 @@ buildNumber.properties
 .idea
 *.iml
 # Do not add:
-run-submit.sh
-run-fetch.sh
-run-fetch-ie704.sh
+run-*.sh
diff --git a/README.md b/README.md
@@ -26,9 +26,12 @@ the current versions of the mentioned frameworks in use.
 
 The sample clients currently implements calls to the services:
 
-* **OIOLedsageDocumentOpret**
-* **OIOLedsageDokumentSamlingHent** 
-* **OIOBeskedAfvisningSamlingHent** 
+* **OIOLedsageDocumentOpret** : Submit IE815 document
+* **OIOLedsageDokumentSamlingHent** : Fetch IE801 document related to ARC number
+* **OIOBeskedAfvisningSamlingHent** : Search for IE704 documents within the last month
+
+Service **OIOLedsageDocumentOpret** must invoked before invoking **OIOLedsageDokumentSamlingHent** (using the
+returned ARC number) and **OIOBeskedAfvisningSamlingHent** (if submitted IE815 was not processed by **OIOLedsageDocumentOpret**).
 
 The main entry point into the source code of the implementation is these classes:
 

diff --git a/src/main/java/dk/skat/emcs/b2b/sample/OIOBeskedAfvisningSamlingHentClient.java b/src/main/java/dk/skat/emcs/b2b/sample/OIOBeskedAfvisningSamlingHentClient.java
@@ -26,6 +26,12 @@
 /**
  * OIOBeskedAfvisningSamlingHentClient
  *
+ * Input:
+ *  Date time period (start, end) = the last month
+ *
+ * Output:
+ *  IE704 documents (if any)
+ *
  * @author SKAT
  * @since 1.1
  */
@@ -152,7 +158,7 @@ public void invoke(String virksomhedSENummerIdentifikator,
                 }
             }
         } else {
-            sb.append("** IE 704 Messages: ").append(newLine);
+            sb.append("** IE704 Messages: ").append(newLine);
             List<String> ie704Messages = out.getBeskedAfvisningSamling().getIE704BeskedTekst();
             if (ie704Messages != null && ie704Messages.size() > 0) {
                 for (String message : ie704Messages) {

diff --git a/src/main/java/dk/skat/emcs/b2b/sample/OIOLedsageDocumentOpretClient.java b/src/main/java/dk/skat/emcs/b2b/sample/OIOLedsageDocumentOpretClient.java
@@ -31,6 +31,13 @@
 /**
  * OIOLedsageDocumentOpretClient
  *
+ * Input:
+ *  IE815 document
+ *
+ * Output:
+ *  ARC number = if IE815 was accepted
+ *  Error Message stating IE704 = Instruction to call the service OIOBeskedAfvisningSamlingHentC
+ *
  * @author SKAT
  * @since 1.0
  */

diff --git a/src/main/java/dk/skat/emcs/b2b/sample/OIOLedsageDokumentSamlingHentClient.java b/src/main/java/dk/skat/emcs/b2b/sample/OIOLedsageDokumentSamlingHentClient.java
@@ -25,6 +25,12 @@
 /**
  * OIOLedsageDokumentSamlingHentClient
  *
+ * Input:
+ *  ARC number = from OIOLedsageDocumentOpret response
+ *
+ * Output:
+ *  IE801 document
+ *
  * @author SKAT
  * @since 1.1
  */
@@ -142,7 +148,7 @@ public void invoke(String virksomhedSENummerIdentifikator,
                 }
             }
         } else {
-            sb.append("** IE 801 Messages: ").append(newLine);
+            sb.append("** IE801 Messages: ").append(newLine);
             List<String> ie801Messages = out.getLedsageDokumentStamDataSamling().getIE801BeskedTekst();
             for (String message : ie801Messages) {
                 sb.append(message).append(newLine);

diff --git a/src/test/java/dk/skat/emcs/b2b/sample/BaseClient.java b/src/test/java/dk/skat/emcs/b2b/sample/BaseClient.java
@@ -0,0 +1,31 @@
+package dk.skat.emcs.b2b.sample;
+
+/**
+ * BaseClient - Helper methods for test clients, e.g. we're using the same VAT number for all tests.
+ *
+ * @author SKAT
+ * @since 1.1
+ */
+public class BaseClient {
+
+    /**
+     * Get VAT number
+     *
+     * @return VAT number
+     */
+    protected String getVirksomhedSENummerIdentifikator() {
+        String virksomhedSENummerIdentifikator = "30808460";
+        return virksomhedSENummerIdentifikator;
+    }
+
+    /**
+     * Get AfgiftOperatoerPunktAfgiftIdentifikator
+     *
+     * @return AfgiftOperatoerPunktAfgiftIdentifikator
+     */
+    protected String getAfgiftOperatoerPunktAfgiftIdentifikator() {
+        String afgiftOperatoerPunktAfgiftIdentifikator = "DK82065873300";
+        return afgiftOperatoerPunktAfgiftIdentifikator;
+    }
+
+}
diff --git a/src/test/java/dk/skat/emcs/b2b/sample/OIOBeskedAfvisningSamlingHentClientTest.java b/src/test/java/dk/skat/emcs/b2b/sample/OIOBeskedAfvisningSamlingHentClientTest.java
@@ -8,7 +8,7 @@
  * @author SKAT
  * @since 1.1
  */
-public class OIOBeskedAfvisningSamlingHentClientTest {
+public class OIOBeskedAfvisningSamlingHentClientTest extends BaseClient {
 
     @Test
     public void invoke() throws Exception {
@@ -17,9 +17,9 @@ public void invoke() throws Exception {
 
         if (endpointURL != null) {
             // this CVR number present in the certificate.
-            String virksomhedSENummerIdentifikator = "30808460";
+            String virksomhedSENummerIdentifikator = getVirksomhedSENummerIdentifikator();
             // Excise number
-            String afgiftOperatoerPunktAfgiftIdentifikator = "DK82065873300";
+            String afgiftOperatoerPunktAfgiftIdentifikator = getAfgiftOperatoerPunktAfgiftIdentifikator();
 
             OIOBeskedAfvisningSamlingHentClient oioBeskedAfvisningSamlingHentClient = new OIOBeskedAfvisningSamlingHentClient(endpointURL);
             oioBeskedAfvisningSamlingHentClient.invoke(virksomhedSENummerIdentifikator,

diff --git a/src/test/java/dk/skat/emcs/b2b/sample/OIOLedsageDocumentOpretClientTest.java b/src/test/java/dk/skat/emcs/b2b/sample/OIOLedsageDocumentOpretClientTest.java
@@ -8,7 +8,7 @@
  * @author SKAT
  * @since 1.0
  */
-public class OIOLedsageDocumentOpretClientTest {
+public class OIOLedsageDocumentOpretClientTest extends BaseClient {
 
     @Test
     public void invoke() throws Exception {
@@ -21,9 +21,9 @@ public void invoke() throws Exception {
             String ie815 = "ie815.xml";
             // VAT Number of the entity sending. Rule of thumb: this number matches
             // this CVR number present in the certificate.
-            String virksomhedSENummerIdentifikator = "30808460";
+            String virksomhedSENummerIdentifikator = getVirksomhedSENummerIdentifikator();
             // Excise number
-            String afgiftOperatoerPunktAfgiftIdentifikator = "DK82065873300";
+            String afgiftOperatoerPunktAfgiftIdentifikator = getAfgiftOperatoerPunktAfgiftIdentifikator();
 
             OIOLedsageDocumentOpretClient oioLedsageDocumentClient = new OIOLedsageDocumentOpretClient(endpointURL);
             oioLedsageDocumentClient.invoke(virksomhedSENummerIdentifikator,

diff --git a/src/test/java/dk/skat/emcs/b2b/sample/OIOLedsageDokumentSamlingHentClientTest.java b/src/test/java/dk/skat/emcs/b2b/sample/OIOLedsageDokumentSamlingHentClientTest.java
@@ -8,7 +8,7 @@
  * @author SKAT
  * @since 1.1
  */
-public class OIOLedsageDokumentSamlingHentClientTest {
+public class OIOLedsageDokumentSamlingHentClientTest extends BaseClient {
 
     @Test
     public void invoke() throws Exception {
@@ -21,9 +21,9 @@ public void invoke() throws Exception {
             String ARCnumber =   System.getProperty("dk.skat.emcs.b2b.sample.ARC");
             // VAT Number of the entity sending. Rule of thumb: this number matches
             // this CVR number present in the certificate.
-            String virksomhedSENummerIdentifikator = "30808460";
+            String virksomhedSENummerIdentifikator = getVirksomhedSENummerIdentifikator();
             // Excise number
-            String afgiftOperatoerPunktAfgiftIdentifikator = "DK82065873300";
+            String afgiftOperatoerPunktAfgiftIdentifikator = getAfgiftOperatoerPunktAfgiftIdentifikator();
 
             OIOLedsageDokumentSamlingHentClient ledsageDokumentSamlingHentClient = new OIOLedsageDokumentSamlingHentClient(endpointURL);
             ledsageDokumentSamlingHentClient.invoke(virksomhedSENummerIdentifikator,