ServiceDisabledError Class Reference

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

#include <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
Extent	GetExtent () const
	Gets the extent for which the service is disabled.
Public Member Functions inherited from Error
char const *	what () const noexcept override
	Get the error message.
virtual std::shared_ptr< Error >	Clone () const =0
	Clone the error.
virtual ErrorType	GetErrorType () const
	Get the error type.
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.

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

Private Attributes
Extent	mExtent

Additional Inherited Members
Public 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.

Member Function Documentation

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:

• /home/mbaldwin/docs/mip-sdk-for-cpp/src/api/mip/error.h