tenduke::se::licensing::LicenseConsumers Class Reference

#include <LicenseConsumers.h>

Detailed Description

Client for working with license-consumer information.

Inheritance diagram for tenduke::se::licensing::LicenseConsumers:

Public Member Functions
virtual tenduke::se::licensing::LicenseConsumerClientBindingStatus	describeLicenseConsumerClientBindings (const std::string &licenseeId, const std::string &licenseConsumerId, const ::tenduke::se::Paging &paging, const ::tenduke::se::Filter &filter)=0
	Analyzes licenses that a license consumer is known to have a checkout for currently.
virtual tenduke::se::licensing::LicenseConsumerClientBindingStatus	describeLicenseConsumerClientBindings (const std::string &licenseeId)=0
	Overload of describeLicenseConsumerClientBindings, which provides default values for optional arguments.
virtual std::vector< tenduke::se::licensing::Licensee >	describeLicenseConsumerLicensees (const std::string &licenseConsumerId, const ::tenduke::se::Paging &paging)=0
	Returns Licensees the LicenseConsumer is associated to.
virtual std::vector< tenduke::se::licensing::Licensee >	describeLicenseConsumerLicensees ()=0
	Overload of describeLicenseConsumerLicensees, which provides default values for optional parameters.
virtual tenduke::se::licensing::LicenseConsumerLicensesStatus	describeLicenseConsumerLicenses (const std::string &licenseeId, const std::string &licenseConsumerId, const ::tenduke::se::Paging &paging)=0
	Returns Licenses of given Licensee, which the LicenseConsumer can access.
virtual tenduke::se::licensing::LicenseConsumerLicensesStatus	describeLicenseConsumerLicenses (const std::string &licenseeId)=0
	Overload of describeLicenseConsumerLicenses, which provides default values for optional parameters.

Member Function Documentation

describeLicenseConsumerClientBindings() [1/2]

virtual tenduke::se::licensing::LicenseConsumerClientBindingStatus tenduke::se::licensing::LicenseConsumers::describeLicenseConsumerClientBindings ( const std::string & licenseeId )

pure virtual

Overload of describeLicenseConsumerClientBindings, which provides default values for optional arguments.

Parameters

licenseeId

Identifier of the licensee that the license belongs to.

Returns

-

Implemented in DefaultLicenseConsumers, and tenduke::se::licensing::DefaultLicenseConsumers.

describeLicenseConsumerClientBindings() [2/2]

virtual tenduke::se::licensing::LicenseConsumerClientBindingStatus tenduke::se::licensing::LicenseConsumers::describeLicenseConsumerClientBindings ( const std::string & licenseeId, const std::string & licenseConsumerId, const ::tenduke::se::Paging & paging, const ::tenduke::se::Filter & filter )

pure virtual

Analyzes licenses that a license consumer is known to have a checkout for currently.

Parameters

licenseeId	Identifier of the licensee that the license belongs to.
licenseConsumerId	Identifier of the license consumer that the the information is scoped to. NOTE: When using OIDC-authorization, this value is not used: Pass empty string.
paging	-
filter	-

Returns

-

Implemented in DefaultLicenseConsumers, and tenduke::se::licensing::DefaultLicenseConsumers.

describeLicenseConsumerLicensees() [1/2]

virtual std::vector< tenduke::se::licensing::Licensee > tenduke::se::licensing::LicenseConsumers::describeLicenseConsumerLicensees ( )

pure virtual

Overload of describeLicenseConsumerLicensees, which provides default values for optional parameters.

Returns

-

Implemented in DefaultLicenseConsumers, and tenduke::se::licensing::DefaultLicenseConsumers.

describeLicenseConsumerLicensees() [2/2]

virtual std::vector< tenduke::se::licensing::Licensee > tenduke::se::licensing::LicenseConsumers::describeLicenseConsumerLicensees ( const std::string & licenseConsumerId, const ::tenduke::se::Paging & paging )

pure virtual

Returns Licensees the LicenseConsumer is associated to.

Parameters

licenseConsumerId	id of the LicenseConsumer. NOTE: When using OIDC-authorization, this value is not used
paging	-

Returns

-

Implemented in DefaultLicenseConsumers, and tenduke::se::licensing::DefaultLicenseConsumers.

describeLicenseConsumerLicenses() [1/2]

virtual tenduke::se::licensing::LicenseConsumerLicensesStatus tenduke::se::licensing::LicenseConsumers::describeLicenseConsumerLicenses ( const std::string & licenseeId )

pure virtual

Overload of describeLicenseConsumerLicenses, which provides default values for optional parameters.

Parameters

licenseeId

id of the Licensee.

Returns

-

Implemented in DefaultLicenseConsumers, and tenduke::se::licensing::DefaultLicenseConsumers.

describeLicenseConsumerLicenses() [2/2]

virtual tenduke::se::licensing::LicenseConsumerLicensesStatus tenduke::se::licensing::LicenseConsumers::describeLicenseConsumerLicenses ( const std::string & licenseeId, const std::string & licenseConsumerId, const ::tenduke::se::Paging & paging )

pure virtual

Returns Licenses of given Licensee, which the LicenseConsumer can access.

Parameters

licenseeId	id of the Licensee.
licenseConsumerId	id of the LicenseConsumer. NOTE: When using OIDC-authorization, this value is not used
paging	-

Returns

-

Implemented in DefaultLicenseConsumers, and tenduke::se::licensing::DefaultLicenseConsumers.

---

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

• api/src/licensing/api/consumers/LicenseConsumers.h