/
CommerceCurrencyModel.java
581 lines (497 loc) · 16.6 KB
/
CommerceCurrencyModel.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
/**
* SPDX-FileCopyrightText: (c) 2000 Liferay, Inc. https://liferay.com
* SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
*/
package com.liferay.commerce.currency.model;
import com.liferay.portal.kernel.bean.AutoEscape;
import com.liferay.portal.kernel.exception.LocaleException;
import com.liferay.portal.kernel.model.BaseModel;
import com.liferay.portal.kernel.model.LocalizedModel;
import com.liferay.portal.kernel.model.MVCCModel;
import com.liferay.portal.kernel.model.ShardedModel;
import com.liferay.portal.kernel.model.StagedAuditedModel;
import java.math.BigDecimal;
import java.util.Date;
import java.util.Locale;
import java.util.Map;
import org.osgi.annotation.versioning.ProviderType;
/**
* The base model interface for the CommerceCurrency service. Represents a row in the "CommerceCurrency" database table, with each column mapped to a property of this class.
*
* <p>
* This interface and its corresponding implementation <code>com.liferay.commerce.currency.model.impl.CommerceCurrencyModelImpl</code> exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in <code>com.liferay.commerce.currency.model.impl.CommerceCurrencyImpl</code>.
* </p>
*
* @author Andrea Di Giorgi
* @see CommerceCurrency
* @generated
*/
@ProviderType
public interface CommerceCurrencyModel
extends BaseModel<CommerceCurrency>, LocalizedModel, MVCCModel,
ShardedModel, StagedAuditedModel {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. All methods that expect a commerce currency model instance should use the {@link CommerceCurrency} interface instead.
*/
/**
* Returns the primary key of this commerce currency.
*
* @return the primary key of this commerce currency
*/
public long getPrimaryKey();
/**
* Sets the primary key of this commerce currency.
*
* @param primaryKey the primary key of this commerce currency
*/
public void setPrimaryKey(long primaryKey);
/**
* Returns the mvcc version of this commerce currency.
*
* @return the mvcc version of this commerce currency
*/
@Override
public long getMvccVersion();
/**
* Sets the mvcc version of this commerce currency.
*
* @param mvccVersion the mvcc version of this commerce currency
*/
@Override
public void setMvccVersion(long mvccVersion);
/**
* Returns the uuid of this commerce currency.
*
* @return the uuid of this commerce currency
*/
@AutoEscape
@Override
public String getUuid();
/**
* Sets the uuid of this commerce currency.
*
* @param uuid the uuid of this commerce currency
*/
@Override
public void setUuid(String uuid);
/**
* Returns the commerce currency ID of this commerce currency.
*
* @return the commerce currency ID of this commerce currency
*/
public long getCommerceCurrencyId();
/**
* Sets the commerce currency ID of this commerce currency.
*
* @param commerceCurrencyId the commerce currency ID of this commerce currency
*/
public void setCommerceCurrencyId(long commerceCurrencyId);
/**
* Returns the company ID of this commerce currency.
*
* @return the company ID of this commerce currency
*/
@Override
public long getCompanyId();
/**
* Sets the company ID of this commerce currency.
*
* @param companyId the company ID of this commerce currency
*/
@Override
public void setCompanyId(long companyId);
/**
* Returns the user ID of this commerce currency.
*
* @return the user ID of this commerce currency
*/
@Override
public long getUserId();
/**
* Sets the user ID of this commerce currency.
*
* @param userId the user ID of this commerce currency
*/
@Override
public void setUserId(long userId);
/**
* Returns the user uuid of this commerce currency.
*
* @return the user uuid of this commerce currency
*/
@Override
public String getUserUuid();
/**
* Sets the user uuid of this commerce currency.
*
* @param userUuid the user uuid of this commerce currency
*/
@Override
public void setUserUuid(String userUuid);
/**
* Returns the user name of this commerce currency.
*
* @return the user name of this commerce currency
*/
@AutoEscape
@Override
public String getUserName();
/**
* Sets the user name of this commerce currency.
*
* @param userName the user name of this commerce currency
*/
@Override
public void setUserName(String userName);
/**
* Returns the create date of this commerce currency.
*
* @return the create date of this commerce currency
*/
@Override
public Date getCreateDate();
/**
* Sets the create date of this commerce currency.
*
* @param createDate the create date of this commerce currency
*/
@Override
public void setCreateDate(Date createDate);
/**
* Returns the modified date of this commerce currency.
*
* @return the modified date of this commerce currency
*/
@Override
public Date getModifiedDate();
/**
* Sets the modified date of this commerce currency.
*
* @param modifiedDate the modified date of this commerce currency
*/
@Override
public void setModifiedDate(Date modifiedDate);
/**
* Returns the code of this commerce currency.
*
* @return the code of this commerce currency
*/
@AutoEscape
public String getCode();
/**
* Sets the code of this commerce currency.
*
* @param code the code of this commerce currency
*/
public void setCode(String code);
/**
* Returns the name of this commerce currency.
*
* @return the name of this commerce currency
*/
public String getName();
/**
* Returns the localized name of this commerce currency in the language. Uses the default language if no localization exists for the requested language.
*
* @param locale the locale of the language
* @return the localized name of this commerce currency
*/
@AutoEscape
public String getName(Locale locale);
/**
* Returns the localized name of this commerce currency in the language, optionally using the default language if no localization exists for the requested language.
*
* @param locale the local of the language
* @param useDefault whether to use the default language if no localization exists for the requested language
* @return the localized name of this commerce currency. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned.
*/
@AutoEscape
public String getName(Locale locale, boolean useDefault);
/**
* Returns the localized name of this commerce currency in the language. Uses the default language if no localization exists for the requested language.
*
* @param languageId the ID of the language
* @return the localized name of this commerce currency
*/
@AutoEscape
public String getName(String languageId);
/**
* Returns the localized name of this commerce currency in the language, optionally using the default language if no localization exists for the requested language.
*
* @param languageId the ID of the language
* @param useDefault whether to use the default language if no localization exists for the requested language
* @return the localized name of this commerce currency
*/
@AutoEscape
public String getName(String languageId, boolean useDefault);
@AutoEscape
public String getNameCurrentLanguageId();
@AutoEscape
public String getNameCurrentValue();
/**
* Returns a map of the locales and localized names of this commerce currency.
*
* @return the locales and localized names of this commerce currency
*/
public Map<Locale, String> getNameMap();
/**
* Sets the name of this commerce currency.
*
* @param name the name of this commerce currency
*/
public void setName(String name);
/**
* Sets the localized name of this commerce currency in the language.
*
* @param name the localized name of this commerce currency
* @param locale the locale of the language
*/
public void setName(String name, Locale locale);
/**
* Sets the localized name of this commerce currency in the language, and sets the default locale.
*
* @param name the localized name of this commerce currency
* @param locale the locale of the language
* @param defaultLocale the default locale
*/
public void setName(String name, Locale locale, Locale defaultLocale);
public void setNameCurrentLanguageId(String languageId);
/**
* Sets the localized names of this commerce currency from the map of locales and localized names.
*
* @param nameMap the locales and localized names of this commerce currency
*/
public void setNameMap(Map<Locale, String> nameMap);
/**
* Sets the localized names of this commerce currency from the map of locales and localized names, and sets the default locale.
*
* @param nameMap the locales and localized names of this commerce currency
* @param defaultLocale the default locale
*/
public void setNameMap(Map<Locale, String> nameMap, Locale defaultLocale);
/**
* Returns the symbol of this commerce currency.
*
* @return the symbol of this commerce currency
*/
@AutoEscape
public String getSymbol();
/**
* Sets the symbol of this commerce currency.
*
* @param symbol the symbol of this commerce currency
*/
public void setSymbol(String symbol);
/**
* Returns the rate of this commerce currency.
*
* @return the rate of this commerce currency
*/
public BigDecimal getRate();
/**
* Sets the rate of this commerce currency.
*
* @param rate the rate of this commerce currency
*/
public void setRate(BigDecimal rate);
/**
* Returns the format pattern of this commerce currency.
*
* @return the format pattern of this commerce currency
*/
public String getFormatPattern();
/**
* Returns the localized format pattern of this commerce currency in the language. Uses the default language if no localization exists for the requested language.
*
* @param locale the locale of the language
* @return the localized format pattern of this commerce currency
*/
@AutoEscape
public String getFormatPattern(Locale locale);
/**
* Returns the localized format pattern of this commerce currency in the language, optionally using the default language if no localization exists for the requested language.
*
* @param locale the local of the language
* @param useDefault whether to use the default language if no localization exists for the requested language
* @return the localized format pattern of this commerce currency. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned.
*/
@AutoEscape
public String getFormatPattern(Locale locale, boolean useDefault);
/**
* Returns the localized format pattern of this commerce currency in the language. Uses the default language if no localization exists for the requested language.
*
* @param languageId the ID of the language
* @return the localized format pattern of this commerce currency
*/
@AutoEscape
public String getFormatPattern(String languageId);
/**
* Returns the localized format pattern of this commerce currency in the language, optionally using the default language if no localization exists for the requested language.
*
* @param languageId the ID of the language
* @param useDefault whether to use the default language if no localization exists for the requested language
* @return the localized format pattern of this commerce currency
*/
@AutoEscape
public String getFormatPattern(String languageId, boolean useDefault);
@AutoEscape
public String getFormatPatternCurrentLanguageId();
@AutoEscape
public String getFormatPatternCurrentValue();
/**
* Returns a map of the locales and localized format patterns of this commerce currency.
*
* @return the locales and localized format patterns of this commerce currency
*/
public Map<Locale, String> getFormatPatternMap();
/**
* Sets the format pattern of this commerce currency.
*
* @param formatPattern the format pattern of this commerce currency
*/
public void setFormatPattern(String formatPattern);
/**
* Sets the localized format pattern of this commerce currency in the language.
*
* @param formatPattern the localized format pattern of this commerce currency
* @param locale the locale of the language
*/
public void setFormatPattern(String formatPattern, Locale locale);
/**
* Sets the localized format pattern of this commerce currency in the language, and sets the default locale.
*
* @param formatPattern the localized format pattern of this commerce currency
* @param locale the locale of the language
* @param defaultLocale the default locale
*/
public void setFormatPattern(
String formatPattern, Locale locale, Locale defaultLocale);
public void setFormatPatternCurrentLanguageId(String languageId);
/**
* Sets the localized format patterns of this commerce currency from the map of locales and localized format patterns.
*
* @param formatPatternMap the locales and localized format patterns of this commerce currency
*/
public void setFormatPatternMap(Map<Locale, String> formatPatternMap);
/**
* Sets the localized format patterns of this commerce currency from the map of locales and localized format patterns, and sets the default locale.
*
* @param formatPatternMap the locales and localized format patterns of this commerce currency
* @param defaultLocale the default locale
*/
public void setFormatPatternMap(
Map<Locale, String> formatPatternMap, Locale defaultLocale);
/**
* Returns the max fraction digits of this commerce currency.
*
* @return the max fraction digits of this commerce currency
*/
public int getMaxFractionDigits();
/**
* Sets the max fraction digits of this commerce currency.
*
* @param maxFractionDigits the max fraction digits of this commerce currency
*/
public void setMaxFractionDigits(int maxFractionDigits);
/**
* Returns the min fraction digits of this commerce currency.
*
* @return the min fraction digits of this commerce currency
*/
public int getMinFractionDigits();
/**
* Sets the min fraction digits of this commerce currency.
*
* @param minFractionDigits the min fraction digits of this commerce currency
*/
public void setMinFractionDigits(int minFractionDigits);
/**
* Returns the rounding mode of this commerce currency.
*
* @return the rounding mode of this commerce currency
*/
@AutoEscape
public String getRoundingMode();
/**
* Sets the rounding mode of this commerce currency.
*
* @param roundingMode the rounding mode of this commerce currency
*/
public void setRoundingMode(String roundingMode);
/**
* Returns the primary of this commerce currency.
*
* @return the primary of this commerce currency
*/
public boolean getPrimary();
/**
* Returns <code>true</code> if this commerce currency is primary.
*
* @return <code>true</code> if this commerce currency is primary; <code>false</code> otherwise
*/
public boolean isPrimary();
/**
* Sets whether this commerce currency is primary.
*
* @param primary the primary of this commerce currency
*/
public void setPrimary(boolean primary);
/**
* Returns the priority of this commerce currency.
*
* @return the priority of this commerce currency
*/
public double getPriority();
/**
* Sets the priority of this commerce currency.
*
* @param priority the priority of this commerce currency
*/
public void setPriority(double priority);
/**
* Returns the active of this commerce currency.
*
* @return the active of this commerce currency
*/
public boolean getActive();
/**
* Returns <code>true</code> if this commerce currency is active.
*
* @return <code>true</code> if this commerce currency is active; <code>false</code> otherwise
*/
public boolean isActive();
/**
* Sets whether this commerce currency is active.
*
* @param active the active of this commerce currency
*/
public void setActive(boolean active);
/**
* Returns the last publish date of this commerce currency.
*
* @return the last publish date of this commerce currency
*/
public Date getLastPublishDate();
/**
* Sets the last publish date of this commerce currency.
*
* @param lastPublishDate the last publish date of this commerce currency
*/
public void setLastPublishDate(Date lastPublishDate);
@Override
public String[] getAvailableLanguageIds();
@Override
public String getDefaultLanguageId();
@Override
public void prepareLocalizedFieldsForImport() throws LocaleException;
@Override
public void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
throws LocaleException;
@Override
public CommerceCurrency cloneWithOriginalValues();
public default String toXmlString() {
return null;
}
}