Interface InvoicesPort

All Superinterfaces:

net.tangly.core.domain.Port<InvoicesRealm>

All Known Implementing Classes:

InvoicesAdapter

public interface InvoicesPort
extends net.tangly.core.domain.Port<InvoicesRealm>

Defines the import port for the bounded domain invoices. It is the primary port in the DDD terminology.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	InvoicesPort.InvoiceView

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ARTICLES_TSV
static final String	INVOICE
static final String	INVOICE_PATH
static final String	JSON_EXT

Fields inherited from interface net.tangly.core.domain.Port

PATTERN

Method Summary

Modifier and Type	Method	Description
void	exportInvoiceDocument(@NotNull net.tangly.core.domain.DomainAudit audit, @NotNull Invoice invoice, boolean withQrCode, boolean withEN16931, boolean pdfa, boolean overwrite, Collection<net.tangly.core.Tag> tags)	Exports an invoice to a file.
void	exportInvoiceDocuments(@NotNull net.tangly.core.domain.DomainAudit audit, boolean withQrCode, boolean withEN16931, boolean pdfa, boolean overwrite, LocalDate from, LocalDate to, Collection<net.tangly.core.Tag> tags)	Exports all selected invoices as artifact to a file.
Optional<InvoicesPort.InvoiceView>	invoiceViewFor(@NotNull String id)

Methods inherited from interface net.tangly.core.domain.Port

clearEntities, exportEntities, importConfiguration, importEntities, realm

Field Details

INVOICE

static final String INVOICE

See Also:

• Constant Field Values

INVOICE_PATH

static final String INVOICE_PATH

See Also:

• Constant Field Values

ARTICLES_TSV

static final String ARTICLES_TSV

See Also:

• Constant Field Values

JSON_EXT

static final String JSON_EXT

See Also:

• Constant Field Values

Method Details

exportInvoiceDocument

void exportInvoiceDocument(@NotNull
 @NotNull net.tangly.core.domain.DomainAudit audit,
 @NotNull
 @NotNull Invoice invoice,
 boolean withQrCode,
 boolean withEN16931,
 boolean pdfa,
 boolean overwrite,
 Collection<net.tangly.core.Tag> tags)

Exports an invoice to a file. The method is responsible for infering the uri to the generated invoice document.

implNote The asciidoc document is deleted upon creation of the pdf document.

Parameters:

invoice - invoice to be exported

withQrCode - flag if the Swiss QR cde should be added to the invoice document

withEN16931 - flag if the EN16931 digital invoice should be added to the invoice document

pdfa - flag if the pdf document should be generated in pdfa format

overwrite - flag if an existing document should be overwritten

See Also:

• exportInvoiceDocuments(DomainAudit, boolean, boolean, boolean,boolean, LocalDate, LocalDate, Collection)

exportInvoiceDocuments

void exportInvoiceDocuments(@NotNull
 @NotNull net.tangly.core.domain.DomainAudit audit,
 boolean withQrCode,
 boolean withEN16931,
 boolean pdfa,
 boolean overwrite,
 LocalDate from,
 LocalDate to,
 Collection<net.tangly.core.Tag> tags)

Exports all selected invoices as artifact to a file. The method is responsible for infering the uri to the generated invoice document.

implNote The asciidoc document is deleted upon creation of the pdf document.

Parameters:

withQrCode - flag if the Swiss QR cde should be added to the invoice document

withEN16931 - flag if the EN16931 digital invoice should be added to the invoice document

pdfa - flag if the pdf document should be generated in pdfa format

overwrite - flag if an existing document should be overwritten

from - optional start of the relevant time interval for the invoiced date

to - optional end of the relevant time interval for the invoiced date

invoiceViewFor

Optional<InvoicesPort.InvoiceView> invoiceViewFor(@NotNull
 @NotNull String id)