1.26.2.1
Gameface
cohtml::IDataStorageRequest Class Referenceabstract

Encapsulates a data storage request. More...

Public Types

enum  RequestType { Key, Value }
 

Public Member Functions

 IDataStorageRequest ()
 
virtual ~IDataStorageRequest ()
 
virtual RequestType GetRequestType () const =0
 Get the request type. More...
 
virtual const char * GetId () const =0
 The ID for which the data is requested. More...
 
virtual const char * GetKey () const =0
 The key for which the data is requested This should be called when the request type is RequestType::Value. More...
 
virtual unsigned long GetIndex () const =0
 The index for which the data is requested This should be called when the request type is RequestType::Key. More...
 

Detailed Description

Encapsulates a data storage request.

Member Enumeration Documentation

◆ RequestType

Enumerator
Key 
Value 

Constructor & Destructor Documentation

◆ IDataStorageRequest()

cohtml::IDataStorageRequest::IDataStorageRequest ( )

◆ ~IDataStorageRequest()

virtual cohtml::IDataStorageRequest::~IDataStorageRequest ( )
virtual

Member Function Documentation

◆ GetId()

virtual const char* cohtml::IDataStorageRequest::GetId ( ) const
pure virtual

The ID for which the data is requested.

◆ GetIndex()

virtual unsigned long cohtml::IDataStorageRequest::GetIndex ( ) const
pure virtual

The index for which the data is requested This should be called when the request type is RequestType::Key.

◆ GetKey()

virtual const char* cohtml::IDataStorageRequest::GetKey ( ) const
pure virtual

The key for which the data is requested This should be called when the request type is RequestType::Value.

◆ GetRequestType()

virtual RequestType cohtml::IDataStorageRequest::GetRequestType ( ) const
pure virtual

Get the request type.