FlowEngine::LicenseInfoInterface Class Reference

Holds information about the currently active license and its leases. More...

#include <LicenseInfoInterface.h>

Public Member Functions
virtual FLE_DLL	~LicenseInfoInterface ()=default
	Default virtual destructor.
virtual FLE_DLL Size	getProductKeyLength () const =0
virtual FLE_DLL Result	getProductKey (StringBuffer outKey) const =0
virtual FLE_DLL void	getExpirationDate (DateTime &outDate) const =0
virtual FLE_DLL void	getUpdatesExpirationDate (DateTime &outDate) const =0
virtual FLE_DLL Index	getSeatCount () const =0
	Returns the number of seats for this license.
virtual FLE_DLL Index	getLeaseCount () const =0
	Returns the number of active leases at the moment.
virtual FLE_DLL Size	getLeaseDataSize (Index lease) const =0
virtual FLE_DLL Result	getLeaseData (Index lease, StringBuffer outData) const =0
virtual FLE_DLL Result	getLeaseExpirationDate (Index lease, DateTime &outDate) const =0

Detailed Description

Holds information about the currently active license and its leases.

Constructor & Destructor Documentation

~LicenseInfoInterface()

virtual FLE_DLL FlowEngine::LicenseInfoInterface::~LicenseInfoInterface ( )

virtualdefault

Default virtual destructor.

Member Function Documentation

getExpirationDate()

virtual FLE_DLL void FlowEngine::LicenseInfoInterface::getExpirationDate ( DateTime &  outDate ) const

pure virtual

Returns the active license expiration date

Parameters

[out]

outDate

the date after which this product is not usable anymore

getLeaseCount()

virtual FLE_DLL Index FlowEngine::LicenseInfoInterface::getLeaseCount ( ) const

pure virtual

Returns the number of active leases at the moment.

getLeaseData()

virtual FLE_DLL Result FlowEngine::LicenseInfoInterface::getLeaseData ( Index  lease, StringBuffer  outData  ) const

pure virtual

Returns the data associated with a lease.

Parameters

[in]	lease	the index of the lease. Must be in the range [0, getLeaseCount()).
[in,out]	outData	a string buffer that will receive the lease data. Must be at least getLeaseDataSize() elements long.

getLeaseDataSize()

virtual FLE_DLL Size FlowEngine::LicenseInfoInterface::getLeaseDataSize ( Index  lease ) const

pure virtual

Returns the size of the data associated with a lease.

Parameters

[in]

lease

the index of the lease. Must be in the range [0, getLeaseCount()).

getLeaseExpirationDate()

virtual FLE_DLL Result FlowEngine::LicenseInfoInterface::getLeaseExpirationDate ( Index  lease, DateTime &  outDate  ) const

pure virtual

Returns a lease license expiration date.

Parameters

[in]	lease	the index of the lease. Must be in the range [0, getLeaseCount()).
[out]	outDate	the date after which this product is not usable anymore

getProductKey()

virtual FLE_DLL Result FlowEngine::LicenseInfoInterface::getProductKey ( StringBuffer  outKey ) const

pure virtual

Retrieves the currently registered private key.

Parameters

[in,out]

outKey

A valid string buffer that will receive the key. It must be at least getPrivateKeyLength() long.

Precondition

A valid key must be successfully registered first.

Note

This method is valid only for static licensing.

Returns

One of the following result codes:

• Result::Success – if outKey was filled with the private key.
• Result::InvalidArgument – if outKey is not a valid string buffer.
• Result::BufferTooSmall – if outKey is not big enough to store a private key.
• Result::OutOfMemoryError – if the system ran out of memory when allocating temporary buffers.
• Result::FileNotFound – if there is not a valid key registered on the system.
• Result::GenericError – if any other error occurred. Check the log for more information.
• Result::FeatureNotAvailable – if this method is called by a floating license version.

getProductKeyLength()

virtual FLE_DLL Size FlowEngine::LicenseInfoInterface::getProductKeyLength ( ) const

pure virtual

Returns

the currently registered private key length, or 0 if no license is activated.

Note

This method is valid only for static licensing.

getSeatCount()

virtual FLE_DLL Index FlowEngine::LicenseInfoInterface::getSeatCount ( ) const

pure virtual

Returns the number of seats for this license.

getUpdatesExpirationDate()

virtual FLE_DLL void FlowEngine::LicenseInfoInterface::getUpdatesExpirationDate ( DateTime &  outDate ) const

pure virtual

Returns the active license updates expiration date

Parameters

[out]

outDate

the date after which it will not be possible to update this product anymore