tenduke::ee::licensing::LicensingError Class Reference

#include <LicensingError.h>

Detailed Description

Describes an error returned from the API.

Licensing operations (checkout, release) can work on multiple items (licenses, leases) per request. Any of the items can fail for various reasons, in which case the API reports the error per item. This class describes the error for single item. The client returns errors as map, where the key is the item identifier (e.g. licensed item name or lease id) and value is the error.

Public Member Functions
const std::string &	getErrorCode () const
	Returns the error code.
const std::string &	getErrorKey () const
	Returns the error key.
const std::string &	getErrorMessage () const
	Returns error message.
const std::string &	getErrorTechnical () const
	Returns technical explanation.
const std::string &	getItemName () const
	Returns the "item" name which this error is about.
void	setErrorCode (const std::string &code)
	Sets the error code.
void	setErrorKey (const std::string &key)
	Sets the error key.
void	setErrorMessage (const std::string &message)
	Sets the error message.
void	setErrorTechnical (const std::string &technical)
	Sets the technical explanation.
void	setItemName (const std::string &pItemName)
	Sets the "item" name.

Member Function Documentation

getErrorCode()

const std::string & tenduke::ee::licensing::LicensingError::getErrorCode ( ) const

inline

Returns the error code.

Returns

-

getErrorKey()

const std::string & tenduke::ee::licensing::LicensingError::getErrorKey ( ) const

inline

Returns the error key.

Returns

-

getErrorMessage()

const std::string & tenduke::ee::licensing::LicensingError::getErrorMessage ( ) const

inline

Returns error message.

Returns

-

getErrorTechnical()

const std::string & tenduke::ee::licensing::LicensingError::getErrorTechnical ( ) const

inline

Returns technical explanation.

Returns

-

getItemName()

const std::string & tenduke::ee::licensing::LicensingError::getItemName ( ) const

inline

Returns the "item" name which this error is about.

E.g. licensed item name.

Returns

-

setErrorCode()

void tenduke::ee::licensing::LicensingError::setErrorCode ( const std::string &  code )

inline

Sets the error code.

Parameters

code

-

setErrorKey()

void tenduke::ee::licensing::LicensingError::setErrorKey ( const std::string &  key )

inline

Sets the error key.

Parameters

key

-

setErrorMessage()

void tenduke::ee::licensing::LicensingError::setErrorMessage ( const std::string &  message )

inline

Sets the error message.

Parameters

message

-

setErrorTechnical()

void tenduke::ee::licensing::LicensingError::setErrorTechnical ( const std::string &  technical )

inline

Sets the technical explanation.

Parameters

technical

-

setItemName()

void tenduke::ee::licensing::LicensingError::setItemName ( const std::string &  pItemName )

inline

Sets the "item" name.

Parameters

pItemName

-

---

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

• client/enterprise/api/src/licensing/LicensingError.h