UsagePeriod (billforward-java 1.2014.257 API)

java.lang.Object
- net.billforward.model.BillingEntity
- - net.billforward.model.usage.UsagePeriod

public class UsagePeriod
extends BillingEntity

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`durationResolution`
`protected String`	`id`
`protected String`	`invoiceID`
`protected String`	`organizationID`
`protected int`	`period`
`protected static ResourcePath`	`resourcePath`
`protected String`	`sessiondID`
`protected Date`	`start`
`protected Date`	`state`
`protected String`	`stop`
`protected String`	`subscriptionID`
`protected String`	`uom`
`protected String`	`usageDuration`
`protected String`	`usageType`
`protected long`	`usageValue`

Fields inherited from class net.billforward.model.BillingEntity
m_client, PRETTY_PRINT_GSON

Constructor Summary

Constructors
Modifier Constructor and Description

protected UsagePeriod()

UsagePeriod(BillForwardClient client_)

Constructors
Modifier	Constructor and Description
`protected`	`UsagePeriod()`
	`UsagePeriod(BillForwardClient client_)`

Method Summary

Methods
Modifier and Type	Method and Description
`DurationResolution`	`getDurationResolution()`
`String`	`getDurationResolutionAsString()`
`String`	`getID()`
`String`	`getInvoiceID()`
`String`	`getOrganizationID()`
`int`	`getPeriod()`
`protected ResourcePath`	`getResourcePath()`
`String`	`getSessiondID()`
`Date`	`getStart()`
`Date`	`getState()`
`String`	`getStop()`
`String`	`getSubscriptionID()`
`String`	`getUom()`
`String`	`getUsageDuration()`
`static UsagePeriod[]`	`getUsagePeriodsForInvoice(String subscriptionID_, String invoiceID_)`
`static UsagePeriod[]`	`getUsagePeriodsForSubscription(String subscriptionID_)`
`static UsagePeriod[]`	`getUsagePeriodsForSubscriptionPeriod(String subscriptionID_, int period_)`
`UsageType`	`getUsageType()`
`String`	`getUsageTypeAsString()`
`long`	`getUsageValue()`
`protected static ResourcePath`	`ResourcePath()`

Methods inherited from class net.billforward.model.BillingEntity
getAll, getByID, getByID, getByIDPostPath, getClient, setClient, toString

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

Field Detail

id
```
protected String id
```

organizationID
```
protected String organizationID
```

sessiondID
```
protected String sessiondID
```

subscriptionID
```
protected String subscriptionID
```

uom
```
protected String uom
```

invoiceID
```
protected String invoiceID
```

state
```
protected Date state
```

period
```
protected int period
```

start
```
protected Date start
```

stop
```
protected String stop
```

durationResolution
```
protected String durationResolution
```

usageDuration
```
protected String usageDuration
```

usageValue
```
protected long usageValue
```

usageType
```
protected String usageType
```

resourcePath

protected static ResourcePath resourcePath

Constructor Detail

UsagePeriod

public UsagePeriod(BillForwardClient client_)

UsagePeriod
```
protected UsagePeriod()
```

Method Detail

getID
```
public String getID()
```

getOrganizationID
```
public String getOrganizationID()
```

getSessiondID
```
public String getSessiondID()
```

getSubscriptionID
```
public String getSubscriptionID()
```

getUom
```
public String getUom()
```

getInvoiceID
```
public String getInvoiceID()
```

getState
```
public Date getState()
```

getPeriod
```
public int getPeriod()
```

getStart
```
public Date getStart()
```

getStop
```
public String getStop()
```

getDurationResolutionAsString

public String getDurationResolutionAsString()

getDurationResolution

public DurationResolution getDurationResolution()

getUsageDuration
```
public String getUsageDuration()
```

getUsageValue
```
public long getUsageValue()
```

getUsageTypeAsString
```
public String getUsageTypeAsString()
```

getUsageType
```
public UsageType getUsageType()
```

getUsagePeriodsForSubscription

public static UsagePeriod[] getUsagePeriodsForSubscription(String subscriptionID_)
                                                    throws AuthenticationException,
                                                           InvalidRequestException,
                                                           APIConnectionException,
                                                           CardException,
                                                           APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

getUsagePeriodsForInvoice

public static UsagePeriod[] getUsagePeriodsForInvoice(String subscriptionID_,
                                      String invoiceID_)
                                               throws AuthenticationException,
                                                      InvalidRequestException,
                                                      APIConnectionException,
                                                      CardException,
                                                      APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

getUsagePeriodsForSubscriptionPeriod

public static UsagePeriod[] getUsagePeriodsForSubscriptionPeriod(String subscriptionID_,
                                                 int period_)
                                                          throws AuthenticationException,
                                                                 InvalidRequestException,
                                                                 APIConnectionException,
                                                                 CardException,
                                                                 APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

getResourcePath
```
protected ResourcePath getResourcePath()
```
Specified by:

getResourcePath in class BillingEntity

ResourcePath

protected static ResourcePath ResourcePath()

Class UsagePeriod

Field Summary

Fields inherited from class net.billforward.model.BillingEntity

Constructor Summary

Method Summary

Methods inherited from class net.billforward.model.BillingEntity

Methods inherited from class java.lang.Object

Field Detail

id

organizationID

sessiondID

subscriptionID

uom

invoiceID

state

period

start

stop

durationResolution

usageDuration

usageValue

usageType

resourcePath

Constructor Detail

UsagePeriod

UsagePeriod

Method Detail

getID

getOrganizationID

getSessiondID

getSubscriptionID

getUom

getInvoiceID

getState

getPeriod

getStart

getStop

getDurationResolutionAsString

getDurationResolution

getUsageDuration

getUsageValue

getUsageTypeAsString

getUsageType

getUsagePeriodsForSubscription

getUsagePeriodsForInvoice

getUsagePeriodsForSubscriptionPeriod

getResourcePath

ResourcePath