RatePlan (billforward-java 1.2014.260 API)

java.lang.Object
- net.billforward.model.BillingEntity
- - net.billforward.model.InsertableEntity<TEntityType>
  - - net.billforward.model.MutableEntity<RatePlan>
    - - net.billforward.model.RatePlan

public class RatePlan
extends MutableEntity<RatePlan>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RatePlan.ProRataMode

static class RatePlan.TaxStatus

Nested Classes
Modifier and Type	Class and Description
`static class`	`RatePlan.ProRataMode`
`static class`	`RatePlan.TaxStatus`

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`changedBy`
`protected Date`	`created`
`protected String`	`currency`
`protected Boolean`	`deleted`
`protected List<FixedTermDefinition>`	`fixedTermDefinitions`
`protected String`	`id`
`protected Boolean`	`localisedTax`
`protected String`	`name`
`protected String`	`organizationID`
`protected List<PricingComponent>`	`pricingComponents`
`protected Product`	`product`
`protected String`	`productID`
`protected String`	`proRataMode`
`protected static ResourcePath`	`resourcePath`
`protected String`	`status`
`protected UsageRoundingStrategy`	`strategy`
`protected List<TaxationLink>`	`taxation`
`protected String`	`taxStatus`
`protected Date`	`updated`
`protected Date`	`validFrom`
`protected Date`	`validTill`

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

Constructor Summary

Constructors
Constructor and Description

RatePlan()

RatePlan(BillForwardClient client_)

Constructors
Constructor and Description
`RatePlan()`
`RatePlan(BillForwardClient client_)`

Method Summary

Methods
Modifier and Type	Method and Description
`static RatePlan`	`create(RatePlan ratePlan)`
`static RatePlan[]`	`getAll()`
`static RatePlan`	`getByID(String ID)`
`static RatePlan[]`	`getByProductID(String productID)`
`String`	`getChangedBy()`
`Date`	`getCreated()`
`String`	`getCurrency()`
`String`	`getCurrencyAsString()`
`Boolean`	`getDeleted()`
`String`	`getID()`
`PricingComponent[]`	`getLatestPricingComponents()`
`Boolean`	`getLocalisedTax()`
`String`	`getName()`
`String`	`getOrganizationID()`
`List<PricingComponent>`	`getPricingComponents()`
`Product`	`getProduct()`
`String`	`getProductID()`
`String`	`getProRataMode()`
`protected ResourcePath`	`getResourcePath()`
`String`	`getStatus()`
`RatePlan.TaxStatus`	`getTaxStatus()`
`String`	`getTaxStatusAsString()`
`Date`	`getUpdated()`
`UsageRoundingStrategy`	`getUsageRoundingStrategy()`
`Date`	`getValidFrom()`
`Date`	`getValidTill()`
`protected static ResourcePath`	`ResourcePath()`
`RatePlan`	`retire()`
`void`	`setCurrency(Currency currency)`
`void`	`setDeleted(Boolean deleted)`
`void`	`setLocalisedTax(Boolean localisedTax)`
`void`	`setName(String name)`
`void`	`setOrganizationID(String organizationID)`
`void`	`setProductID(String productID)`
`void`	`setProRataMode(String proRataMode)`
`void`	`setStatus(String status)`
`void`	`setTaxStatus(RatePlan.TaxStatus taxStatus)`
`void`	`setUpdated(Date updated)`
`void`	`setUsageRoundingStrategy(UsageRoundingStrategy strategy)`
`void`	`setValidFrom(Date validFrom)`
`void`	`setValidTill(Date validTill)`

Methods inherited from class net.billforward.model.MutableEntity
save

