com.licensespring.management.model

Class Order

java.lang.Object

com.licensespring.management.model.Order

public final class Order
extends Object

Immutable Order, returned from management APIs. The Order objects are read-only. All order creation and updates are made via the WebhookOrder

Constructor Summary

Constructors

Constructor and Description
Order(Long id, List<BackOfficeOrderItem> backOfficeOrderItems, BackOfficeCustomer customer, Boolean hasActiveLicenses, ZonedDateTime createdAt, ZonedDateTime updatedAt, String clientOrderId, com.licensespring.model.order.OrderType type, Boolean isTest, Boolean isTrial, String downloadId, String language, String campaignParams, Integer company, com.google.gson.JsonElement metadata)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
List<BackOfficeOrderItem>	getBackOfficeOrderItems() List of order items that were made with this order.
String	getCampaignParams() e.g.
String	getClientOrderId() This is the same field as WebhookOrder.getId().
Integer	getCompany() Leftover for legacy reasons.
ZonedDateTime	getCreatedAt() The time when this order was created.
BackOfficeCustomer	getCustomer() Customer who placed the order.
String	getDownloadId() Used for FastSpring integration.
Boolean	getHasActiveLicenses() Boolean value indicating does user have active licenses.
Long	getId() Internal LicenseSpring ID of the order - not to be confused with WebhookOrder.getId(), which is the internal/CRM id of the customer.
Boolean	getIsTest() Indicate whether order is test or not.
Boolean	getIsTrial() Indicates if items in this order will have licenses that allow trial period.
String	getLanguage() Language used in the order.
com.google.gson.JsonElement	getMetadata() A JSON element containing additional metadata information.
com.licensespring.model.order.OrderType	getType() Only valid Order type is NORMAL.
ZonedDateTime	getUpdatedAt() The time when this order was updated.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Order

public Order(Long id,
             List<BackOfficeOrderItem> backOfficeOrderItems,
             BackOfficeCustomer customer,
             Boolean hasActiveLicenses,
             ZonedDateTime createdAt,
             ZonedDateTime updatedAt,
             String clientOrderId,
             com.licensespring.model.order.OrderType type,
             Boolean isTest,
             Boolean isTrial,
             String downloadId,
             String language,
             String campaignParams,
             Integer company,
             com.google.gson.JsonElement metadata)

Method Detail

getId

public Long getId()

Internal LicenseSpring ID of the order - not to be confused with WebhookOrder.getId(), which is the internal/CRM id of the customer.

Returns:

LicenseSpring ID of the order

getBackOfficeOrderItems

public List<BackOfficeOrderItem> getBackOfficeOrderItems()

List of order items that were made with this order. This will be filled only in OrderService.getOrder(Long).

Returns:

ordered items

getCustomer

public BackOfficeCustomer getCustomer()

Customer who placed the order.

Returns:

Customer who placed order

getHasActiveLicenses

public Boolean getHasActiveLicenses()

Boolean value indicating does user have active licenses.

Returns:

True or false

getCreatedAt

public ZonedDateTime getCreatedAt()

The time when this order was created.

Returns:

The time when this order was created.

getUpdatedAt

public ZonedDateTime getUpdatedAt()

The time when this order was updated.

Returns:

Time this order is updated

getClientOrderId

public String getClientOrderId()

This is the same field as WebhookOrder.getId(). The API calls this "store_id" - however it is not clear enough, and we renamed it to customOrderId, as it's the CRM/purchase order id from the client implementing the system

Returns:

Store ID

getType

public com.licensespring.model.order.OrderType getType()

Only valid Order type is NORMAL.

Returns:

NORMAL

getIsTest

public Boolean getIsTest()

Indicate whether order is test or not.

Returns:

Whether order is test or not.

getIsTrial

public Boolean getIsTrial()

Indicates if items in this order will have licenses that allow trial period. Can be overridden in each individual license.

Returns:

whether is trial allowed in license.

getDownloadId

public String getDownloadId()

Used for FastSpring integration. Ignore for other use cases.

Returns:

FastSpring download ID

getLanguage

public String getLanguage()

Language used in the order.

Returns:

language

getCampaignParams

public String getCampaignParams()

e.g. Google campaign params for the order.

Returns:

Google campaign params

getCompany

public Integer getCompany()

Leftover for legacy reasons. All new customers should check the getCustomer()

Returns:

company ID of the user

getMetadata

public com.google.gson.JsonElement getMetadata()

A JSON element containing additional metadata information.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object