updated javadoc

This commit is contained in:
Jochen Stärk
2020-10-17 18:22:34 +02:00
parent 8fd3e98b57
commit 55d35b6d0c
6 changed files with 14 additions and 12 deletions

View File

@@ -84,8 +84,8 @@ public class Invoice implements IExportableTransaction {
/***
* switch type to invoice correction and refer to document number
* @param number
* @return
* @param number the invoice number to be corrected
* @return this object (fluent setter)
*/
public Invoice setCorrection(String number) {
setBuyerOrderReferencedDocumentID(number);
@@ -428,7 +428,7 @@ public class Invoice implements IExportableTransaction {
/***
* checks if all required items are set in order to be able to export it
* @return
* @return true if all required items are set
*/
public boolean isValid() {
return (dueDate != null) && (sender != null) && (sender.getTaxID() != null) && (sender.getVATID() != null) && (recipient != null);

View File

@@ -301,7 +301,7 @@ public interface IExportableTransaction {
* get payment terms. if set, getPaymentTermDescription() and getDueDate() are
* ignored
*
* @return
* @return the IZUGFeRDPaymentTerms of the invoice
*/
default IZUGFeRDPaymentTerms getPaymentTerms() {
return null;
@@ -310,7 +310,7 @@ public interface IExportableTransaction {
/**
* returns if a rebate agreements exists
*
* @return
* @return true if a agreement exists
*/
default boolean rebateAgreementExists() {
return false;
@@ -418,7 +418,7 @@ public interface IExportableTransaction {
/***
* delivery address, i.e. ram:ShipToTradeParty (only supported for zf2)
* @return
* @return the IZUGFeRDExportableTradeParty delivery address
*/
default IZUGFeRDExportableTradeParty getDeliveryAddress() {

View File

@@ -132,7 +132,7 @@ public interface IZUGFeRDExportableTradeParty {
/***
* obligatory for sender but not for recipient
* @return
* @return the tax id as string
*/
default String getTaxID() {
return null;

View File

@@ -154,8 +154,8 @@ public class ZUGFeRD2PullProvider implements IXMLProvider, IAbsoluteValueProvide
/**
* which taxes have been used with which amounts in this transaction, empty for
* no taxes, or e.g. 19=>190 and 7=>14 if 1000 Eur were applicable to 19% VAT
* (=>190 EUR VAT) and 200 EUR were applicable to 7% (=>14 EUR VAT) 190 Eur
* no taxes, or e.g. 19:190 and 7:14 if 1000 Eur were applicable to 19% VAT
* (=190 EUR VAT) and 200 EUR were applicable to 7% (=14 EUR VAT) 190 Eur
*
* @return which taxes have been used with which amounts in this invoice
*/

View File

@@ -168,6 +168,7 @@ public class ZUGFeRDExporterFromA3 extends XRExporter implements IZUGFeRDExporte
/***
* internal helper: return the name of the file attachment for the given zf/fx version
* @param ver the zf/fx version
* @param profile which profile to be used, e.g. Profiles.getByName("EN16931")
* @return the filename of the file to be embedded
*/
public String getFilenameForVersion(int ver, Profile profile) {
@@ -192,6 +193,7 @@ public class ZUGFeRDExporterFromA3 extends XRExporter implements IZUGFeRDExporte
* Generate ZF2.1 files with filename factur-x.xml
*
* @deprecated
* @return this (fluent setter)
*/
public ZUGFeRDExporterFromA3 setFacturX() {
isFacturX = true;

View File

@@ -233,9 +233,9 @@ public class ZUGFeRDImporter {
return result;
}
/**
* Wrapper for protected method exracteString
/***
* Wrapper for protected method extractString
* @param xpathStr
* @return the extracted String for the specific path in the document
*/
public String wExtractString(String xpathStr) {