CONZEPT 16 C++ API
|
#include "C16/Texts.hpp"
Texts of a database.
Public Member Functions | |
virtual Database & | database () const =0 |
Gets the database of the texts. More... | |
virtual Result | create (const std::string &name, Locking locking=Locking::NONE)=0 |
Creates a text. More... | |
virtual Result | erase (const std::string &name)=0 |
Deletes a text. More... | |
virtual Result | rename (const std::string &name, const std::string &name_renamed)=0 |
Renames a text. More... | |
virtual Result | copy (const std::string &name, const std::string &name_copy)=0 |
Copies a text. More... | |
|
pure virtual |
Creates a text.
name | Name of the text (1 to Text::NAME_LENGTH_LIMIT characters) | ||||
locking | Locking to apply to the text
|
Result::OK | Text created and locking applied. |
Result::EXISTS | Text with same name (case insensitive) already existent. |
Result::DEADLOCK | Deadlock occurred. |
Exception::Invalidity | Name invalid. |
Exception::Invalidity | Locking invalid. |
|
pure virtual |
Deletes a text.
name | Name of the text (case insensitive, 1 to Text::NAME_LENGTH_LIMIT characters) |
Result::OK | Text deleted. |
Result::LOCKED | Text locked. |
Result::NO_KEY | Text inexistent. |
Result::NO_RIGHTS | Permissions insufficient. |
Result::DEADLOCK | Deadlock occurred. |
Exception::Invalidity | Name invalid. |
|
pure virtual |
Renames a text.
name | Name of the text (case insensitive, 1 to Text::NAME_LENGTH_LIMIT characters) |
name_renamed | Name of the text after renaming it (1 to Text::NAME_LENGTH_LIMIT characters) |
Result::OK | Text renamed. |
Result::LOCKED | Text locked. |
Result::NO_KEY | Text inexistent. |
Result::EXISTS | Text with same name (case insensitive) already existent. |
Result::NO_RIGHTS | Permissions insufficient. |
Exception::Invalidity | Name invalid. |
|
pure virtual |
Copies a text.
name | Name of the text (case insensitve, 1 to Text::NAME_LENGTH_LIMIT characters) |
name_copy | Name of the copy of the text (1 to Text::NAME_LENGTH_LIMIT characters) |
Result::OK | Text copied. |
Result::LOCKED | Text locked. |
Result::NO_KEY | Text inexistent. |
Result::EXISTS | Text with same name (case insensitive) already existent. |
Result::NO_RIGHTS | Permissions insufficient. |
Result::DEADLOCK | Deadlock occurred. |
Exception::Invalidity | Name invalid. |