/
BillingEvent.java
110 lines (90 loc) · 2.91 KB
/
BillingEvent.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
/*
* Copyright 2010-2011 Ning, Inc.
*
* Ning licenses this file to you under the Apache License, version 2.0
* (the "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
package org.killbill.billing.junction;
import java.math.BigDecimal;
import java.util.List;
import org.joda.time.DateTime;
import org.joda.time.DateTimeZone;
import org.killbill.billing.account.api.Account;
import org.killbill.billing.catalog.api.BillingMode;
import org.killbill.billing.catalog.api.BillingPeriod;
import org.killbill.billing.catalog.api.Currency;
import org.killbill.billing.catalog.api.Plan;
import org.killbill.billing.catalog.api.PlanPhase;
import org.killbill.billing.catalog.api.Usage;
import org.killbill.billing.subscription.api.SubscriptionBaseTransitionType;
import org.killbill.billing.subscription.api.SubscriptionBase;
public interface BillingEvent extends Comparable<BillingEvent> {
/**
* @return the billCycleDay in the account timezone as seen for that subscription at that time
* <p/>
* Note: The billCycleDay may come from the Account, or the bundle or the subscription itself
*/
int getBillCycleDayLocal();
/**
* @return the subscription
*/
SubscriptionBase getSubscription();
/**
* @return the date for when that event became effective
*/
DateTime getEffectiveDate();
/**
* @return the plan phase
*/
PlanPhase getPlanPhase();
/**
* @return the plan
*/
Plan getPlan();
/**
* @return the billing period for the active phase
*/
BillingPeriod getBillingPeriod();
/**
* @return the description of the billing event
*/
String getDescription();
/**
* @return the fixed price for the phase
*/
BigDecimal getFixedPrice();
/**
* @return the recurring price for the phase
*/
BigDecimal getRecurringPrice();
/**
* @return the currency for the account being invoiced
*/
Currency getCurrency();
/**
* @return the transition type of the underlying subscription event that triggered this
*/
SubscriptionBaseTransitionType getTransitionType();
/**
* @return a unique long indicating the ordering on which events got inserted on disk-- used for sorting only
*/
Long getTotalOrdering();
/**
* @return the TimeZone of the account
*/
DateTimeZone getTimeZone();
/**
*
* @return the list of {@code Usage} section
*/
List<Usage> getUsages();
}