Skip to content

Commit 1df5c48

Browse files
committed
Added JavaDocs
1 parent 9a6a1c4 commit 1df5c48

File tree

2 files changed

+61
-2
lines changed

2 files changed

+61
-2
lines changed

bzst-dip-java-client/src/main/java/software/xdev/bzst/dip/client/model/configuration/BzstDipConfiguration.java

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,48 @@ public enum SupportedApplicationCode
5959
}
6060

6161

62+
/**
63+
* Country Code. {@link BzstDipCountryCode}
64+
*/
6265
private final BzstDipCountryCode transmittingCountry;
66+
67+
/**
68+
* The element declares the type of message such as
69+
* Payment data or validation result {@link BzstCesopMessageTypeEnum}
70+
*/
6371
private final BzstCesopMessageTypeEnum messageType;
72+
73+
/**
74+
* Contains a unique identifier for the message in the form of a UUID version 4
75+
*/
6476
private final String messageRefId;
77+
78+
/**
79+
* Stands for the year to which the payment data relates
80+
*/
6581
private final String reportingPeriodCesopYear;
82+
83+
/**
84+
* Stands for the quarter to which the payment data relates
85+
*/
6686
private final int reportingPeriodCesopQuarter;
87+
88+
/**
89+
* The exact date and time at which the PSP generated the message
90+
*/
6791
private final ZonedDateTime timestamp;
92+
93+
/**
94+
* Indicates whether the message contains new data, corrections/deletions to previously sent data or whether no
95+
* data is to be reported
96+
* {@link BzstCesopMessageTypeIndicEnum}
97+
*/
6898
private final BzstCesopMessageTypeIndicEnum messageTypeIndicEnum;
6999

100+
/**
101+
* Describes if the format is DAC7 or CESOP.
102+
* {@link SupportedApplicationCode}
103+
*/
70104
private final String applicationCode;
71105

72106
/**

bzst-dip-java-client/src/main/java/software/xdev/bzst/dip/client/model/configuration/BzstDipConfigurationBuilder.java

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424
import software.xdev.bzst.dip.client.exception.PropertyNotSetException;
2525
import software.xdev.bzst.dip.client.model.message.cesop.BzstCesopMessageTypeEnum;
2626
import software.xdev.bzst.dip.client.model.message.cesop.BzstCesopMessageTypeIndicEnum;
27-
import software.xdev.bzst.dip.client.model.message.cesop.BzstCesopReportingPeriod;
2827
import software.xdev.bzst.dip.client.model.message.dac7.BzstDipAddressFix;
2928
import software.xdev.bzst.dip.client.model.message.dac7.BzstDipCountryCode;
3029

@@ -125,13 +124,39 @@ public class BzstDipConfigurationBuilder
125124
*/
126125
private BzstDipConfiguration.SupportedApplicationCode applicationCode;
127126

127+
/**
128+
* @see BzstDipConfiguration#getTransmittingCountry()
129+
*/
128130
private BzstDipCountryCode transmittingCountry;
131+
132+
/**
133+
* @see BzstDipConfiguration#getMessageType()
134+
*/
129135
private BzstCesopMessageTypeEnum messageType;
136+
137+
/**
138+
* @see BzstDipConfiguration#getMessageRefId()
139+
*/
130140
private String messageRefId;
131-
private BzstCesopReportingPeriod reportingPeriodCESOP;
141+
142+
/**
143+
* @see BzstDipConfiguration#getTimestamp()
144+
*/
132145
private ZonedDateTime timestamp;
146+
147+
/**
148+
* @see BzstDipConfiguration#getReportingPeriodCesopQuarter()
149+
*/
133150
private int reportingPeriodCesopQuarter;
151+
152+
/**
153+
* @see BzstDipConfiguration#getReportingPeriodCesopYear()
154+
*/
134155
private String reportingPeriodCesopYear;
156+
157+
/**
158+
* @see BzstDipConfiguration#getMessageTypeIndicEnum()
159+
*/
135160
private BzstCesopMessageTypeIndicEnum messageTypeIndicCesop;
136161

137162
public void setRetryQueryResultsAmount(final Integer retryQueryResultsAmount)

0 commit comments

Comments
 (0)