OXY-SYNC-DIRECTORY 1.0
OXY-SYNC-DIRECTORY Library Documentation
Loading...
Searching...
No Matches
oxy::directory::ISyncDirectory Struct Referenceabstract

Interface for synchronizing the metadata directory. More...

#include <api.hpp>

Public Member Functions

virtual int64_t count (std::string const &identifier)=0
 Count the number of metadata record in the directory for a given customer identifier.
virtual int64_t count_since (std::string const &identifier, std::string const &since)=0
 Count the number of metadata records in the directory for a given customer identifier since a specific time.
virtual void sync (std::string const &identifier, std::vector< std::string > const &oids)=0
 Synchronize the metadata records in the directory for a given customer identifier and a list of metadata IDs.
virtual void sync_all (std::string const &identifier)=0
 Synchronize all the metadata records in the directory for a given customer identifier.
virtual void sync_since (std::string const &identifier, std::string const &since)=0
 Synchronize the metadata records in the directory for a given customer identifier since a specific time.

Detailed Description

Interface for synchronizing the metadata directory.

This interface provides methods for counting and synchronizing the metadata directory based on customer identifier and metadta IDs. Implementations of this interface should provide the actual synchronization logic.

Member Function Documentation

◆ count()

virtual int64_t oxy::directory::ISyncDirectory::count ( std::string const & identifier)
pure virtual

Count the number of metadata record in the directory for a given customer identifier.

Parameters
identifierThe customer identifier
Returns
The number of metadata records

◆ count_since()

virtual int64_t oxy::directory::ISyncDirectory::count_since ( std::string const & identifier,
std::string const & since )
pure virtual

Count the number of metadata records in the directory for a given customer identifier since a specific time.

Parameters
identifierThe customer identifier
sinceThe timestamp to count records since
Returns
The number of metadata records since the specified time

◆ sync()

virtual void oxy::directory::ISyncDirectory::sync ( std::string const & identifier,
std::vector< std::string > const & oids )
pure virtual

Synchronize the metadata records in the directory for a given customer identifier and a list of metadata IDs.

Parameters
identifierThe customer identifier
oidsThe list of metadata IDs to synchronize

◆ sync_all()

virtual void oxy::directory::ISyncDirectory::sync_all ( std::string const & identifier)
pure virtual

Synchronize all the metadata records in the directory for a given customer identifier.

Parameters
identifierThe customer identifier

◆ sync_since()

virtual void oxy::directory::ISyncDirectory::sync_since ( std::string const & identifier,
std::string const & since )
pure virtual

Synchronize the metadata records in the directory for a given customer identifier since a specific time.

Parameters
identifierThe customer identifier
sinceThe timestamp to synchronize records since