EnergyPaymentScheduleDirectDebit (Data Holder 1.22.0 API)

java.lang.Object
- au.org.consumerdatastandards.holder.model.energy.EnergyPaymentScheduleDirectDebit

```
public class EnergyPaymentScheduleDirectDebit
extends Object
```
Represents a regular direct debit from a specified bank account. Mandatory if paymentScheduleUType is set to directDebit

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class EnergyPaymentScheduleDirectDebit.CalculationTypeEnum
The mechanism by which the payment amount is calculated.

Nested Classes
Modifier and Type	Class and Description
`static class`	`EnergyPaymentScheduleDirectDebit.CalculationTypeEnum` The mechanism by which the payment amount is calculated.

Constructor Summary

Constructors
Constructor and Description

EnergyPaymentScheduleDirectDebit()

Constructors
Constructor and Description
`EnergyPaymentScheduleDirectDebit()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EnergyPaymentScheduleDirectDebit`	`accountNumber(String accountNumber)`
`EnergyPaymentScheduleDirectDebit`	`bsb(String bsb)`
`EnergyPaymentScheduleDirectDebit`	`calculationType(EnergyPaymentScheduleDirectDebit.CalculationTypeEnum calculationType)`
`boolean`	`equals(Object o)`
`String`	`getAccountNumber()` The unmasked account number for the account to be debited.
`String`	`getBsb()` The unmasked BSB for the account to be debited.
`@NotNull EnergyPaymentScheduleDirectDebit.CalculationTypeEnum`	`getCalculationType()` The mechanism by which the payment amount is calculated.
`boolean`	`getIsTokenised()` Flag indicating that the account details are tokenised and cannot be shared.
`@NotNull String`	`getPaymentFrequency()` The frequency that payments will occur.
`int`	`hashCode()`
`EnergyPaymentScheduleDirectDebit`	`isTokenised(boolean isTokenised)`
`EnergyPaymentScheduleDirectDebit`	`paymentFrequency(String paymentFrequency)`
`void`	`setAccountNumber(String accountNumber)`
`void`	`setBsb(String bsb)`
`void`	`setCalculationType(EnergyPaymentScheduleDirectDebit.CalculationTypeEnum calculationType)`
`void`	`setIsTokenised(boolean isTokenised)`
`void`	`setPaymentFrequency(String paymentFrequency)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EnergyPaymentScheduleDirectDebit
```
public EnergyPaymentScheduleDirectDebit()
```
- Method Detail
  - isTokenised
```
public EnergyPaymentScheduleDirectDebit isTokenised(boolean isTokenised)
```
  - getIsTokenised
```
public boolean getIsTokenised()
```
    Flag indicating that the account details are tokenised and cannot be shared. False if absent
    
    Returns:
    
    isTokenised
  - setIsTokenised
```
public void setIsTokenised(boolean isTokenised)
```
  - bsb
```
public EnergyPaymentScheduleDirectDebit bsb(String bsb)
```
  - getBsb
```
public String getBsb()
```
    The unmasked BSB for the account to be debited. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces. Is required if isTokenised is absent or false
    
    Returns:
    
    bsb
  - setBsb
```
public void setBsb(String bsb)
```
  - accountNumber
```
public EnergyPaymentScheduleDirectDebit accountNumber(String accountNumber)
```
  - getAccountNumber
```
public String getAccountNumber()
```
    The unmasked account number for the account to be debited. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces. Is required if isTokenised is absent or false
    
    Returns:
    
    accountNumber
  - setAccountNumber
```
public void setAccountNumber(String accountNumber)
```
  - paymentFrequency
```
public EnergyPaymentScheduleDirectDebit paymentFrequency(String paymentFrequency)
```
  - getPaymentFrequency
```
@NotNull
public @NotNull String getPaymentFrequency()
```
    The frequency that payments will occur. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)
    
    Returns:
    
    paymentFrequency
  - setPaymentFrequency
```
public void setPaymentFrequency(String paymentFrequency)
```
  - calculationType
```
public EnergyPaymentScheduleDirectDebit calculationType(EnergyPaymentScheduleDirectDebit.CalculationTypeEnum calculationType)
```
  - getCalculationType
```
@NotNull
public @NotNull EnergyPaymentScheduleDirectDebit.CalculationTypeEnum getCalculationType()
```
    The mechanism by which the payment amount is calculated. Explanation of values are as follows:
    - **STATIC** - Indicates a consistent, static amount, per payment
    - **BALANCE** - Indicates that the outstanding balance for the account is paid per period
    - **CALCULATED** - Indicates that the payment amount is variable and calculated using a pre-defined algorithm
    Returns:
    
    calculationType
  - setCalculationType
```
public void setCalculationType(EnergyPaymentScheduleDirectDebit.CalculationTypeEnum calculationType)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class EnergyPaymentScheduleDirectDebit

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EnergyPaymentScheduleDirectDebit

Method Detail

isTokenised

getIsTokenised

setIsTokenised

bsb

getBsb

setBsb

accountNumber

getAccountNumber

setAccountNumber

paymentFrequency

getPaymentFrequency

setPaymentFrequency

calculationType

getCalculationType

setCalculationType

equals

hashCode

toString