io.konik.zugferd.entity

Class SpecifiedAllowanceCharge

java.lang.Object

io.konik.zugferd.entity.SpecifiedAllowanceCharge

All Implemented Interfaces:

CommonAllowanceCharge, java.io.Serializable

public class SpecifiedAllowanceCharge
extends java.lang.Object
implements CommonAllowanceCharge

The Specified Allowance Charge.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SpecifiedAllowanceCharge() Instantiates a new allowance charge.

Method Summary

Modifier and Type	Method and Description
Amount	getActual() Gets the actual amount.
Amount	getBasis() Gets the basis amount of the allowance charge.
Quantity	getBasisQuantity() Gets the basis quantity.
java.math.BigDecimal	getCalculationPercent() Gets the calculation percent of the allowance charge
AppliedTax	getCategory() Gets the category.
java.lang.String	getReason() Gets the reason free text
java.lang.String	getReasonCode() Gets the reason code for the reason content.
java.math.BigDecimal	getSequence() Gets the sequence number of the allowance charge
boolean	isDiscount() Checks if is discount.
boolean	isSurcharge() Checks if is a surcharge.
SpecifiedAllowanceCharge	setActual(Amount actualAmount) Sets the actual amount.
SpecifiedAllowanceCharge	setBasis(Amount basisAmount) Sets the basis amount of the allowance charge.
SpecifiedAllowanceCharge	setBasisQuantity(Quantity basisQuantity) Sets the basis quantity.
SpecifiedAllowanceCharge	setCalculationPercent(java.math.BigDecimal calculationPercent) Sets the calculation percent of the allowance charge.
SpecifiedAllowanceCharge	setCategory(AppliedTax category) Sets the category.
SpecifiedAllowanceCharge	setDiscount() Sets the amount to be a discount.
SpecifiedAllowanceCharge	setReason(java.lang.String reason) Sets the reason free text
SpecifiedAllowanceCharge	setReasonCode(java.lang.String reasonCode) Sets the reason code for the reason content.
SpecifiedAllowanceCharge	setSequence(java.math.BigDecimal sequence) Sets the sequence number of the allowance charge.
SpecifiedAllowanceCharge	setSurcharge() Sets amount to be a surcharge.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpecifiedAllowanceCharge

public SpecifiedAllowanceCharge()

Instantiates a new allowance charge.

Method Detail

getActual

@NotNull(groups=Comfort.class)
public Amount getActual()

Gets the actual amount.

Specified by:

getActual in interface CommonAllowanceCharge

Returns:

the actual amount

getBasis

@Extended
public Amount getBasis()

Gets the basis amount of the allowance charge.

Specified by:

getBasis in interface CommonAllowanceCharge

Returns:

the basis amount

getBasisQuantity

@Extended
public Quantity getBasisQuantity()

Gets the basis quantity.

Specified by:

getBasisQuantity in interface CommonAllowanceCharge

Returns:

the basis quantity

getCalculationPercent

@Extended
public java.math.BigDecimal getCalculationPercent()

Gets the calculation percent of the allowance charge

Specified by:

getCalculationPercent in interface CommonAllowanceCharge

Returns:

the calculation percent

getCategory

@Comfort
public AppliedTax getCategory()

Gets the category.

Returns:

the category

getReason

@Comfort
public java.lang.String getReason()

Gets the reason free text

Specified by:

getReason in interface CommonAllowanceCharge

Returns:

the reason

getReasonCode

@Extended
public java.lang.String getReasonCode()

Gets the reason code for the reason content.

Specified by:

getReasonCode in interface CommonAllowanceCharge

Returns:

the reason code

getSequence

@Extended
public java.math.BigDecimal getSequence()

Gets the sequence number of the allowance charge

Specified by:

getSequence in interface CommonAllowanceCharge

Returns:

the sequence

isDiscount

@NotNull(groups=Comfort.class)
public boolean isDiscount()

Checks if is discount.

Specified by:

isDiscount in interface CommonAllowanceCharge

Returns:

true if is discount

isSurcharge

@NotNull(groups=Comfort.class)
public boolean isSurcharge()

Checks if is a surcharge.

Specified by:

isSurcharge in interface CommonAllowanceCharge

Returns:

true if charge

setActual

public SpecifiedAllowanceCharge setActual(Amount actualAmount)

Sets the actual amount.

Specified by:

setActual in interface CommonAllowanceCharge

Parameters:

actualAmount - the new actual amount

Returns:

the allowance charge

setBasis

public SpecifiedAllowanceCharge setBasis(Amount basisAmount)

Sets the basis amount of the allowance charge.

Specified by:

setBasis in interface CommonAllowanceCharge

Parameters:

basisAmount - the new basis amount

Returns:

the allowance charge

setBasisQuantity

public SpecifiedAllowanceCharge setBasisQuantity(Quantity basisQuantity)

Sets the basis quantity.

Specified by:

setBasisQuantity in interface CommonAllowanceCharge

Parameters:

basisQuantity - the new basis quantity

Returns:

the allowance charge

setCalculationPercent

public SpecifiedAllowanceCharge setCalculationPercent(java.math.BigDecimal calculationPercent)

Sets the calculation percent of the allowance charge.

Specified by:

setCalculationPercent in interface CommonAllowanceCharge

Parameters:

calculationPercent - the new calculation percent

Returns:

the allowance charge

setCategory

public SpecifiedAllowanceCharge setCategory(AppliedTax category)

Sets the category.

Parameters:

category - the new category

Returns:

the allowance charge

setDiscount

public SpecifiedAllowanceCharge setDiscount()

Sets the amount to be a discount.

Specified by:

setDiscount in interface CommonAllowanceCharge

Returns:

the allowance discount to be true

setReason

public SpecifiedAllowanceCharge setReason(java.lang.String reason)

Sets the reason free text

Specified by:

setReason in interface CommonAllowanceCharge

Parameters:

reason - the new reason

Returns:

the allowance charge

setReasonCode

public SpecifiedAllowanceCharge setReasonCode(java.lang.String reasonCode)

Sets the reason code for the reason content.

Specified by:

setReasonCode in interface CommonAllowanceCharge

Parameters:

reasonCode - the new reason code

Returns:

the allowance charge

setSequence

public SpecifiedAllowanceCharge setSequence(java.math.BigDecimal sequence)

Sets the sequence number of the allowance charge.

Specified by:

setSequence in interface CommonAllowanceCharge

Parameters:

sequence - the new sequence

Returns:

the allowance charge

setSurcharge

public SpecifiedAllowanceCharge setSurcharge()

Sets amount to be a surcharge.

Specified by:

setSurcharge in interface CommonAllowanceCharge

Returns:

the allowance charge to be true