oxy::directory::ITimeline Struct Reference

Interface for interacting with the timeline service. More...

#include <services.hpp>

Public Member Functions
virtual int64_t	count (const std::string &identifier) const =0
	Counts the number of timeline records for a given customer identifier.
virtual int64_t	count_since (const std::string &identifier, const std::string &since) const =0
	Counts the number of timeline records for a given customer identifier since a specific timestamp.
virtual void	fetch (const std::string &identifier, const std::string &packName, const std::vector< std::string > &oids) const =0
	Fetches timeline records associated with the specified customer identifiers into a pack.
virtual void	fetch_all (const std::string &identifier, const std::string &packName) const =0
	Fetches all metadata records associated with the specified customer identifier.
virtual void	fetch_since (const std::string &identifier, const std::string &packName, const std::string &since) const =0
	Fetches timeline records associated with the specified customer identifier since a specific timestamp.
virtual void	open (const IConnectionPtr &conn)=0
	Opens a connection to the timeline service.

Detailed Description

Interface for interacting with the timeline service.

This interface provides methods for opening a connection to the timeline service, counting timeline records, and fetching timeline records based on a customer identifier and timestamps. Implementations of this interface should handle the specifics of communicating with the timeline service and retrieving the requested data.

Member Function Documentation

count()

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

pure virtual

Counts the number of timeline records for a given customer identifier.

Parameters

identifier

The customer identifier to count records for

Returns

The number of records for the specified customer identifier

count_since()

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

pure virtual

Counts the number of timeline records for a given customer identifier since a specific timestamp.

Parameters

identifier	The customer identifier to count records for
since	The timestamp to count records since

Returns

The number of records for the specified customer identifier since the specified timestamp

fetch()

virtual void oxy::directory::ITimeline::fetch ( const std::string & identifier, const std::string & packName, const std::vector< std::string > & oids ) const

pure virtual

Fetches timeline records associated with the specified customer identifiers into a pack.

Parameters

identifier	The customer identifier used to locate the records to fetch.
packName	The name of the pack where to fetch the datas.
oids	A collection of metadata identifiers (OIDs) to fetch.

fetch_all()

virtual void oxy::directory::ITimeline::fetch_all ( const std::string & identifier, const std::string & packName ) const

pure virtual

Fetches all metadata records associated with the specified customer identifier.

Parameters

identifier	The customer identifier used to locate the records to fetch.
packName	The name of the pack where to fetch the datas.

fetch_since()

virtual void oxy::directory::ITimeline::fetch_since ( const std::string & identifier, const std::string & packName, const std::string & since ) const

pure virtual

Fetches timeline records associated with the specified customer identifier since a specific timestamp.

Parameters

identifier	The customer identifier used to locate the records to fetch.
packName	The name of the pack where to fetch the datas.
since	The timestamp to fetch records since.

open()

virtual void oxy::directory::ITimeline::open ( const IConnectionPtr & conn )

pure virtual

Opens a connection to the timeline service.

Parameters

conn	A shared pointer to an IConnection interface