Methods inherited from class net.billforward.model.InsertableEntity
create, create, retire

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
```

productID
```
protected String productID
```

name
```
protected String name
```

organizationID
```
protected String organizationID
```

currency
```
protected String currency
```

taxStatus
```
protected String taxStatus
```

proRataMode
```
protected String proRataMode
```

localisedTax
```
protected Boolean localisedTax
```

validFrom
```
protected Date validFrom
```

validTill
```
protected Date validTill
```

status
```
protected String status
```

deleted
```
protected Boolean deleted
```

updated
```
protected Date updated
```

changedBy
```
protected String changedBy
```

created
```
protected Date created
```

product
```
protected Product product
```

pricingComponents

protected List<PricingComponent> pricingComponents

taxation
```
protected List<TaxationLink> taxation
```

fixedTermDefinitions

protected List<FixedTermDefinition> fixedTermDefinitions

strategy

protected UsageRoundingStrategy strategy

resourcePath

protected static ResourcePath resourcePath

Constructor Detail

RatePlan

public RatePlan(BillForwardClient client_)

RatePlan
```
public RatePlan()
```

Method Detail

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

getProductID
```
public String getProductID()
```

setProductID

public void setProductID(String productID)

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

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

setOrganizationID

public void setOrganizationID(String organizationID)

getCurrencyAsString
```
public String getCurrencyAsString()
```

getCurrency
```
public String getCurrency()
```

setCurrency

public void setCurrency(Currency currency)

getTaxStatus

public RatePlan.TaxStatus getTaxStatus()

getTaxStatusAsString
```
public String getTaxStatusAsString()
```

setTaxStatus

public void setTaxStatus(RatePlan.TaxStatus taxStatus)

getProRataMode
```
public String getProRataMode()
```

setProRataMode

public void setProRataMode(String proRataMode)

getLocalisedTax
```
public Boolean getLocalisedTax()
```

setLocalisedTax

public void setLocalisedTax(Boolean localisedTax)

getValidFrom
```
public Date getValidFrom()
```

setValidFrom

public void setValidFrom(Date validFrom)

getValidTill
```
public Date getValidTill()
```

setValidTill

public void setValidTill(Date validTill)

getStatus
```
public String getStatus()
```

setStatus
```
public void setStatus(String status)
```

getDeleted
```
public Boolean getDeleted()
```

setDeleted

public void setDeleted(Boolean deleted)

getUpdated
```
public Date getUpdated()
```

setUpdated
```
public void setUpdated(Date updated)
```

getChangedBy
```
public String getChangedBy()
```

getCreated
```
public Date getCreated()
```

getProduct
```
public Product getProduct()
```

getPricingComponents

public List<PricingComponent> getPricingComponents()

getUsageRoundingStrategy

public UsageRoundingStrategy getUsageRoundingStrategy()

setUsageRoundingStrategy

public void setUsageRoundingStrategy(UsageRoundingStrategy strategy)

getLatestPricingComponents

public PricingComponent[] getLatestPricingComponents()

retire

public RatePlan retire()
                throws AuthenticationException,
                       InvalidRequestException,
                       APIConnectionException,
                       CardException,
                       APIException

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

create

public static RatePlan create(RatePlan ratePlan)
                       throws AuthenticationException,
                              InvalidRequestException,
                              APIConnectionException,
                              CardException,
                              APIException

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

getByID

public static RatePlan getByID(String ID)
                        throws AuthenticationException,
                               InvalidRequestException,
                               APIConnectionException,
                               CardException,
                               APIException

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

getByProductID

public static RatePlan[] getByProductID(String productID)
                                 throws AuthenticationException,
                                        InvalidRequestException,
                                        APIConnectionException,
                                        CardException,
                                        APIException

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

getAll

public static RatePlan[] getAll()
                         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 RatePlan

Nested Class Summary

Field Summary

Fields inherited from class net.billforward.model.BillingEntity

Constructor Summary

Method Summary

Methods inherited from class net.billforward.model.MutableEntity

Methods inherited from class net.billforward.model.InsertableEntity

Methods inherited from class net.billforward.model.BillingEntity

Methods inherited from class java.lang.Object

Field Detail

id

productID

name

organizationID

currency

taxStatus

proRataMode

localisedTax

validFrom

validTill

status

deleted

updated

changedBy

created

product

pricingComponents

taxation

fixedTermDefinitions

strategy

resourcePath

Constructor Detail

RatePlan

RatePlan

Method Detail

getID

getProductID

setProductID

getName

setName

getOrganizationID

setOrganizationID

getCurrencyAsString

getCurrency

setCurrency

getTaxStatus

getTaxStatusAsString

setTaxStatus

getProRataMode

setProRataMode

getLocalisedTax

setLocalisedTax

getValidFrom

setValidFrom

getValidTill

setValidTill

getStatus

setStatus

getDeleted

setDeleted

getUpdated

setUpdated

getChangedBy

getCreated

getProduct

getPricingComponents

getUsageRoundingStrategy

setUsageRoundingStrategy

getLatestPricingComponents

retire

create

getByID

getByProductID

getAll

getResourcePath

ResourcePath