aboutsummaryrefslogtreecommitdiff
path: root/pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/PdfAs.java
diff options
context:
space:
mode:
Diffstat (limited to 'pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/PdfAs.java')
-rw-r--r--pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/PdfAs.java25
1 files changed, 25 insertions, 0 deletions
diff --git a/pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/PdfAs.java b/pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/PdfAs.java
index 2711afe2..3ae329cf 100644
--- a/pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/PdfAs.java
+++ b/pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/PdfAs.java
@@ -33,7 +33,32 @@ public interface PdfAs {
*/
public Configuration getConfiguration();
+ /**
+ * Starts a signature process
+ *
+ * After the process has to be startet the status request has to be services by the user application
+ *
+ * @param parameter The sign parameter
+ * @return A status request
+ * @throws PdfAsException
+ */
public StatusRequest startSign(SignParameter parameter) throws PdfAsException;
+
+ /**
+ * Continues an ongoing signature process
+ *
+ * @param statusRequest The current status
+ * @return A status request
+ * @throws PdfAsException
+ */
public StatusRequest process(StatusRequest statusRequest) throws PdfAsException;
+
+ /**
+ * Finishes a signature process
+ *
+ * @param statusRequest The current status
+ * @return A signature result
+ * @throws PdfAsException
+ */
public SignResult finishSign(StatusRequest statusRequest) throws PdfAsException;
}