tenduke::ee::licensing::LicenseCheckoutResponse Class Reference

#include <LicenseCheckoutResponse.h>

Detailed Description

Response from license checkout request.

The result is not atomic: Some items may have failed, some have succeeded. Each item is indexed by the licensed item name and is present either in successful checked out licenses (LicenseCheckoutResponse.leases) or in errors (LicensingResponse.errors). The method LicenseCheckoutResponse.failed() returns true if and only if all items failed.

The developer should always check both successfully checked out licenses and errors.

Inheritance diagram for tenduke::ee::licensing::LicenseCheckoutResponse:

Public Member Functions
	LicenseCheckoutResponse (const std::map< std::string, tenduke::ee::licensing::Lease > &leases, const std::map< std::string, tenduke::ee::licensing::LicensingError > &errors)
	Constructs new instance.
bool	failed () override
	Checks it the entire request failed, i.e.
Public Member Functions inherited from tenduke::ee::licensing::LicensingResponse
	LicensingResponse (const std::map< std::string, tenduke::ee::licensing::LicensingError > &errors)
	Constructs new instance.
bool	hasErrors () const
	Checks if there are any errors.

Public Attributes
const std::map< std::string, tenduke::ee::licensing::Lease >	leases
	Leases, that is, successfully checked out licenses.
Public Attributes inherited from tenduke::ee::licensing::LicensingResponse
const std::map< std::string, tenduke::ee::licensing::LicensingError >	errors
	Errors of this response.

Constructor & Destructor Documentation

LicenseCheckoutResponse()

tenduke::ee::licensing::LicenseCheckoutResponse::LicenseCheckoutResponse ( const std::map< std::string, tenduke::ee::licensing::Lease > &  leases, const std::map< std::string, tenduke::ee::licensing::LicensingError > &  errors  )

inline

Constructs new instance.

Parameters

leases	successfully checked out licenses (leases). Key is the licensed item name.
errors	the failed licensed items. Key is the licensed item name.

Member Function Documentation

failed()

bool tenduke::ee::licensing::LicenseCheckoutResponse::failed ( )

inlineoverridevirtual

Checks it the entire request failed, i.e.

there were no successfully released leases.

Returns

-

Implements tenduke::ee::licensing::LicensingResponse.

Member Data Documentation

leases

const std::map<std::string, tenduke::ee::licensing::Lease> tenduke::ee::licensing::LicenseCheckoutResponse::leases

Leases, that is, successfully checked out licenses.

Key is the licensed item name.

---

The documentation for this class was generated from the following file:

• client/enterprise/api/src/licensing/checkout/LicenseCheckoutResponse.h