io.konik.zugferd.entity

Interface CommonAllowanceCharge

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AllowanceCharge, SpecifiedAllowanceCharge

public interface CommonAllowanceCharge
extends java.io.Serializable

The common interface for the Allowance Charges.

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
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.
CommonAllowanceCharge	setActual(Amount actualAmount) Sets the actual amount.
CommonAllowanceCharge	setBasis(Amount basisAmount) Sets the basis amount of the allowance charge.
CommonAllowanceCharge	setBasisQuantity(Quantity basisQuantity) Sets the basis quantity.
CommonAllowanceCharge	setCalculationPercent(java.math.BigDecimal calculationPercent) Sets the calculation percent of the allowance charge.
CommonAllowanceCharge	setDiscount() Sets the amount to be a discount.
CommonAllowanceCharge	setReason(java.lang.String reason) Sets the reason free text
CommonAllowanceCharge	setReasonCode(java.lang.String reasonCode) Sets the reason code for the reason content.
CommonAllowanceCharge	setSequence(java.math.BigDecimal sequence) Sets the sequence number of the allowance charge.
CommonAllowanceCharge	setSurcharge() Sets amount to be a surcharge.

Method Detail

getActual

Amount getActual()

Gets the actual amount.

Returns:

the actual amount

getBasis

Amount getBasis()

Gets the basis amount of the allowance charge.

Returns:

the basis amount

getBasisQuantity

Quantity getBasisQuantity()

Gets the basis quantity.

Returns:

the basis quantity

getCalculationPercent

java.math.BigDecimal getCalculationPercent()

Gets the calculation percent of the allowance charge

Returns:

the calculation percent

getReason

java.lang.String getReason()

Gets the reason free text

Returns:

the reason

getReasonCode

java.lang.String getReasonCode()

Gets the reason code for the reason content.

Returns:

the reason code

getSequence

java.math.BigDecimal getSequence()

Gets the sequence number of the allowance charge

Returns:

the sequence

isDiscount

boolean isDiscount()

Checks if is discount.

Returns:

true if is discount

isSurcharge

boolean isSurcharge()

Checks if is a surcharge.

Returns:

true if charge

setActual

CommonAllowanceCharge setActual(Amount actualAmount)

Sets the actual amount.

Parameters:

actualAmount - the new actual amount

Returns:

the allowance charge

setBasis

CommonAllowanceCharge setBasis(Amount basisAmount)

Sets the basis amount of the allowance charge.

Parameters:

basisAmount - the new basis amount

Returns:

the allowance charge

setBasisQuantity

CommonAllowanceCharge setBasisQuantity(Quantity basisQuantity)

Sets the basis quantity.

Parameters:

basisQuantity - the new basis quantity

Returns:

the allowance charge

setCalculationPercent

CommonAllowanceCharge setCalculationPercent(java.math.BigDecimal calculationPercent)

Sets the calculation percent of the allowance charge.

Parameters:

calculationPercent - the new calculation percent

Returns:

the allowance charge

setDiscount

CommonAllowanceCharge setDiscount()

Sets the amount to be a discount.

Returns:

the allowance discount to be true

setReason

CommonAllowanceCharge setReason(java.lang.String reason)

Sets the reason free text

Parameters:

reason - the new reason

Returns:

the allowance charge

setReasonCode

CommonAllowanceCharge setReasonCode(java.lang.String reasonCode)

Sets the reason code for the reason content.

Parameters:

reasonCode - the new reason code

Returns:

the allowance charge

setSequence

CommonAllowanceCharge setSequence(java.math.BigDecimal sequence)

Sets the sequence number of the allowance charge.

Parameters:

sequence - the new sequence

Returns:

the allowance charge

setSurcharge

CommonAllowanceCharge setSurcharge()

Sets amount to be a surcharge.

Returns:

the allowance charge to be true