io.konik.zugferd.entity

Class Context

java.lang.Object

io.konik.zugferd.entity.Context

All Implemented Interfaces:

java.io.Serializable

public class Context
extends java.lang.Object
implements java.io.Serializable

The Exchanged Document Context

Grouping of the properties of the message.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Context() Instantiates a new context.
Context(ConformanceLevel conformanceLevel) Instantiates a new context with a latest ZUGFeRD profile version.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBusinessProcess() Gets the business process.
Profile	getGuideline() Gets the guideline or profile of the invoice
boolean	isTest() Checks if that invoice is for test purposes only and should not be processed in the target system.
Context	setBusinessProcess(java.lang.String businessProcess) Sets the business process.
Context	setGuideline(Profile guideline) Sets the guideline or profile of the invoice
Context	setNotTest() Flags the invoice such that it should be processed in the target system.
Context	setTest() Flags the invoice such that it should not be processed in the target system.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Context

public Context()

Instantiates a new context.

Context

public Context(ConformanceLevel conformanceLevel)

Instantiates a new context with a latest ZUGFeRD profile version.

Parameters:

conformanceLevel - the profile

Method Detail

getBusinessProcess

@Extended
public java.lang.String getBusinessProcess()

Gets the business process.

Example

production Materials, other Materials, freight Invoices

Returns:

the business process

getGuideline

@Basic
 @NotNull
public Profile getGuideline()

Gets the guideline or profile of the invoice

Example

urn:ferd:CrossIndustryDocument:invoice:1p0:extended

Returns:

the profile

isTest

@Basic
public boolean isTest()

Checks if that invoice is for test purposes only and should not be processed in the target system.

Default

false

Returns:

true if this invoice is for testing purpose only

setBusinessProcess

public Context setBusinessProcess(java.lang.String businessProcess)

Sets the business process.

Example

production Materials, other Materials, freight Invoices

Parameters:

businessProcess - the new business process

Returns:

the context

setGuideline

public Context setGuideline(Profile guideline)

Sets the guideline or profile of the invoice

Example

urn:ferd:CrossIndustryDocument:invoice:1p0:extended

Parameters:

guideline - the new profile

Returns:

the context

setNotTest

public Context setNotTest()

Flags the invoice such that it should be processed in the target system.

The sales tax liability does arise. This flag is used in particular in the introductory period of new business relationships.

Default

false

Returns:

the context

setTest

public Context setTest()

Flags the invoice such that it should not be processed in the target system. The sales tax liability does NOT arise. This flag is used in particular in the introductory period of new business relationships.

Default

false

Returns:

the context