diff options
author | Andreas Fitzek <andreas.fitzek@iaik.tugraz.at> | 2014-02-05 09:21:35 +0100 |
---|---|---|
committer | Andreas Fitzek <andreas.fitzek@iaik.tugraz.at> | 2014-02-05 09:21:35 +0100 |
commit | 27fb69688a5de7e291ce5a2fd348becb1a722ad5 (patch) | |
tree | f7228da23b421bd3f50ced92485259090963119b /pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/PdfAs.java | |
parent | 87c9269152f8c631123525b796cf07dc0cca7398 (diff) | |
download | pdf-as-4-27fb69688a5de7e291ce5a2fd348becb1a722ad5.tar.gz pdf-as-4-27fb69688a5de7e291ce5a2fd348becb1a722ad5.tar.bz2 pdf-as-4-27fb69688a5de7e291ce5a2fd348becb1a722ad5.zip |
Javadoc for public API
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.java | 25 |
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; } |