com.licensespring.management

Class OrderService

java.lang.Object

com.licensespring.management.OrderService

public class OrderService
extends Object

Order Service contains methods for creating, updating and listing and exporting LicenseSpring orders, as well as searching and creating installation files. Additionally it contains methods for getting all available products. Multiple products can be used. To create a new product, you will need to use the LicenseSpring platform directly.

Constructor Summary

Constructors

Constructor and Description
OrderService(ManagementConfiguration configuration) OrderService has to be built using the ManagementConfiguration object.

Method Summary

Modifier and Type	Method and Description
Manager	addManagerToOrder(Long orderId, AddManagerToOrderRequest request) Adds a manager to an order.
BackOfficeInstallationFile	createInstallationFile(CreateInstallationFileRequest request) Creates and returns a new installation file with the details provided in the request.
CreateOrderResponse	createOrder(com.licensespring.model.order.WebhookOrder order) Creates an order.
String	exportToCsv(LocalDate from, LocalDate to, String destinationDirectory) Generates a csv file with orders from the requested time range.
String	exportToCsv(Range range, String destinationDirectory) Generates a csv file with orders from the requested time range.
String[]	generateLicenseKeys(com.licensespring.dto.GenerateLicenseRequest request) Generates UNIQUE license keys.
BackOfficeInstallationFile	getInstallationFile(int id) Gets the installation file with the provided id.
Order	getOrder(Long id) Finds an order with provided order id.
BackOfficeProduct	getProduct(Long id) Gets the product with the provided id.
List<BackOfficeInstallationFile>	paginateThroughAllInstallationFiles(SearchInstallationFilesRequest request) Goes through all pages of the response and returns a list with all possible installation files that satisfy the request.
List<Order>	paginateThroughAllOrders(SearchOrdersRequest request) Goes through all pages of the response and returns a list with all possible orders that satisfy the request.
List<BackOfficeProduct>	paginateThroughAllProducts(SearchProductsRequest request) Goes through all pages of the response and returns a list with all possible products that satisfy the request.
ProductCustomFieldsService	productCustomFieldsService() Returns the service for product custom fields.
SearchResult<BackOfficeInstallationFile>	searchInstallationFiles(SearchInstallationFilesRequest request) Searches the orders by applying the filtering and ordering conditions in the SearchInstallationFilesRequest class.
SearchResult<Order>	searchOrders(SearchOrdersRequest request) Searches the orders by applying the filtering and ordering conditions in the SearchOrdersRequest class.
SearchResult<BackOfficeProduct>	searchProducts(SearchProductsRequest request) Searches the orders by applying the filtering and ordering conditions in the SearchProductsRequest class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OrderService

public OrderService(ManagementConfiguration configuration)

OrderService has to be built using the ManagementConfiguration object.

Parameters:

configuration - build via the builder pattern

Method Detail

productCustomFieldsService

public ProductCustomFieldsService productCustomFieldsService()

Returns the service for product custom fields.

Returns:

the service for product custom fields

searchOrders

public SearchResult<Order> searchOrders(SearchOrdersRequest request)
                                 throws com.licensespring.model.exceptions.LicenseSpringException

Searches the orders by applying the filtering and ordering conditions in the SearchOrdersRequest class.

Parameters:

request - search request that can be made using the builder

Returns:

a paginated result that contains list of orders

Throws:

com.licensespring.model.exceptions.LicenseSpringException

getOrder

public Order getOrder(Long id)
               throws com.licensespring.model.exceptions.LicenseSpringException

Finds an order with provided order id.

Parameters:

id - id of the Order, 16 digit number

Returns:

the Order object that contains detailed information about the order

Throws:

com.licensespring.model.exceptions.LicenseSpringException

exportToCsv

public String exportToCsv(LocalDate from,
                          LocalDate to,
                          String destinationDirectory)
                   throws com.licensespring.model.exceptions.LicenseSpringException

Generates a csv file with orders from the requested time range. Dates on the LicenseSpring platform are always listed in UTC. The file name is taken from the server response.

Parameters:

from - e.g. LocalDate.of(GGGG,MM,DD)

to - e.g. LocalDate.of(GGGG,MM,DD)

destinationDirectory - where the SDK will save the CSV

Returns:

path where the CSV was saved

Throws:

com.licensespring.model.exceptions.LicenseSpringException

exportToCsv

public String exportToCsv(Range range,
                          String destinationDirectory)
                   throws com.licensespring.model.exceptions.LicenseSpringException

Generates a csv file with orders from the requested time range. Dates on the LicenseSpring platform are always listed in UTC. The file name is taken from the server response.

Parameters:

range - Range enum, represents the last x days, where x is an int

destinationDirectory - where the SDK will save the CSV

Returns:

path where the CSV was saved

Throws:

com.licensespring.model.exceptions.LicenseSpringException

