Product (billforward-java 1.2015.155 API)

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

public class Product
extends MutableEntity<Product>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Product.DurationPeriod

static class Product.ProductPeriod

static class Product.ProductType

Nested Classes
Modifier and Type	Class and Description
`static class`	`Product.DurationPeriod`
`static class`	`Product.ProductPeriod`
`static class`	`Product.ProductType`

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`accountID`
`protected String`	`changedBy`
`protected Date`	`created`
`protected Boolean`	`deleted`
`protected String`	`description`
`protected int`	`duration`
`protected String`	`durationPeriod`
`protected String`	`id`
`protected String`	`name`
`protected String`	`organizationID`
`protected String`	`productType`
`protected static ResourcePath`	`resourcePath`
`protected Date`	`startDate`
`protected String`	`state`
`protected int`	`trial`
`protected String`	`trialPeriod`
`protected Date`	`updated`

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

Constructor Summary

Constructors
Constructor and Description

Product()

Product(BillForwardClient client_)

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

Method Summary

Methods
Modifier and Type	Method and Description
`static Product`	`create(Product product)`
`String`	`getAccountID()`
`static Product[]`	`getAll()`
`static Product`	`getByID(String ID)`
`String`	`getChangedBy()`
`Date`	`getCreated()`
`Boolean`	`getDeleted()`
`String`	`getDescription()`
`int`	`getDuration()`
`Product.ProductPeriod`	`getDurationPeriod()`
`String`	`getDurationPeriodAsString()`
`String`	`getID()`
`String`	`getName()`
`String`	`getOrganizationID()`
`Product.ProductType`	`getProductType()`
`String`	`getProductTypeAsString()`
`protected ResourcePath`	`getResourcePath()`
`Date`	`getStartDate()`
`String`	`getState()`
`int`	`getTrial()`
`String`	`getTrialPeriod()`
`Date`	`getUpdated()`
`protected static ResourcePath`	`ResourcePath()`
`Product`	`retire()`
`void`	`setAccountID(String accountID)`
`void`	`setDescription(String description)`
`void`	`setDuration(int duration)`
`void`	`setDurationPeriod(Product.ProductPeriod durationPeriod)`
`void`	`setName(String name)`
`void`	`setProductType(Product.ProductType productType)`
`void`	`setStartDate(Date startDate)`
`void`	`setTrial(int trial)`
`void`	`setTrialPeriod(String trialPeriod)`

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

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

accountID
```
protected String accountID
```

organizationID
```
protected String organizationID
```

name
```
protected String name
```

description
```
protected String description
```

durationPeriod
```
protected String durationPeriod
```

duration
```
protected int duration
```

trial
```
protected int trial
```

trialPeriod
```
protected String trialPeriod
```

productType
```
protected String productType
```

state
```
protected String state
```

deleted
```
protected Boolean deleted
```

startDate
```
protected Date startDate
```

updated
```
protected Date updated
```

changedBy
```
protected String changedBy
```

created
```
protected Date created
```

resourcePath

protected static ResourcePath resourcePath

Constructor Detail

Product

public Product(BillForwardClient client_)

Product
```
public Product()
```

Method Detail

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

getAccountID
```
public String getAccountID()
```

setAccountID

public void setAccountID(String accountID)

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

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

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

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String description)

getDurationPeriod

public Product.ProductPeriod getDurationPeriod()

getDurationPeriodAsString

public String getDurationPeriodAsString()

setDurationPeriod

public void setDurationPeriod(Product.ProductPeriod durationPeriod)

getDuration
```
public int getDuration()
```

setDuration

public void setDuration(int duration)

getTrial
```
public int getTrial()
```

setTrial
```
public void setTrial(int trial)
```

getTrialPeriod
```
public String getTrialPeriod()
```

setTrialPeriod

public void setTrialPeriod(String trialPeriod)

getProductType

public Product.ProductType getProductType()

getProductTypeAsString

public String getProductTypeAsString()

setProductType

public void setProductType(Product.ProductType productType)

getState
```
public String getState()
```

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

getStartDate
```
public Date getStartDate()
```

setStartDate

public void setStartDate(Date startDate)

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

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

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

retire

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

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

create

public static Product create(Product product)
                      throws AuthenticationException,
                             InvalidRequestException,
                             APIConnectionException,
                             CardException,
                             APIException

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

getByID

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

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

getAll

public static Product[] 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 Product

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

accountID

organizationID

name

description

durationPeriod

duration

trial

trialPeriod

productType

state

deleted

startDate

updated

changedBy

created

resourcePath

Constructor Detail

Product

Product

Method Detail

getID

getAccountID

setAccountID

getOrganizationID

getName

setName

getDescription

setDescription

getDurationPeriod

getDurationPeriodAsString

setDurationPeriod

getDuration

setDuration

getTrial

setTrial

getTrialPeriod

setTrialPeriod

getProductType

getProductTypeAsString

setProductType

getState

getDeleted

getStartDate

setStartDate

getUpdated

getChangedBy

getCreated

retire

create

getByID

getAll

getResourcePath

ResourcePath