A set made up of Container and Object. More...

#include <Item.h>

Inheritance diagram for cbe::Item:

Public Member Functions
cbe::ShareIds	getShareIds () const

cbe::ShareId	getShareFromUserId (cbe::UserId userId)

cbe::UserId	getUserFromShareId (cbe::UserId shareId)

std::string	aclTag () const

std::string	description () const

cbe::ItemId	id () const

cbe::ContainerId	parentId () const

cbe::ContainerId	oldParentId () const

std::string	name () const

std::string	path () const

cbe::UserId	ownerId () const

cbe::ContainerId	driveId () const

std::string	username () const

bool	idLoaded () const

bool	dataLoaded () const

cbe::Date	created () const

cbe::Date	updated () const

cbe::Date	deleted () const

cbe::ItemType	type () const

bool	hasPublished () const

Publish	getPublished () const

bool	hasSubscribe () const

Subscribe	getSubscribe () const

bool	operator< (const cbe::Item &rh) const

AclMap	aclMap () const

	operator bool () const
	Checks if the inherited instance is real. More...

Protected Member Functions
	Item (std::shared_ptr< Impl > pImpl)

template<class ImplT >
ImplT &	castImpl () const

Friends
class	CloudBackend

class	Container

class	Object

class	PublishManager

class	QueryResult

class	SubscribeManager

std::ostream &	operator<< (std::ostream &os, const Item &item)

Detailed Description

A set made up of Container and Object.

Class for an Item. This is class is the base class of Objects and Containers.

Member Function Documentation

◆ aclMap()

AclMap cbe::Item::aclMap ( ) const

Retrieve the map of the permissions the users and groups for this item.

◆ aclTag()

std::string cbe::Item::aclTag ( ) const

the ACL of the item

◆ created()

cbe::Date cbe::Item::created ( ) const

Returns the creation date in Unix epoch time.

◆ dataLoaded()

bool cbe::Item::dataLoaded ( ) const

if data was loaded

◆ deleted()

cbe::Date cbe::Item::deleted ( ) const

Returns the deleted date, if applicable (i.e. is in the bin), in Unix epoch time

◆ description()

std::string cbe::Item::description ( ) const

A item text description where applicable

◆ driveId()

cbe::ContainerId cbe::Item::driveId ( ) const

Returns which drive number the container resides on.

◆ getPublished()

Publish cbe::Item::getPublished ( ) const

Gets the publish information

See also: hasPublished()

◆ getShareFromUserId()

cbe::ShareId cbe::Item::getShareFromUserId ( cbe::UserId userId )

Get the shareId by reference of userId

◆ getShareIds()

cbe::ShareIds cbe::Item::getShareIds ( ) const

a map of share ids for this item

◆ getSubscribe()

Subscribe cbe::Item::getSubscribe ( ) const

Gets the subscribe information

See also: hasSubscribe()

◆ getUserFromShareId()

cbe::UserId cbe::Item::getUserFromShareId ( cbe::UserId shareId )

Get the userId reference of shareId

◆ hasPublished()

bool cbe::Item::hasPublished ( ) const

Checks if it has published info and if getPublished() returns a valid object.

◆ hasSubscribe()

bool cbe::Item::hasSubscribe ( ) const

Checks if it has subscribe info and if getSubscribe() returns a valid object.

◆ id()

cbe::ItemId cbe::Item::id ( ) const

Returns an Items id.

◆ idLoaded()

bool cbe::Item::idLoaded ( ) const

if the query did get a resultset.

◆ name()

std::string cbe::Item::name ( ) const

Returns the name of the item.

◆ oldParentId()

cbe::ContainerId cbe::Item::oldParentId ( ) const

Returns the id of the Items old parent container id in cases where the item has just been moved.

◆ operator bool()

cbe::Item::operator bool ( ) const

explicit

Checks if the inherited instance is real.

An "unreal" instance implies typically a failed event.

Relies on the Default constructor cbe::DefaultCtor

Returns: true : is real; false : unreal; got nullptr; if current instance is unbound/undefined. I.e., if it is only default constructed.

◆ ownerId()

cbe::UserId cbe::Item::ownerId ( ) const

Returns the owner id number.

◆ parentId()

cbe::ContainerId cbe::Item::parentId ( ) const

Returns the id of the Items parent container id.

◆ path()

std::string cbe::Item::path ( ) const

Returns the path if applicable.

◆ type()

cbe::ItemType cbe::Item::type ( ) const

Container or Object, see enum in Types.h

◆ updated()

cbe::Date cbe::Item::updated ( ) const

Returns the updated date/time in Unix epoch time

◆ username()

std::string cbe::Item::username ( ) const

Returns the username of the owner if applicable.

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

include/cbe/Item.h

Public Member Functions

Protected Member Functions

Friends