net.billforward.model.usage

Class Usage

java.lang.Object

net.billforward.model.BillingEntity

net.billforward.model.InsertableEntity<Usage>

net.billforward.model.usage.Usage

public class Usage
extends InsertableEntity<Usage>

Field Summary

Fields

Modifier and Type	Field and Description
protected String	id
protected String	organizationID
protected String	pricingComponentID
protected String	pricingComponentName
protected static ResourcePath	resourcePath
protected String	sessiondID
protected Date	start
protected Date	stop
protected String	subscriptionID
protected String	uom
protected Date	updated
protected long	usageDuration
protected int	usagePeriod
protected String	usageType
protected long	usageValue

Fields inherited from class net.billforward.model.BillingEntity

m_client, PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor and Description
Usage()
Usage(BillForwardClient client_)

Method Summary

Methods

Modifier and Type	Method and Description
static Usage	create(Usage usage)
String	getID()
String	getOrganizationID()
String	getPricingComponentID()
String	getPricingComponentName()
protected ResourcePath	getResourcePath()
String	getSessiondID()
Date	getStart()
Date	getStop()
String	getSubscriptionID()
String	getUom()
Date	getUpdated()
long	getUsageDuration()
static Usage[]	getUsageForSubscription(String subscriptionID_)
static Usage[]	getUsageForSubscriptionPeriod(String subscriptionID_, int period_)
int	getUsagePeriod()
UsageType	getUsageType()
String	getUsageTypeAsString()
long	getUsageValue()
protected static ResourcePath	ResourcePath()
void	setSessiondID(String sessiondID)
void	setStart(Date start)
void	setStop(Date stop)
void	setSubscriptionID(String subscriptionID)
void	setUom(String uom)
void	setUsageDuration(long usageDuration)
void	setUsagePeriod(int usagePeriod)
void	setUsageType(UsageType usageType)
void	setUsageValue(long usageValue)

Methods inherited from class net.billforward.model.InsertableEntity

create, create, createExplicitPath, retire, retire, retire, retireExplicitPath

Methods inherited from class net.billforward.model.BillingEntity

getAll, getAll, getByID, getByID, 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

pricingComponentID

protected String pricingComponentID

pricingComponentName

protected String pricingComponentName

uom

protected String uom

usagePeriod

protected int usagePeriod

usageDuration

protected long usageDuration

usageType

protected String usageType

usageValue

protected long usageValue

start

protected Date start

stop

protected Date stop

updated

protected Date updated

resourcePath

protected static ResourcePath resourcePath

Constructor Detail

Usage

public Usage(BillForwardClient client_)

Usage

public Usage()

Method Detail

getID

public String getID()

getOrganizationID

public String getOrganizationID()

getSessiondID

public String getSessiondID()

getSubscriptionID

public String getSubscriptionID()

getPricingComponentID

public String getPricingComponentID()

getPricingComponentName

public String getPricingComponentName()

getUom

public String getUom()

getUsagePeriod

public int getUsagePeriod()

getUsageDuration

public long getUsageDuration()

getUsageType

public UsageType getUsageType()

getUsageTypeAsString

public String getUsageTypeAsString()

getUsageValue

public long getUsageValue()

getStart

public Date getStart()

getStop

public Date getStop()

getUpdated

public Date getUpdated()

setSessiondID

public void setSessiondID(String sessiondID)

setSubscriptionID

public void setSubscriptionID(String subscriptionID)

setUom

public void setUom(String uom)

setUsagePeriod

public void setUsagePeriod(int usagePeriod)

setUsageDuration

public void setUsageDuration(long usageDuration)

setUsageType

public void setUsageType(UsageType usageType)

setUsageValue

public void setUsageValue(long usageValue)

setStart

public void setStart(Date start)

setStop

public void setStop(Date stop)

create

public static Usage create(Usage usage)
                    throws AuthenticationException,
                           InvalidRequestException,
                           APIConnectionException,
                           CardException,
                           APIException

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

getUsageForSubscription

public static Usage[] getUsageForSubscription(String subscriptionID_)
                                       throws AuthenticationException,
                                              InvalidRequestException,
                                              APIConnectionException,
                                              CardException,
                                              APIException

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

getUsageForSubscriptionPeriod

public static Usage[] getUsageForSubscriptionPeriod(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()