Order (TurnOnline.biz Ecosystem Administration 0.35 API)

java.lang.Object
- biz.turnonline.ecosystem.widget.shared.rest.billing.Order

All Implemented Interfaces:: org.ctoolkit.gwt.client.facade.RelevantNullChecker

public final class Order
extends Object
implements org.ctoolkit.gwt.client.facade.RelevantNullChecker

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Order.Status
Order statuses

Nested Classes
Modifier and Type	Class and Description
`static class`	`Order.Status` Order statuses

Constructor Summary

Constructors
Constructor and Description

Order()

Constructors
Constructor and Description
`Order()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`allNull()`
`Date`	`getBeginOn()` The date of first invoice issue.
`Date`	`getCreatedDate()` A date when order has been created.
`String`	`getCurrency()` The currency alphabetic code based on the ISO 4217.
`Customer`	`getCustomer()` A customer to be invoiced.
`Long`	`getId()` The unique order identification.
`List<Invoice>`	`getInvoices()` List of already issued invoices based on this Order, where number of records is limited by value from the query parameter.
`String`	`getInvoiceType()` Get invoiceType
`List<PricingItem>`	`getItems()` The list of order items to be placed at invoice.
`Date`	`getLastBillingDate()` The last billing date.
`Date`	`getModificationDate()` The date of the last modification of order values.
`Date`	`getNextBillingDate()` The next (future) billing date.
`Integer`	`getNumberOfDays()` The number of days to calculate due date.
`String`	`getPeriodicity()` The current periodicity of the order.
`String`	`getStatus()` The current status of the order.
`Double`	`getTotalPrice()` The order total price as a sum of all checked in order items and its amount including target rounding mode.
`Double`	`getTotalPriceExclVat()` The order total price as a sum of all checked in order items and its amount including target rounding mode.
`Double`	`getTotalVatAmount()` The order total amount of VAT as a sum of all checked in order items including target rounding mode.
`Double`	`getTotalVatBase()` The order total VAT base as a sum of all checked in order items and its amount.
`Order`	`setBeginOn(Date beginOn)`
`Order`	`setCreatedDate(Date createdDate)`
`Order`	`setCurrency(String currency)`
`Order`	`setCustomer(Customer customer)`
`void`	`setCustomerIf(Customer customer)`
`Order`	`setId(Long id)`
`Order`	`setInvoices(List<Invoice> invoices)`
`Order`	`setInvoiceType(String invoiceType)`
`Order`	`setItems(List<PricingItem> items)`
`Order`	`setLastBillingDate(Date lastBillingDate)`
`Order`	`setModificationDate(Date modificationDate)`
`Order`	`setNextBillingDate(Date nextBillingDate)`
`Order`	`setNumberOfDays(Integer numberOfDays)`
`Order`	`setPeriodicity(String periodicity)`
`Order`	`setStatus(String status)`
`Order`	`setTotalPrice(Double totalPrice)`
`Order`	`setTotalPriceExclVat(Double totalPriceExclVat)`
`Order`	`setTotalVatAmount(Double totalVatAmount)`
`Order`	`setTotalVatBase(Double totalVatBase)`

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

Methods inherited from interface org.ctoolkit.gwt.client.facade.RelevantNullChecker
allNull, setIfNotAllNull

- Constructor Detail
  - Order
```
public Order()
```
- Method Detail
  - getBeginOn
```
public Date getBeginOn()
```
    The date of first invoice issue. Might be selected by the user.
  - setBeginOn
```
public Order setBeginOn(Date beginOn)
```
  - getCreatedDate
```
public Date getCreatedDate()
```
    A date when order has been created. Populated by the service.
  - setCreatedDate
```
public Order setCreatedDate(Date createdDate)
```
  - getCurrency
```
public String getCurrency()
```
    The currency alphabetic code based on the ISO 4217. The value is being based on the order item that is first within the list. If list is empty, none currency will be set.
  - setCurrency
```
public Order setCurrency(String currency)
```
  - getCustomer
```
public Customer getCustomer()
```
    A customer to be invoiced.
  - setCustomer
```
public Order setCustomer(Customer customer)
```
  - setCustomerIf
```
public void setCustomerIf(Customer customer)
```
  - getId
```
public Long getId()
```
    The unique order identification.
  - setId
```
public Order setId(Long id)
```
  - getInvoices
```
public List<Invoice> getInvoices()
```
    List of already issued invoices based on this Order, where number of records is limited by value from the query parameter. By default no invoices will be included in the response until the query parameter 'invoices' will be present with a positive integer value (check whether it's supported by endpoint). This number represents a limit of max number of expected invoices to be included in the result. If no invoice yet has been issued, the property 'invoices' will be missing in the result whatever was the value of query parameter. Ordered by invoice modification date (descending).
  - setInvoices
```
public Order setInvoices(List<Invoice> invoices)
```
  - getInvoiceType
```
public String getInvoiceType()
```
    Get invoiceType
  - setInvoiceType
```
public Order setInvoiceType(String invoiceType)
```
  - getItems
```
public List<PricingItem> getItems()
```
    The list of order items to be placed at invoice. Taken either as a product from the product catalog or a custom definition. The root pricing item of the pricing tree structure must be either type of OrderItem or Standard (PricingItem ‘itemType’ property value). Otherwise validation error will be returned as a bad request.
  - setItems
```
public Order setItems(List<PricingItem> items)
```
  - getLastBillingDate
```
public Date getLastBillingDate()
```
    The last billing date. An invoicing that has been already executed. Set by the service.
  - setLastBillingDate
```
public Order setLastBillingDate(Date lastBillingDate)
```
  - getModificationDate
```
public Date getModificationDate()
```
    The date of the last modification of order values. Managed solely by the service. RFC 3339
  - setModificationDate
```
public Order setModificationDate(Date modificationDate)
```
  - getNextBillingDate
```
public Date getNextBillingDate()
```
    The next (future) billing date. A concrete value is being based on the periodicity and evaluated by the service.
  - setNextBillingDate
```
public Order setNextBillingDate(Date nextBillingDate)
```
  - getNumberOfDays
```
public Integer getNumberOfDays()
```
    The number of days to calculate due date. An user defined value.
  - setNumberOfDays
```
public Order setNumberOfDays(Integer numberOfDays)
```
  - getPeriodicity
```
public String getPeriodicity()
```
    The current periodicity of the order.
  - setPeriodicity
```
public Order setPeriodicity(String periodicity)
```
  - getStatus
```
public String getStatus()
```
    The current status of the order. Client is allowed to set only one of the following value: TRIALING, ACTIVE, SUSPENDED.
  - setStatus
```
public Order setStatus(String status)
```
  - getTotalPrice
```
public Double getTotalPrice()
```
    The order total price as a sum of all checked in order items and its amount including target rounding mode. Including VAT.
  - setTotalPrice
```
public Order setTotalPrice(Double totalPrice)
```
  - getTotalPriceExclVat
```
public Double getTotalPriceExclVat()
```
    The order total price as a sum of all checked in order items and its amount including target rounding mode. The price is excluding VAT in case company is VAT payer, otherwise price is final and same as value of totalPrice property.
  - setTotalPriceExclVat
```
public Order setTotalPriceExclVat(Double totalPriceExclVat)
```
  - getTotalVatAmount
```
public Double getTotalVatAmount()
```
    The order total amount of VAT as a sum of all checked in order items including target rounding mode.
  - setTotalVatAmount
```
public Order setTotalVatAmount(Double totalVatAmount)
```
  - getTotalVatBase
```
public Double getTotalVatBase()
```
    The order total VAT base as a sum of all checked in order items and its amount.
  - setTotalVatBase
```
public Order setTotalVatBase(Double totalVatBase)
```
  - allNull
```
public boolean allNull()
```
    Specified by:
    
    allNull in interface org.ctoolkit.gwt.client.facade.RelevantNullChecker

Class Order

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.ctoolkit.gwt.client.facade.RelevantNullChecker

Constructor Detail

Order

Method Detail

getBeginOn

setBeginOn

getCreatedDate

setCreatedDate

getCurrency

setCurrency

getCustomer

setCustomer

setCustomerIf

getId

setId

getInvoices

setInvoices

getInvoiceType

setInvoiceType

getItems

setItems

getLastBillingDate

setLastBillingDate

getModificationDate

setModificationDate

getNextBillingDate

setNextBillingDate

getNumberOfDays

setNumberOfDays

getPeriodicity

setPeriodicity

getStatus

setStatus

getTotalPrice

setTotalPrice

getTotalPriceExclVat

setTotalPriceExclVat

getTotalVatAmount

setTotalVatAmount

getTotalVatBase

setTotalVatBase

allNull