Ananas Library 0.9.5
|
Определяет программный интерфейс управления общим (системным) журналом документов. Наследует aObject. Подробнее...
#include <adocjournal.h>
Открытые слоты | |
aDocument * | CurrentDocument () |
Возвращает текущий документ. Полученный документ необходимо удалить после использования. | |
virtual ERR_Code | Delete () |
Удаляет текущий документ. | |
virtual ERR_Code | Select (QDateTime from, QDateTime to, const QString &mdName="") |
Выбирает документы определенного типа за некоторый период. | |
virtual ERR_Code | Select (const QString &num, const QString &mdName="") |
Выбирает документ определенного типа и номера. | |
![]() | |
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 () |
Показывает наличие активного фильтра | |
Открытые члены | |
aDocJournal (aCfgItem context, aDatabase *adb=0) | |
Конструктор. Инициализирует объект объектом метаданных. | |
aDocJournal (const QString &name, aDatabase *adb=0) | |
Конструктор. Инициализирует объект объектом метаданных с именем name. | |
aDocJournal (aDatabase *adb=0) | |
Конструктор. Создает экземпляр системного журнала, в котором хранятся ссылки на все созданные документы. | |
virtual ERR_Code | initObject () |
Выполняет реальную инициализацию объекта. Вызывается из всех конструкторов. . | |
ERR_Code | selectDocument (Q_ULLONG idd) |
Выбирает документ с заданным идентификатором. | |
virtual Q_ULLONG | docId () |
Возвращает id текущего документа. | |
int | docType () |
Получение типа текущего документа. | |
int | type () |
QString | nextNumber (const QString &prefix, int mdId) |
Генерирует следующий номер для документа. | |
QVariant | getDate () |
Возвращает дату текущего документа. | |
QString | getNumber () |
Возвращает строку префикс + номер текущего документа. | |
int | getSerialNumber () |
ERR_Code | setDate (QVariant date) |
Устанавливает дату текущего документа. | |
ERR_Code | setNumber (QVariant number) |
Устанавливает номер текущего документа. | |
virtual ERR_Code | New (Q_ULLONG idd, const QString &docPrefix, int type) |
Добавляет запись в системный журнал. | |
virtual ERR_Code | deleteDocument (Q_ULLONG idd) |
Удаляет документ с заданным идентификатором. | |
Q_ULLONG | findDocument (Q_ULLONG idd) |
Ищет документ в системном журнале по его идентификатору. | |
Q_ULLONG | findDoc (const QString &num, int type) |
Ищет документ по его номеру и типу. | |
QString | getPrefix () |
Выбирает префикс текущего документа. | |
QString | selectionFilter (QDateTime from, QDateTime to, const QString &mdName="", bool full=false) |
Формирует строку с булевым выражением, для использования при отборе записей в SQL запросе. | |
QString | selectionFilter (const QString &num, const QString &mdName="", bool full=false) |
Формирует строку с булевым выражением, для использования при отборе записей в SQL запросе. | |
![]() | |
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 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) |
Задает метатип объекта. | |
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 |
Определяет программный интерфейс управления общим (системным) журналом документов. Наследует aObject.
Невизуальный объект для работы с системным журналом документов базы данных. Все хранящиеся в базе данных Ананаса документы система регистрирует в журнале. Используется для доступа к системному журналу скриптами и визуальными объектами. Включается в объект aDocument, для обеспечения работы документа с ситемным журналом.
aDocJournal::aDocJournal | ( | aCfgItem | context, |
aDatabase * | adb = 0 ) |
Конструктор. Инициализирует объект объектом метаданных.
context | - объект метаданных |
adb | - ссылка на базу данных |
Перекрестные ссылки aObject::aObject() и initObject().
aDocJournal::aDocJournal | ( | const QString & | name, |
aDatabase * | adb = 0 ) |
Конструктор. Инициализирует объект объектом метаданных с именем name.
name | - имя объекта метаданных |
adb | - ссылка на базу данных |
Перекрестные ссылки aObject::aObject() и initObject().
aDocJournal::aDocJournal | ( | aDatabase * | adb = 0 | ) |
Конструктор. Создает экземпляр системного журнала, в котором хранятся ссылки на все созданные документы.
adb | - ссылка на базу данных |
Перекрестные ссылки initObject().
|
slot |
Возвращает текущий документ. Полученный документ необходимо удалить после использования.
Перекрестные ссылки docId(), docType() и aDocument::select().
Используется в Delete().
|
virtualslot |
Удаляет текущий документ.
Перекрестные ссылки CurrentDocument() и aDocument::Delete().
|
virtual |
Удаляет документ с заданным идентификатором.
idd | - идентификатор документа. |
Перекрестные ссылки findDocument(), aObject::LastErrorCode(), aLog::print(), aObject::setLastError(), aObject::table() и aObject::Uid().
|
virtual |
Возвращает id текущего документа.
Возвращает id документа в базе данных.
Переопределяет метод предка aObject.
Перекрестные ссылки aDataTable::sysValue() и aObject::table().
Используется в CurrentDocument(), docType() и getPrefix().
int aDocJournal::docType | ( | ) |
Получение типа текущего документа.
Перекрестные ссылки docId().
Используется в CurrentDocument(), Select() и selectionFilter().
Q_ULLONG aDocJournal::findDoc | ( | const QString & | number, |
int | type ) |
Ищет документ по его номеру и типу.
number | - номер документа, состоящий из префикса и номера |
type | - тип документа |
Перекрестные ссылки aObject::decodeDocNum(), aLog::print(), aObject::select(), aObject::setSelected(), aDataTable::sysValue(), aObject::table() и type().
Q_ULLONG aDocJournal::findDocument | ( | Q_ULLONG | idd | ) |
Ищет документ в системном журнале по его идентификатору.
idd | - номер документа |
Перекрестные ссылки aObject::getUid(), aLog::print(), aObject::setSelected() и aObject::table().
Используется в deleteDocument().
QVariant aDocJournal::getDate | ( | ) |
Возвращает дату текущего документа.
Перекрестные ссылки aObject::selected() и aObject::table().
QString aDocJournal::getNumber | ( | ) |
Возвращает строку префикс + номер текущего документа.
Перекрестные ссылки aObject::selected() и aObject::table().
QString aDocJournal::getPrefix | ( | ) |
int aDocJournal::getSerialNumber | ( | ) |
Возвращает номер текущего документа.
Перекрестные ссылки aObject::selected() и aObject::table().
|
virtual |
Выполняет реальную инициализацию объекта. Вызывается из всех конструкторов. .
Переопределяет метод предка aObject.
Перекрестные ссылки aObject::LastErrorCode(), aLog::print(), aObject::setLastError(), aDatabase::tableDbName() и aObject::tableInsert().
Используется в aDocJournal(), aDocJournal() и aDocJournal().
|
virtual |
Добавляет запись в системный журнал.
Запись добавляется после создания документа и использует информацию о его id в базе данных, префиксе номера и id в конфигурации. Номер досумента генерируется функцией nextNumber()
idd | - id базы данных. |
docPrefix | - перфикс номера документа. |
type | - id документа в конфигурации. |
Перекрестные ссылки nextNumber(), aLog::print(), selectDocument(), aObject::setSelected(), aObject::table() и type().
QString aDocJournal::nextNumber | ( | const QString & | prefix, |
int | mdId ) |
Генерирует следующий номер для документа.
Номер представляет собой строку, состоящую из префикса номера и числа. Номер документа генерируется используя префикс номера документа и его тип (id в конфигурации), как следующий за максимальным для даного сочетания. Номер является уникальным в для доументов одного типа.
prefix | - префикс номера. |
mdId | - id документа в метаданных бизнес-схемы. |
Перекрестные ссылки aLog::print().
Используется в New().
|
virtualslot |
Выбирает документ определенного типа и номера.
number | - составной номер документа |
nmName | - тип документа |
Перекрестные ссылки aObject::decodeDocNum(), aLog::print(), aObject::setSelected() и aObject::table().
|
virtualslot |
Выбирает документы определенного типа за некоторый период.
from | - дата начала периода |
to | - дата окончания периода |
nmName | - тип документа |
Перекрестные ссылки docType(), aObject::setSelected(), aObject::table() и type().
ERR_Code aDocJournal::selectDocument | ( | Q_ULLONG | idd | ) |
Выбирает документ с заданным идентификатором.
idd | - идентификатор документа. |
Перекрестные ссылки aObject::setSelected() и aObject::table().
Используется в New().
QString aDocJournal::selectionFilter | ( | const QString & | num, |
const QString & | mdName = "", | ||
bool | full = false ) |
Формирует строку с булевым выражением, для использования при отборе записей в SQL запросе.
Следует использовать при фильтрации по номеру документа.
from | - дата, задающая начало интервала времени |
to | - дата, задающая конец интервала времени |
mdName | - Имя типа документа, как оно определено в Дизайнере Ананаса при проектировании бизнес-схемы. В выражение будет добавлена проверка на соответствие типу документа. |
full | - булевый параметр, влияющий на формат создаваемого выражения. true - указывать имя sql таблицы "a_journ." перед имененами полей в выражении. |
Перекрестные ссылки aObject::decodeDocNum().
QString aDocJournal::selectionFilter | ( | QDateTime | from, |
QDateTime | to, | ||
const QString & | mdName = "", | ||
bool | full = false ) |
Формирует строку с булевым выражением, для использования при отборе записей в SQL запросе.
Следует использовать при фильтрации по интервалу времени.
from | - дата, задающая начало интервала времени |
to | - дата, задающая конец интервала времени |
mdName | - Имя типа документа, как оно определено в Дизайнере Ананаса при проектировании бизнес-схемы. В выражение будет добавлена проверка на соответствие типу документа. |
full | - булевый параметр, влияющий на формат создаваемого выражения. true - указывать имя sql таблицы "a_journ." перед имененами полей в выражении. |
Перекрестные ссылки docType() и type().
Используется в aIRegister::Select().
ERR_Code aDocJournal::setDate | ( | QVariant | date | ) |
Устанавливает дату текущего документа.
date | - дата документа. |
Перекрестные ссылки aObject::selected() и aObject::table().
ERR_Code aDocJournal::setNumber | ( | QVariant | number | ) |
Устанавливает номер текущего документа.
number | - номер документа. |
Перекрестные ссылки aObject::decodeDocNum(), aObject::selected() и aObject::table().
|
inline |
Используется в findDoc(), New(), Select() и selectionFilter().