|
Ananas Library 0.9.5
|
Базовый класс для невизуальных классов (моделей в терминологии MVC) Ананаса, которым необходим доступ к базе данных. Наследует QObject. Подробнее...
#include <aobject.h>
Открытые слоты | |
| virtual QString | Uid () |
| Возвращает уникальный идентификатор объекта из базы данных. | |
| virtual bool | IsSelected () |
| Checks if object selected. | |
| virtual bool | IsMarkDeleted (const QString &tname="") |
| Checks "Deleted" marker. | |
| virtual bool | IsMarked () |
| Checks "Marked" marker. | |
| virtual int | SetMarkDeleted (bool Deleted, const QString &tablename="") |
| Устанавливает признак логического удаления объекта (записи SQL таблицы) | |
| virtual int | SetMarked (bool Marked) |
| Выставляет отметку на объекте. | |
| virtual int | New () |
| Add new object record in database. | |
| virtual int | Copy () |
| Создает новый объект, являющийся клоном текущего объекта. | |
| virtual int | Delete () |
| Удаляет текущий объект из базы данных. | |
| virtual int | Update () |
| Обновляет запись в базе данных текущеми значениями. | |
| virtual int | Conduct () |
| virtual int | UnConduct () |
| virtual bool | IsConducted () |
| virtual QString | Kind (const QString &name=QString::null) |
| Вид объекта, так как он описан в метаданных. . | |
| virtual QVariant | Value (const QString &name, const QString &tableName="") |
| Return field value of the primary object database table. | |
| virtual int | SetValue (const QString &name, const QVariant &value, const QString &tableName="") |
| Set field value of the primary object database table. | |
| virtual QVariant | sysValue (const QString &name, const QString &tableName="") |
| Gets system field value. | |
| virtual int | setSysValue (const QString &name, QVariant value, const QString &tableName="") |
| Sets system field value. | |
| virtual int | SetFilter (const QString &valname, const QVariant &value) |
| Задает фильтр записей/объектов | |
| virtual int | ClearFilter () |
| Чистит фильтр записей/объектов. | |
| virtual int | TableSetFilter (const QString &tname, const QString &valname, const QVariant &value) |
| Устанавливает вильтр записей табличной части объекта. | |
| virtual int | TableClearFilter (const QString &tname) |
| Чистит фильтр записей указанной табличной части объекта. | |
| virtual bool | IsFiltred () |
| Показывает наличие активного фильтра | |
Открытые члены | |
| aObject (QObject *parent=0, const char *name=0) | |
| Конструктор для создания абстрактного объекта. | |
| aObject (const QString &oname, aDatabase *adb, QObject *parent=0, const char *name=0) | |
| Создает объект как модель данных, описанную в метаданных. | |
| aObject (aCfgItem context, aDatabase *adb, QObject *parent=0, const char *name=0) | |
| Создает объект как модель данных, описанную в метаданных. | |
| virtual | ~aObject () |
| Виртуальный деструктор . | |
| virtual bool | checkStructure () |
| Not implemented. | |
| ERR_Code | init () |
| Вспомогоательный метод. Проверяет необходимость вызова метода initObject() и вызывает его. | |
| ERR_Code | decodeDocNum (QString nm, QString &pref, int &num) |
| Осуществляет выделение символьного префикса из строки. | |
| virtual ERR_Code | select (Q_ULLONG id) |
| Позиционирует указатель в БД на запись, соотвествующую объекту с указанным идентификатором. | |
| Q_ULLONG | getUid () |
| Возвращает уникальный идентификатор объекта из базы данных. | |
| bool | selected (const QString &tablename="") |
| Показывает задан ли текущий объект или запись в его табличной части. | |
| ERR_Code | select (const QString &query, const QString &tableName="") |
| Осуществляет SQL запрос. | |
| aDataTable * | table (const QString &name="") |
| Возвращает одну из таблиц бизнес-объекта по ее имени. | |
| virtual Q_ULLONG | docId () |
| Возвращает id документа в базе данных. | |
| virtual bool | Next (const QString &tableName="") |
| Перемещает указатель на следующую запись SQL таблицы. | |
| virtual bool | Prev (const QString &tableName="") |
| Перемещает указатель на предыдующую запись SQL таблицы. | |
| virtual bool | First (const QString &tableName="") |
| Перемещает указатель на первую запись SQL таблицы. | |
| virtual bool | Last (const QString &tableName="") |
| Перемещает указатель на последнюю запись SQL таблицы. | |
| virtual int | TableUpdate (const QString &tablename) |
| Обновляет базу данных данными табличной части объекта. | |
| virtual QString | displayString () |
| Возвращает строку, предназначенную для отображения пользователю объекта сложного типа. | |
| virtual int | LastErrorCode () |
| Возвращает код последней ошибки. | |
| virtual QString | LastErrorMessage () |
| Возвращает сообщение, поясняющее последнюю ошибку. . | |
Открытые атрибуты | |
| aCfg * | md |
| aCfgItem | obj |
| aDatabase * | db |
Защищенные члены | |
| virtual aCfgItem | displayStringContext () |
| Возвращает контекст (узел дерева) метаданных для вычисления строкового представления сложного типа. | |
| virtual ERR_Code | setObject (aCfgItem newobject) |
| Задает метатип объекта. | |
| virtual ERR_Code | initObject () |
| Инициализирует объект при его создании. | |
| bool | isInited () |
| void | setInited (bool flag) |
| ERR_Code | tableInsert (const QString &dbname, aCfgItem obj, const QString &name="") |
| Insert table name and its link into internal buffer. | |
| ERR_Code | tableInsert (const QString &dbname, const QString &name="") |
| Insert table name and its link into internal buffer. | |
| ERR_Code | tableRemove (const QString &name="") |
| Remove table from buffer. | |
| virtual QVariant | tValue (const QString &tablename, const QString &name) |
| Return field value of the secondary object database table. | |
| virtual ERR_Code | setTValue (const QString &tablename, const QString &name, const QVariant &value) |
| Set field value of the secondary object database table. | |
| virtual QString | trSysName (const QString &sname) |
| Not implemented. | |
| void | setSelected (bool sel, const QString &tablename="") |
| Явно задает состояние выбранности объекта или записи его табличной части. | |
| virtual ERR_Code | setTFilter (const QString &tname, const QString &valname, const QVariant &value) |
| Устанавливает вильтр записей табличной части объекта. | |
| virtual ERR_Code | clearTFilter (const QString &tname) |
| Чистит фильтр записей указанной табличной части объекта. | |
| void | setLastError (int, QString) |
| Задает значения свойствам lastErrorCode и lastErrorMessage класса | |
Защищенные данные | |
| bool | concrete |
Базовый класс для невизуальных классов (моделей в терминологии MVC) Ананаса, которым необходим доступ к базе данных. Наследует QObject.
| aObject::aObject | ( | QObject * | parent = 0, |
| const char * | name = 0 |
||
| ) |
Конструктор для создания абстрактного объекта.
| aObject::aObject | ( | const QString & | oname, |
| aDatabase * | adb, | ||
| QObject * | parent = 0, |
||
| const char * | name = 0 |
||
| ) |
Создает объект как модель данных, описанную в метаданных.
Перекрестные ссылки aDatabase::cfg, aCfg::find(), setLastError() и setObject().
| aObject::aObject | ( | aCfgItem | context, |
| aDatabase * | adb, | ||
| QObject * | parent = 0, |
||
| const char * | name = 0 |
||
| ) |
Создает объект как модель данных, описанную в метаданных.
Перекрестные ссылки setObject().
|
virtual |
Виртуальный деструктор .
|
virtual |
Not implemented.
|
virtualslot |
Чистит фильтр записей/объектов.
Фильтр влияет на навигацию и выбор текущего объекта.
Перекрестные ссылки clearTFilter().
Используется в aDocument::ClearFilter().
|
virtualslot |
\if english
\brief Conducts document.
Have to be reimplemented. Added for wDocument compatibility.
\return error code - abstract object - err_abstractobj.
\endif
\if russian
\brief Проводит документ.
Следует переопределить в наследующем классе.
Предназначена для wDocument.
\return код ошибки - абстрактный обект - err_abstractobj.
Используется в wDocument::TurnOn().
|
virtualslot |
Создает новый объект, являющийся клоном текущего объекта.
Copy current selected object data in database.
Перекрестные ссылки aDataTable::Copy() и table().
Используется в aCatalogue::Copy() и aDocument::Copy().
| ERR_Code aObject::decodeDocNum | ( | QString | nm, |
| QString & | pref, | ||
| int & | num | ||
| ) |
Осуществляет выделение символьного префикса из строки.
TODO перенести этот метод в сервисный класс.
Перекрестные ссылки aLog::print().
Используется в aDocJournal::findDoc(), aDocJournal::Select(), aDocJournal::selectionFilter() и aDocJournal::setNumber().
|
virtualslot |
Удаляет текущий объект из базы данных.
Переопределяется в aRole и aUser.
Перекрестные ссылки getUid(), aDatabase::markDeleted(), setSelected() и table().
Используется в aCatalogue::Delete() и aDocument::Delete().
|
virtual |
Возвращает строку, предназначенную для отображения пользователю объекта сложного типа.
Строковое представление сложного типа определяется разработчиком бизнес-схемы в дизайнере при проектировании этого типа. Например, строковым представлением объекта "Счет" может быть значение одного из его полей. Дата или Номер.
Перекрестные ссылки aCfg::attr(), displayStringContext(), aLog::print(), aCfg::sText(), aDataTable::sysValue() и table().
|
protectedvirtual |
Возвращает контекст (узел дерева) метаданных для вычисления строкового представления сложного типа.
Переопределяется в aCatalogue и aCatGroup.
Перекрестные ссылки aCfg::find().
Используется в displayString().
|
virtual |
Возвращает id документа в базе данных.
Переопределяется в aDocJournal.
Используется в aDocument::GetDocumentValue().
|
virtual |
Перемещает указатель на первую запись SQL таблицы.
Таким образом меняется текущий объект.
Перекрестные ссылки table().
Используется в aDocument::First(), aIRegister::First() и aUser::First().
| Q_ULLONG aObject::getUid | ( | ) |
Возвращает уникальный идентификатор объекта из базы данных.
Перекрестные ссылки selected(), aDataTable::sysValue(), table() и Uid().
Используется в aDocument::Copy(), aDocument::Delete(), Delete(), aARegister::deleteDocument(), aIRegister::deleteDocument(), aDocJournal::findDocument(), aDocument::First(), aDocument::IsSignedIn(), aDocument::Last(), aARegister::New(), aDocument::New(), aIRegister::New(), aCatalogue::New(), aDocument::Next(), aDocument::Prev(), aDocument::Select(), aIRegister::SelectByDoc(), aCatGroup::SelectChild(), aIRegister::SetDocument(), aCatGroup::SetParent(), aDocument::TableNewLine(), Uid(), aWidget::uid() и aARegister::Update().
| ERR_Code aObject::init | ( | ) |
Вспомогоательный метод. Проверяет необходимость вызова метода initObject() и вызывает его.
Перекрестные ссылки initObject().
Используется в setObject().
|
protectedvirtual |
Инициализирует объект при его создании.
Переопределяется в aARegister, aCatalogue, aCatGroup, aDocJournal, aDocument, aIRegister, aReport, aRole и aUser.
Перекрестные ссылки aDatabase::cfg, aLog::print() и setLastError().
Используется в init(), aCatalogue::initObject(), aCatGroup::initObject(), aDocument::initObject(), aIRegister::initObject(), aReport::initObject(), aRole::initObject() и aUser::initObject().
|
virtualslot |
\if english
\brief Checks if document has been conducted.
Have to be overrided. Added for wDocument compatibility.
\return error code - abstract object - err_abstractobj.
\endif
\if russian
\brief Проверяет проведен ли документ.
Ничего не делает. Следует переопределить в наследующем классе.
Предназначена для wDocument.
\return код ошибки - абстрактный обект - err_abstractobj.
Используется в aForm::SignIn().
|
virtualslot |
Checks "Deleted" marker.
Перекрестные ссылки aDataTable::sysFieldExists(), aDataTable::sysValue() и table().
Используется в aDocument::IsMarkDeleted().
|
virtualslot |
Checks "Marked" marker.
Перекрестные ссылки aDataTable::sysFieldExists(), aDataTable::sysValue() и table().
Используется в aDocument::IsMarked().
|
virtualslot |
Checks if object selected.
Перекрестные ссылки selected().
|
virtualslot |
Вид объекта, так как он описан в метаданных. .
Перекрестные ссылки aCfg::objClass().
|
virtual |
Перемещает указатель на последнюю запись SQL таблицы.
Таким образом меняется текущий объект.
Перекрестные ссылки table().
Используется в aDocument::Last(), aIRegister::Last() и aUser::Last().
|
virtual |
Возвращает код последней ошибки.
Используется в aDocJournal::deleteDocument(), aARegister::initObject(), aDocJournal::initObject(), aDocument::New(), aDocument::TableDelete(), aDocument::TableNewLine() и aDocument::Update().
|
virtual |
Возвращает сообщение, поясняющее последнюю ошибку. .
|
virtualslot |
Add new object record in database.
Перекрестные ссылки selected(), setSelected() и table().
Используется в aARegister::New(), aCatGroup::New(), aDocument::New(), aIRegister::New(), aWidget::New() и aCatalogue::New().
|
virtual |
Перемещает указатель на следующую запись SQL таблицы.
Таким образом меняется текущий объект.
Перекрестные ссылки table().
Используется в aDocument::Next(), aIRegister::Next() и aUser::Next().
|
virtual |
Перемещает указатель на предыдующую запись SQL таблицы.
Таким образом меняется текущий объект.
Перекрестные ссылки table().
Используется в aDocument::Prev(), aIRegister::Prev() и aUser::Prev().
| ERR_Code aObject::select | ( | const QString & | query, |
| const QString & | tableName = "" |
||
| ) |
Осуществляет SQL запрос.
В случае успешного выполнения запроса, первая запись таблицы результатов становится текущей.
Перекрестные ссылки setSelected() и table().
|
virtual |
Позиционирует указатель в БД на запись, соотвествующую объекту с указанным идентификатором.
Переопределяется в aDocument.
Перекрестные ссылки aCfg::find(), setObject(), setSelected(), table() и aDatabase::uidType().
Используется в aDocJournal::findDoc(), aARegister::New(), aIRegister::New(), aCatGroup::Select(), aWidget::Select(), aDocument::select(), aForm::SelectByCurrent(), aCatGroup::SelectChild(), aCatalogue::setMarkDeletedElement() и aCatGroup::SetParent().
| bool aObject::selected | ( | const QString & | tablename = "" | ) |
Показывает задан ли текущий объект или запись в его табличной части.
Заданность текущего объекта имеет тот смысл, что какая то из записей SQL таблицы выбрана и имеется возможность работать с ее полями, хранящими значения свойств объекта. Если задан не обязательный параметр, то осуществляется проверка на возможность работы с записями указанной табличной части объекта.
| tablename | -имя табличной части объекта. Необязательный параметр, имеющий значение "" по-умолчанию. |
Перекрестные ссылки table().
Используется в aCatalogue::Delete(), aDocument::Delete(), aDocJournal::getDate(), aDocJournal::getNumber(), aDocJournal::getSerialNumber(), getUid(), aCatalogue::GroupSelect(), IsSelected(), New(), aCatGroup::parentUid(), aDocJournal::setDate() и aDocJournal::setNumber().
|
protected |
Задает значения свойствам lastErrorCode и lastErrorMessage класса
Также выводит в лог сообщение об ошибке.
| errorCode | - (in) код ошибки для записи в свойство lastErrorCode |
| errorMessage | - (in) сообщение об ошибке для записи в свойство lastErrorMessage |
Перекрестные ссылки aLog::print().
Используется в aObject(), aIRegister::deleteDocument(), aDocJournal::deleteDocument(), aIRegister::deleteTable(), aDocument::GetDocumentValue(), aARegister::getSaldo(), aARegister::getSaldoByManyDimensions(), aARegister::initObject(), aDocJournal::initObject(), initObject(), aCatGroup::New(), aDocument::New(), aReport::save(), SetMarkDeleted(), SetMarked(), table(), aDocument::TableDelete(), tableInsert(), aDocument::TableNewLine(), tableRemove(), TableUpdate(), aCatalogue::Update(), aDocument::Update() и Update().
|
virtualslot |
Устанавливает признак логического удаления объекта (записи SQL таблицы)
Перекрестные ссылки setLastError(), aDataTable::sysFieldExists() и table().
Используется в aDocument::SetMarkDeleted() и aCatalogue::setMarkDeletedElement().
|
virtualslot |
Выставляет отметку на объекте.
Перекрестные ссылки setLastError(), aDataTable::sysFieldExists() и table().
Используется в aDocument::SetMarked().
|
protectedvirtual |
|
virtualslot |
Sets system field value.
| name | (in) - field name. |
| value | (in) - sets value. |
Переопределяется в aDocument.
Перекрестные ссылки table().
Используется в aRole::SetName() и SetValue().
|
virtualslot |
Set field value of the primary object database table.
| name | - field name |
| value | - field value |
| tableName | (in) - name of table field belongs to. Optional. default value - "". |
Перекрестные ссылки setSysValue(), aDataTable::setValue(), table() и trSysName().
Используется в aWidget::Update() и wCatalogue::valueChanged().
|
virtualslot |
Gets system field value.
| name | (in) - field name. |
Переопределяется в aDocument.
Перекрестные ссылки aDataTable::sysFieldExists(), aDataTable::sysValue() и table().
Используется в aUser::addRole(), aRole::addUser(), aUser::delRole(), aRole::delUser(), aCatalogue::getMarkDeletedList(), aRole::GetName(), aUser::getRoles(), aRole::hasPermission(), aUser::hasRole(), aRole::hasUser(), aCatalogue::idGroupByElement(), aEngine::OpenForm() и Value().
| aDataTable * aObject::table | ( | const QString & | name = "" | ) |
Возвращает одну из таблиц бизнес-объекта по ее имени.
Перекрестные ссылки setLastError().
Используется в aRole::addPermission(), aUser::addRole(), aDocument::Copy(), Copy(), aCatalogue::delElement(), aCatalogue::Delete(), Delete(), aRole::Delete(), aUser::Delete(), aARegister::deleteDocument(), aDocJournal::deleteDocument(), aCatalogue::delGroup(), aUser::delRole(), displayString(), aDocJournal::docId(), aCatalogue::FindById(), aDocJournal::findDoc(), aDocJournal::findDocument(), First(), aDocJournal::getDate(), aIRegister::GetDocument(), aCatalogue::getGroupUserFields(), aCatalogue::getMarkDeletedList(), aDocJournal::getNumber(), aARegister::getSaldo(), aARegister::getSaldoByManyDimensions(), aDocJournal::getSerialNumber(), aDocument::getTable(), getUid(), aCatalogue::getUserFields(), aUser::getUserId(), aCatalogue::GroupSelect(), aCatalogue::GroupSysValue(), aRole::hasPermission(), aUser::hasRole(), aCatalogue::idGroupByElement(), aARegister::initObject(), IsMarkDeleted(), IsMarked(), Last(), aARegister::New(), aDocument::New(), aIRegister::New(), New(), aCatalogue::New(), aUser::New(), aRole::New(), aDocJournal::New(), aCatalogue::newElement(), aCatalogue::newGroup(), Next(), aCatGroup::parentUid(), Prev(), aDocument::Seek(), aRole::Select(), aUser::Select(), aCatalogue::Select(), select(), aDocument::Select(), aIRegister::Select(), aDocJournal::Select(), aIRegister::SelectByDoc(), aCatalogue::selectByLevel(), aDocJournal::selectDocument(), selected(), aDocJournal::setDate(), SetMarkDeleted(), aCatalogue::setMarkDeletedElement(), SetMarked(), aDocJournal::setNumber(), aCatGroup::SetParent(), setSelected(), setSysValue(), setTValue(), SetValue(), aExtSQL::SqlFieldName(), aExtSQL::SqlTableName(), sysValue(), aDocument::TableDelete(), aDocument::TableFirst(), aDocument::TableLast(), aDocument::TableNewLine(), aDocument::TableNext(), aDocument::TablePrev(), TableUpdate(), aDocument::TableValue(), tValue(), aARegister::Update(), Update() и Value().
|
virtualslot |
Чистит фильтр записей указанной табличной части объекта.
Вспомогательный метод. Делегирует вызов методу aObject::clearTFilter( const QString &)
| tname | - имя табличной части объекта. |
Перекрестные ссылки clearTFilter().
|
protected |
Insert table name and its link into internal buffer.
Buffer used for finding table by its md name.
| dbname | - database name of table |
| obj | - md object, used for aDataTable initing |
| name | - name of table, used for finding table in buffer |
Перекрестные ссылки setLastError(), aDataTable::setObject() и aDatabase::table().
Используется в aARegister::initObject(), aCatalogue::initObject(), aCatGroup::initObject(), aDocJournal::initObject(), aDocument::initObject(), aIRegister::initObject(), aRole::initObject() и aUser::initObject().
|
protected |
Insert table name and its link into internal buffer.
Buffer used for finding table by its md name. table not inited by md object
| dbname | - database name of table |
| name | - name of table, used for finding table in buffer |
Перекрестные ссылки setLastError() и aDatabase::table().
|
protected |
Remove table from buffer.
| name | - table name |
Перекрестные ссылки setLastError().
|
virtualslot |
Устанавливает вильтр записей табличной части объекта.
Вспомогательный метод. Делегирует вызов методу aObject::setTFilter( const QString &, const QString &, const QVariant &)
| tname | - имя табличной части |
| valname | - имя поля, используемого для фильтрации |
| value | - значение поля, используемое для фильтрации |
Перекрестные ссылки setTFilter().
|
virtual |
Обновляет базу данных данными табличной части объекта.
Перекрестные ссылки setLastError() и table().
Используется в aDocument::TableUpdate(), aCatalogue::Update(), aRole::Update(), aUser::Update() и aUser::UpdateRole().
|
protectedvirtual |
Not implemented.
Переопределяется в aARegister и aDocument.
Используется в SetValue() и Value().
|
virtualslot |
Возвращает уникальный идентификатор объекта из базы данных.
Перекрестные ссылки getUid().
Используется в aDocument::Copy(), aDocJournal::deleteDocument(), getUid() и aDocument::New().
|
virtualslot |
\if english
\brief Unconducts document.
Have to be reimplemented. Added for wDocument compatibility.
\return error code - abstract object - err_abstractobj.
\endif
\if russian
\brief Отменяет проведение документа.
Следует переопределить в наследующем классе.
Предназначена для wDocument.
\return код ошибки - абстрактный обект - err_abstractobj.
Используется в wDocument::TurnOff().
|
virtualslot |
Обновляет запись в базе данных текущеми значениями.
Переопределяется в aRole и aUser.
Перекрестные ссылки setLastError() и table().
Используется в aIRegister::New(), aARegister::Update(), aCatalogue::Update(), aDocument::Update(), aRole::Update(), aUser::Update(), aWidget::Update() и wDocument::Update().
|
virtualslot |
Return field value of the primary object database table.
| name | (in) - field name |
| tableName | (in) - name of table field belongs to. Optional. default value - "". |
Перекрестные ссылки sysValue(), table(), trSysName() и aDataTable::value().
Используется в aCatGroup::SetParent(), aDocument::Value() и aIRegister::Value().