|
Ananas Library 0.9.5
|
Определяет программный интерфейс для работы с бизнес объектами типа Документ и их атрибутами. Наследует aObject. Подробнее...
#include <adocument.h>
Открытые слоты | |
| virtual ERR_Code | New () |
| ScriptAPI. Создает и регистрирует в системном журнале объект aDocument. | |
| virtual ERR_Code | Delete () |
| ScriptAPI. Удаляет текущий документ. | |
| virtual ERR_Code | Update () |
| ScriptAPI. Обновляет информацию в базе данных. | |
| virtual ERR_Code | Select (QDateTime from, QDateTime to) |
| ScriptAPI. Выбирает документы по интервалу времени. | |
| virtual bool | Select () |
| virtual ERR_Code | Select (const QString &num) |
| ScriptAPI. Выбирает документы по номеру. | |
| virtual int | SelectDocument (QVariant uid) |
| ScriptAPI. Выбирает документ с заданным идентификатором. . | |
| virtual ERR_Code | Copy () |
| ScriptAPI. Копирует текущий документ . | |
| virtual bool | Next () |
| ScriptAPI. Переход к следующему документу. . | |
| virtual bool | Prev () |
| ScriptAPI. Переход к предыдущему документу . | |
| virtual bool | First () |
| ScriptAPI. Переходит к первому документу . | |
| virtual bool | Last () |
| ScriptAPI. Переходит к последнему документу . | |
| virtual ERR_Code | TableNewLine (const QString &tablename) |
| ScriptAPI. Добавляет новую строку табличной части документа. | |
| virtual ERR_Code | TableDelete (const QString &tablename) |
| ScriptAPI. Удаляет текущую строку табличной части документа. | |
| virtual ERR_Code | TableSelect (const QString &name) |
| ScriptAPI. Выбирает табличную часть документа по ее имени. | |
| virtual QVariant | TableValue (const QString &tablename, const QString &name) |
| ScriptAPI. Читает значение поля табличной части документа. | |
| virtual ERR_Code | TableSetValue (const QString &tablename, const QString &name, const QVariant &value) |
| ScriptAPI. Записывает значение в поле текущей строки табличной части документа. . | |
| virtual ERR_Code | TableUpdate (const QString &tablename="") |
| SrciptAPI. Обновляет текущую запись табличной части документа. | |
| virtual bool | TableNext (const QString &name) |
| ScriptAPI. Переход к следуещей записи в табличной части документа . | |
| virtual bool | TablePrev (const QString &name) |
| ScriptAPI. Переход к предыдущей записи в табличной части документа . | |
| virtual bool | TableFirst (const QString &name) |
| ScriptAPI. Переход к первой записи в табличной части документа . | |
| virtual bool | TableLast (const QString &name) |
| ScriptAPI. Переход к последней записи в табличной части документа . | |
| virtual bool | IsMarkDeleted () |
| ScriptAPI. Проверяет помечен ли документ как удаленный. . | |
| virtual bool | IsMarked () |
| ScriptAPI. Проверяет помечен ли документ. . | |
| virtual ERR_Code | SetMarkDeleted (bool Deleted) |
| ScriptAPI. Устанавливает флаг удаления. . | |
| virtual ERR_Code | SetMarked (bool Marked) |
| ScriptAPI Помечает документ. | |
| void | SetPrefix (const QString &pr) |
| ScriptAPI. Задает префикс документа. | |
| QString | Prefix () |
| ScriptAPI. Возвращает префикс документа. . | |
| virtual QVariant | Value (const QString &name, const QString &tableName="") |
| virtual ERR_Code | SetFilter (const QString &valname, const QVariant &value) |
| ScripAPI. Устанавливает фильтр на доступные документы. | |
| virtual ERR_Code | ClearFilter () |
| ScriptAPI. Сбрасывает фильтр. . | |
| ERR_Code | Conduct () |
| Deprecated. | |
| ERR_Code | UnConduct () |
| Deprecated. | |
| bool | IsConducted () |
| Deprecated. | |
| ERR_Code | SignIn () |
| ScriptAPI. Вызывает проведение документа. . | |
| ERR_Code | SignOut () |
| ScriptAPI. Отменяет проведение документа. . | |
| bool | IsSignedIn () |
| ScriptAPI. Проверяет, проведен ли документ. . | |
| void | Seek (int pos, const QString &tname) |
| ScriptAPI. Устанавливает позицию в табличной части документа на строку с заданным номером. . | |
| QVariant | GetDocumentValue (QVariant ide, const QString &fname) |
| ScriptAPI. Получение значения атрибута документа c указанным идентификатором. | |
| Открытые слоты унаследованные от aObject | |
| 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 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 () |
| Показывает наличие активного фильтра | |
Открытые члены | |
| aDocument (aCfgItem context, aDatabase *adb=0) | |
| Создает объект и инициализирует его по метаданным бизнес схемы. . | |
| aDocument (const QString &name, aDatabase *adb=0) | |
| virtual | ~aDocument () |
| virtual ERR_Code | select (Q_ULLONG uid) |
| virtual ERR_Code | initObject () |
| virtual QString | trSysName (const QString &sname) |
| virtual QVariant | sysValue (const QString &sname, const QString &="") |
| virtual ERR_Code | setSysValue (const QString &sname, QVariant value, const QString &="") |
| aSQLTable * | getTable (const QString &tablename) |
| Открытые члены унаследованные от aObject | |
| 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) |
| Осуществляет выделение символьного префикса из строки. | |
| 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 () |
| Возвращает сообщение, поясняющее последнюю ошибку. . | |
Дополнительные унаследованные члены | |
| Открытые атрибуты унаследованные от aObject | |
| aCfg * | md |
| aCfgItem | obj |
| aDatabase * | db |
| Защищенные члены унаследованные от aObject | |
| virtual aCfgItem | displayStringContext () |
| Возвращает контекст (узел дерева) метаданных для вычисления строкового представления сложного типа. | |
| virtual ERR_Code | setObject (aCfgItem newobject) |
| Задает метатип объекта. | |
| 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. | |
| 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 класса | |
| Защищенные данные унаследованные от aObject | |
| bool | concrete |
Определяет программный интерфейс для работы с бизнес объектами типа Документ и их атрибутами. Наследует aObject.
Объект класса предоставляет навигационный доступ ко всем документам, имеющим тип, указанный при инициализации объекта. С помощью методов класса можно управлять как документом целиком, так и отдельными его реквизитами. В том числе табличными частями, если они определены в метаданных у документа. Обеспечивает единообразный доступ к полям и таблицам документов, хранимых в базе данных. Информация о составе и структуре полей и табличных частей документа храниться в метаданных. Позволяет создавать, удалять, изменять, копировать, проводить и распроводить документы.
| aDocument::aDocument | ( | aCfgItem | context, |
| aDatabase * | adb = 0 ) |
Создает объект и инициализирует его по метаданным бизнес схемы. .
| context | - элемент метаданных бизнес схемы, инициализирующий объект. |
| adb | - ссылка на базу данных. |
Перекрестные ссылки aObject::aObject() и initObject().
Используется в Copy().
| aDocument::aDocument | ( | const QString & | name, |
| aDatabase * | adb = 0 ) |
Создает объект и инициализирует его по метаданным бизнес схемы. Документ инициализируется элементом метаданных, найденым по его имени, причем поиск осуществляется только среди документов.
| name | - имя документа в метаданных бизнес схемы. |
| adb | - ссылка на базу данных |
Перекрестные ссылки aObject::aObject() и initObject().
|
virtual |
Уничтожает объект. Используется для удаления системного журнала и освобождения занятой под него памяти.
|
virtualslot |
|
virtualslot |
ScriptAPI. Копирует текущий документ .
\if english Copy current document. Create document with header and table pats like current document. New document have current date and next unical number. \endif
Перекрестные ссылки aDocument(), aObject::Copy(), aObject::getUid(), select(), aObject::table(), TableNewLine(), TableNext(), TableSelect(), TableSetValue(), TableUpdate(), TableValue() и aObject::Uid().
|
virtualslot |
ScriptAPI. Удаляет текущий документ.
Документ удаляется полностью вместе с табличными частями, также документ удаляется из системного журнала. Идентификатор документа не освободжается и повторно не используется.
Перекрестные ссылки aObject::Delete(), aObject::getUid(), IsConducted(), aLog::print(), aObject::selected() и UnConduct().
Используется в aDocJournal::Delete().
|
virtualslot |
ScriptAPI. Переходит к первому документу .
Перекрестные ссылки aObject::First() и aObject::getUid().
|
slot |
ScriptAPI. Получение значения атрибута документа c указанным идентификатором.
С помощью этого метода можно получить значение атрибута документа, не являющегося текущим. Вызов метода приводит к смене текущего документа. Для получения значения атрибута текущего документа используйте метод Value(...), унаследованный от aObject.
| docId | - id документа |
| fname | - имя поля в метаданных |
Перекрестные ссылки aObject::docId(), select(), aObject::setLastError() и Value().
| aSQLTable * aDocument::getTable | ( | const QString & | tname | ) |
Возвращает таблицу дакумента по имени. Функция позволяет получить ссылку на таблизу документа по ее имени.
| tname | - имя таблицы в бизнес схеме. |
Перекрестные ссылки aObject::table().
|
virtual |
Инициализирует объект элементом метаданных бизнес схемы. В процесе инициализации выполняется настройка на шапку документа и все его табличные части. После инициализации появляется возможность работать с полями и таблицами, используя их имена, определенные в бизнес схеме.
Переопределяет метод предка aObject.
Перекрестные ссылки aObject::initObject(), aDatabase::tableDbName() и aObject::tableInsert().
Используется в aDocument() и aDocument().
|
virtualslot |
ScriptAPI. Проверяет помечен ли документ как удаленный. .
|
virtualslot |
ScriptAPI. Проверяет помечен ли документ. .
|
slot |
ScriptAPI. Проверяет, проведен ли документ. .
Перекрестные ссылки aObject::getUid().
Используется в IsConducted().
|
virtualslot |
ScriptAPI. Переходит к последнему документу .
Перекрестные ссылки aObject::getUid() и aObject::Last().
|
virtualslot |
ScriptAPI. Создает и регистрирует в системном журнале объект aDocument.
Создает новую запись в БД с данными из шапки документа. При этом резервируется уникальный Id записи таблицы. При этом документ регистрируется в системном журнале и получает следующий по порядку номер.
Перекрестные ссылки aObject::getUid(), aObject::LastErrorCode(), aObject::New(), Prefix(), aLog::print(), aObject::setLastError(), SetPrefix(), aObject::table() и aObject::Uid().
|
virtualslot |
ScriptAPI. Переход к следующему документу. .
Перекрестные ссылки aObject::getUid() и aObject::Next().
|
slot |
ScriptAPI. Возвращает префикс документа. .
Используется в New().
|
virtualslot |
ScriptAPI. Переход к предыдущему документу .
Перекрестные ссылки aObject::getUid() и aObject::Prev().
|
slot |
ScriptAPI. Устанавливает позицию в табличной части документа на строку с заданным номером. .
| pos | - номер строки |
| tname | - имя таблицы |
Перекрестные ссылки aObject::setSelected() и aObject::table().
|
virtualslot |
ScriptAPI. Выбирает документы по номеру.
Номер задается как строка, которая содержит префикс и число. Если объект настроен на конкретный тип документа из бизнес схемы, выбираются только документы этого типа, в противном случае - все документы с таким номером.
| num | - |
Перекрестные ссылки aObject::getUid(), aObject::IsFiltred(), aObject::setSelected() и aObject::table().
|
virtualslot |
ScriptAPI. Выбирает документы по интервалу времени.
Выбирает из системного журнала документы, значение поля "дата" которых лежит в указанном диапазоне. Если объект настроен на конкретный тип документа из бизнес схемы, выбираются только документы этого типа, в противном случае - все документы журнала, соответствующие условию.
| from | - начальная дата диапазона, если дата isNull, первая дата журнала, |
| to | - конечная дата диапазона, если isNull - до наиболее позднего документа. |
Перекрестные ссылки aObject::getUid(), aObject::IsFiltred(), aObject::setSelected() и aObject::table().
|
virtual |
Выбирает документ с заданным идентификатором.
Переопределяет метод предка aObject.
Перекрестные ссылки aObject::select().
Используется в Copy(), aDocJournal::CurrentDocument(), aIRegister::GetDocument(), GetDocumentValue() и SelectDocument().
|
virtualslot |
ScriptAPI. Выбирает документ с заданным идентификатором. .
Перекрестные ссылки select().
|
virtualslot |
ScripAPI. Устанавливает фильтр на доступные документы.
Доступными становятся только документы, удовлетворяющие условию. Например, для получения всех накладных с номером 0003 нужно сделать примерно следующее:
| valname | - имя поля в метаданных |
| value | - Значение фильтра |
Перекрестные ссылки aObject::SetFilter().
|
virtualslot |
ScriptAPI. Устанавливает флаг удаления. .
| Deleted | - флаг удаления |
|
virtualslot |
ScriptAPI Помечает документ.
В последствии помеченные документы можно рассматривать как группу документов, подобранных для обработки.
| Marked | - флаг отметки |
|
slot |
ScriptAPI. Задает префикс документа.
Префикс документа используется для генерации номера документа.
| pr | - Новый префикс документа. |
Используется в New().
|
virtual |
Устанавливает значение системного поля. Используется для установки значения системного поля по его имени
| sname | - имя ситемного поля. |
| value | - устанавливаемое значение |
Переопределяет метод предка aObject.
|
slot |
ScriptAPI. Вызывает проведение документа. .
Перекрестные ссылки IsConducted().
Используется в Conduct().
|
slot |
ScriptAPI. Отменяет проведение документа. .
Перекрестные ссылки aARegister::deleteDocument(), aIRegister::deleteDocument(), IsConducted() и aLog::print().
Используется в UnConduct().
|
virtual |
Читает значение системного поля. Используется для получения значения системного поля по его имени
| sname | - имя ситемного поля. |
Переопределяет метод предка aObject.
|
virtualslot |
ScriptAPI. Удаляет текущую строку табличной части документа.
Также удаляются все записи, связанные с этой строкой во всех регистрах. Не работает для проведенных документов.
| tablename | - имя таблицы в бизнес схеме |
Перекрестные ссылки aIRegister::deleteTable(), IsConducted(), aObject::LastErrorCode(), aLog::print(), aObject::setLastError() и aObject::table().
|
virtualslot |
ScriptAPI. Переход к первой записи в табличной части документа .
| name | - имя таблицы из бизнес схемы. |
Перекрестные ссылки aObject::table().
|
virtualslot |
ScriptAPI. Переход к последней записи в табличной части документа .
| name | - имя таблицы из бизнес схемы. |
Перекрестные ссылки aObject::table().
|
virtualslot |
ScriptAPI. Добавляет новую строку табличной части документа.
Строка добавляется в таблицу текущего документа, если документ не выбран или не имеет таблицы с таким именем - возникает ошибка. При создании строки ей автоматически присваивается очередной номер.
| tablename | - имя таблицы в бизнес схеме. |
Перекрестные ссылки aObject::getUid(), IsConducted(), aObject::LastErrorCode(), aLog::print(), aObject::setLastError(), aObject::table() и TableUpdate().
Используется в Copy().
|
virtualslot |
ScriptAPI. Переход к следуещей записи в табличной части документа .
| name | - имя таблицы из бизнес схемы. |
Перекрестные ссылки aObject::table().
Используется в Copy().
|
virtualslot |
ScriptAPI. Переход к предыдущей записи в табличной части документа .
| name | - имя таблицы из бизнес схемы. |
Перекрестные ссылки aObject::table().
|
virtualslot |
ScriptAPI. Выбирает табличную часть документа по ее имени.
Используется, если документ имеет более одной табличной части.
| name | - имя таблицы |
Используется в Copy().
|
virtualslot |
ScriptAPI. Записывает значение в поле текущей строки табличной части документа. .
| tablename | - имя таблицы в бизнес схеме, |
| name | - имя поля в бизнес схеме, |
| value | - новое значение поля. |
Перекрестные ссылки aObject::setTValue().
Используется в Copy().
|
virtualslot |
SrciptAPI. Обновляет текущую запись табличной части документа.
Копирует информацию из буфера в текущую строку таблицы. Если имя не указано или задана пустая строка, обновляются все таблицы документа. Не работает для проведенного досумента.
| tablename | - имя таблицы в бизнес схеме |
Перекрестные ссылки IsConducted(), aLog::print() и aObject::TableUpdate().
Используется в Copy() и TableNewLine().
|
virtualslot |
ScriptAPI. Читает значение поля табличной части документа.
Используется для получения значения поля таблицы по именам таблицы и поля. При вызове функции используются имена, указанные в бизнес схеме. Кроме этого может использоваться продопределенное имя "TableLine" для получения номера текущей записи
| tablename | - имя таблицы в бизнес схеме |
| name | - имя поля в бизнес схеме |
Перекрестные ссылки aDataTable::sysValue(), aObject::table(), trSysName() и aObject::tValue().
Используется в Copy().
|
virtual |
Используется для перевода предопределенных имен для системных полей. Позволяет использовать для обращения к системным полям из скриптов назавания, близкие по смыслу к их назначению с учетом языка пользователя. Например к полю номер документа можно обратиться используя имя "НомерДок" или "DocNumber".
| sname | - одно из предопределенных имен поля. |
Переопределяет метод предка aObject.
Используется в TableValue().
|
virtualslot |
ScriptAPI. Обновляет информацию в базе данных.
Заносит запись из буфера ОЗУ в базу данных. Обновляется информация в шапке документа, табличных частях, журнале документов. Не работает для проведенных документов.
Перекрестные ссылки IsConducted(), aObject::LastErrorCode(), aObject::setLastError() и aObject::Update().
|
virtualslot |
Возвращает значения поля с именем = name основг\ной таблицы объекта.
| name | - имя поля |
Перекрестные ссылки aObject::Value().
Используется в aARegister::deleteDocument() и GetDocumentValue().