Opaque pointer to a server-side resource i.e. a Case object. More...

#include <Handle.h>

Public Member Functions
	Handle (int id, std::string uuid, std::string type, std::string tag, std::string description, double created_at, double modified_at)
	construct from std::string More...

	Handle (int id)
	construct from internal database id More...

	Handle (std::string uuid)
	construct from internal representation More...

	Handle (const Handle &source)
	copy constructor More...

Handle &	operator= (const Handle &source)
	assignment More...

	Handle (void)
	default constructor, constructs an invalid object More...

	~Handle (void)
	destructor More...

int	id () const

std::string	toString () const

std::string	type () const

std::string	tag () const

std::string	description () const

double	created_at () const

double	modified_at () const

bool	operator< (const Handle &rhs) const
	required to have Handles as keys in std::maps More...

bool	isValid (void) const
	client-side validation More...

Detailed Description

Opaque pointer to a server-side resource i.e. a Case object.

has a recognizable invalid value used when the operation that should have returned a handle is not successful; is persistent i.e. given an handle, the Case state can be fully restored

Constructor & Destructor Documentation

◆ Handle() [1/5]

Libpf::User::Handle::Handle	(	int	id,
		std::string	uuid,
		std::string	type,
		std::string	tag,
		std::string	description,
		double	created_at,
		double	modified_at
	)

construct from std::string

◆ Handle() [2/5]

Libpf::User::Handle::Handle ( int id )

construct from internal database id

◆ Handle() [3/5]

Libpf::User::Handle::Handle ( std::string uuid )

construct from internal representation

◆ Handle() [4/5]

Libpf::User::Handle::Handle ( const Handle & source )

copy constructor

◆ Handle() [5/5]

Libpf::User::Handle::Handle ( void )

default constructor, constructs an invalid object

◆ ~Handle()

Libpf::User::Handle::~Handle ( void )

destructor

Member Function Documentation

◆ created_at()

double Libpf::User::Handle::created_at ( ) const

Returns: gets the timestamp (UNIX epoch) when the Case object was created

◆ description()

std::string Libpf::User::Handle::description ( ) const

Returns: get case description

◆ id()

int Libpf::User::Handle::id ( ) const

Returns: get internal database id

◆ isValid()

bool Libpf::User::Handle::isValid ( void ) const

client-side validation

◆ modified_at()

double Libpf::User::Handle::modified_at ( ) const

Returns: gets the timestamp (UNIX epoch) when the Case object was last modified

◆ operator<()

bool Libpf::User::Handle::operator< ( const Handle & rhs ) const

required to have Handles as keys in std::maps

◆ operator=()

Handle & Libpf::User::Handle::operator= ( const Handle & source )

assignment

◆ tag()

std::string Libpf::User::Handle::tag ( ) const

Returns: get case tag

◆ toString()

std::string Libpf::User::Handle::toString ( ) const

Returns: get string representation of the handle itself

◆ type()

std::string Libpf::User::Handle::type ( ) const

Returns: get case type

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

libpf/user/Handle.h

Public Member Functions