The user could not get access to the content due to a service being disabled. More...

#include <mip/error.h>

Inheritance diagram for ServiceDisabledError:

Public Types
enum class	Extent { User , Device , Platform , Tenant }
	Describes the extent for which the service is disabled. More...

Public Member Functions
	ServiceDisabledError (Extent extent, const std::string &requestId, const std::string &message, const std::string &name="ServiceDisabledError")

	ServiceDisabledError (Extent extent, const std::string &message, const std::map< std::string, std::string > &debugInfo, const std::map< std::string, std::string > sensitiveDebugInfo, const std::string &name="ServiceDisabledError")

std::shared_ptr< Error >	Clone () const override
	Clone the error.

ErrorType	GetErrorType () const override
	Get the error type.

Extent	GetExtent () const
	Gets the extent for which the service is disabled.

Public Member Functions inherited from AccessDeniedError
	AccessDeniedError (const std::string &message, const std::string &name="AccessDeniedError")

	AccessDeniedError (const std::string &message, const std::map< std::string, std::string > &debugInfo, const std::map< std::string, std::string > sensitiveDebugInfo, const std::string &name="AccessDeniedError")

Public Member Functions inherited from Error
char const *	what () const noexcept override
	Get the error message.

const std::string &	GetErrorName () const
	Get the error name.

const std::string &	GetMessage (bool maskPII=false) const
	Get the error message.

void	SetMessage (const std::string &msg)
	Set the error message.

void	AddDebugInfo (const std::string &key, const std::string &value, bool sensitive=false)
	Add debug info entry.

const std::map< std::string, std::string > &	GetDebugInfo () const
	Get debug info.

virtual	~Error ()

Private Member Functions
const std::string &	GetExtentString (Extent extent) const

Private Attributes
Extent	mExtent

Additional Inherited Members
Protected Member Functions inherited from Error
	Error (const std::string &message, const std::string &name, ErrorType type)

	Error (const std::string &message, const std::map< std::string, std::string > debugInfo, const std::map< std::string, std::string > sensitiveDebugInfo, const std::string &name, ErrorType type)

Protected Attributes inherited from Error
std::string	mMessage

std::map< std::string, std::string >	mDebugInfo

std::string	mName

ErrorType	mType

Detailed Description

The user could not get access to the content due to a service being disabled.

Member Enumeration Documentation

◆ Extent

enum class ServiceDisabledError::Extent

strong

Describes the extent for which the service is disabled.

Enumerator
User	Service is disabled for the user.
Device	Service is disabled for the device.
Platform	Service is disabled for the platform.
Tenant	Service is disabled for the tenant.

Constructor & Destructor Documentation

◆ ServiceDisabledError() [1/2]

ServiceDisabledError::ServiceDisabledError	(	Extent	extent,
		const std::string &	requestId,
		const std::string &	message,
		const std::string &	name = "ServiceDisabledError" )

inlineexplicit

◆ ServiceDisabledError() [2/2]

ServiceDisabledError::ServiceDisabledError	(	Extent	extent,
		const std::string &	message,
		const std::map< std::string, std::string > &	debugInfo,
		const std::map< std::string, std::string >	sensitiveDebugInfo,
		const std::string &	name = "ServiceDisabledError" )

inlineexplicit

Member Function Documentation

◆ Clone()

std::shared_ptr< Error > ServiceDisabledError::Clone ( ) const

inlineoverridevirtual

Clone the error.

Returns: a clone of the error.

Reimplemented from AccessDeniedError.

◆ GetErrorType()

ErrorType ServiceDisabledError::GetErrorType ( ) const

inlineoverridevirtual

Get the error type.

Returns: the error type.

Reimplemented from Error.

◆ GetExtent()

Extent ServiceDisabledError::GetExtent ( ) const

inline

Gets the extent for which the service is disabled.

Returns: Extent for which the service is disabled

◆ GetExtentString()

const std::string & ServiceDisabledError::GetExtentString ( Extent extent ) const

inlineprivate

Member Data Documentation

◆ mExtent

Extent ServiceDisabledError::mExtent

private

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

src/api/mip/error.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members