generateLicenseKeys

public String[] generateLicenseKeys(com.licensespring.dto.GenerateLicenseRequest request)
                             throws com.licensespring.model.exceptions.LicenseSpringException

Generates UNIQUE license keys.

Parameters:

request - the request parameters, multiple license keys can be generated at once

Returns:

string array with generated license keys to be used in the createOrder(WebhookOrder) call

Throws:

com.licensespring.model.exceptions.LicenseSpringException

createOrder

public CreateOrderResponse createOrder(com.licensespring.model.order.WebhookOrder order)
                                throws com.licensespring.model.exceptions.LicenseSpringException

Creates an order.

Parameters:

order - can be made with builder

Returns:

the CreateOrderResponse object that contains automatically generated order store id and a new password field

Throws:

com.licensespring.model.exceptions.LicenseSpringException

addManagerToOrder

public Manager addManagerToOrder(Long orderId,
                                 AddManagerToOrderRequest request)

Adds a manager to an order.

Parameters:

orderId - id of the order

request - email and password of the manager

Returns:

the Manager object that contains detailed information about the manager

searchProducts

public SearchResult<BackOfficeProduct> searchProducts(SearchProductsRequest request)
                                               throws com.licensespring.model.exceptions.LicenseSpringException

Searches the orders by applying the filtering and ordering conditions in the SearchProductsRequest class.

Parameters:

request - search request that can be made using the builder

Returns:

paginated result that contains list of products

Throws:

com.licensespring.model.exceptions.LicenseSpringException

getProduct

public BackOfficeProduct getProduct(Long id)
                             throws com.licensespring.model.exceptions.LicenseSpringException

Gets the product with the provided id.

Parameters:

id - id of the product you want to get, 16 digit number

Returns:

the BackOfficeProduct object

Throws:

com.licensespring.model.exceptions.LicenseSpringException

searchInstallationFiles

public SearchResult<BackOfficeInstallationFile> searchInstallationFiles(SearchInstallationFilesRequest request)
                                                                 throws com.licensespring.model.exceptions.LicenseSpringException

Searches the orders by applying the filtering and ordering conditions in the SearchInstallationFilesRequest class.

Parameters:

request - search request that can be made using the builder

Returns:

paginated result that contains list of installation files

Throws:

com.licensespring.model.exceptions.LicenseSpringException

getInstallationFile

public BackOfficeInstallationFile getInstallationFile(int id)
                                               throws com.licensespring.model.exceptions.LicenseSpringException

Gets the installation file with the provided id.

Parameters:

id - id of the installation file that needs to be retrieved

Returns:

the BackOfficeInstallationFile object

Throws:

com.licensespring.model.exceptions.LicenseSpringException

createInstallationFile

public BackOfficeInstallationFile createInstallationFile(CreateInstallationFileRequest request)
                                                  throws com.licensespring.model.exceptions.LicenseSpringException

Creates and returns a new installation file with the details provided in the request.

Parameters:

request - DTO CreateInstallationFileRequest object with information about the new installation file

Returns:

the BackOfficeInstallationFile object

Throws:

com.licensespring.model.exceptions.LicenseSpringException

paginateThroughAllOrders

public List<Order> paginateThroughAllOrders(SearchOrdersRequest request)
                                     throws com.licensespring.model.exceptions.LicenseSpringException

Goes through all pages of the response and returns a list with all possible orders that satisfy the request. Makes multiple requests to the server until all results have been found. Use searchOrders(SearchOrdersRequest)in order to get results per page.

Parameters:

request - can be made with builder, contains query fields

Returns:

list of all orders that satisfy the request

Throws:

com.licensespring.model.exceptions.LicenseSpringException

paginateThroughAllProducts

public List<BackOfficeProduct> paginateThroughAllProducts(SearchProductsRequest request)
                                                   throws com.licensespring.model.exceptions.LicenseSpringException

Goes through all pages of the response and returns a list with all possible products that satisfy the request. Makes multiple requests to the server until all results have been found. Use searchProducts(SearchProductsRequest)} in order to get results per page.

Parameters:

request - can be made with builder, contains query fields

Returns:

list of all products that satisfy the request

Throws:

com.licensespring.model.exceptions.LicenseSpringException

paginateThroughAllInstallationFiles

public List<BackOfficeInstallationFile> paginateThroughAllInstallationFiles(SearchInstallationFilesRequest request)
                                                                     throws com.licensespring.model.exceptions.LicenseSpringException

Goes through all pages of the response and returns a list with all possible installation files that satisfy the request. Makes multiple requests to the server until all results have been found. Use searchInstallationFiles(SearchInstallationFilesRequest) in order to get results per page.

Parameters:

request - can be made with builder, contains query fields

Returns:

list of all installation files that satisfy the request

Throws:

com.licensespring.model.exceptions.LicenseSpringException