Ananas Library 0.9.5
Открытые слоты | Открытые члены | Полный список членов класса
Класс aDocument

Определяет программный интерфейс для работы с бизнес объектами типа Документ и их атрибутами. Наследует aObject. Подробнее...

#include <adocument.h>

Граф наследования:aDocument:
aObject

Открытые слоты

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 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 ()
 Показывает наличие активного фильтра
 

Открытые члены

 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)
 Осуществляет выделение символьного префикса из строки.
 
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 запрос.
 
aDataTabletable (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
aCfgmd
 
aCfgItem obj
 
aDatabasedb
 
- Защищенные члены унаследованные от aObject
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 класса
 
- Защищенные данные унаследованные от aObject
bool concrete
 

Подробное описание

Определяет программный интерфейс для работы с бизнес объектами типа Документ и их атрибутами. Наследует aObject.

Конструктор(ы)

◆ aDocument() [1/2]

aDocument::aDocument ( aCfgItem  context,
aDatabase adb = 0 
)

Создает объект и инициализирует его по метаданным бизнес схемы. .

Перекрестные ссылки initObject().

◆ aDocument() [2/2]

aDocument::aDocument ( const QString &  name,
aDatabase adb = 0 
)

Создает объект и инициализирует его по метаданным бизнес схемы. Документ инициализируется элементом метаданных, найденым по его имени, причем поиск осуществляется только среди документов.

Аргументы
name- имя документа в метаданных бизнес схемы.
adb- ссылка на базу данных

Перекрестные ссылки initObject().

◆ ~aDocument()

aDocument::~aDocument ( )
virtual

Уничтожает объект. Используется для удаления системного журнала и освобождения занятой под него памяти.

Методы

◆ ClearFilter

ERR_Code aDocument::ClearFilter ( )
virtualslot

ScriptAPI. Сбрасывает фильтр. .

Перекрестные ссылки aObject::ClearFilter().

◆ Copy

ERR_Code aDocument::Copy ( )
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
Возвращает
код ошибки.

Перекрестные ссылки aCfg::attr(), aObject::Copy(), aCfg::count(), aCfg::find(), aDocJournal::getPrefix(), aObject::getUid(), aCfg::id(), aDatabase::markDeleted(), aDocJournal::New(), select(), aObject::table(), TableNewLine(), TableNext(), TableSelect(), TableSetValue(), TableUpdate(), TableValue() и aObject::Uid().

◆ Delete

ERR_Code aDocument::Delete ( )
virtualslot

ScriptAPI. Удаляет текущий документ.

Перекрестные ссылки aCfg::attr(), aCfg::count(), aObject::Delete(), aDocJournal::deleteDocument(), aCfg::find(), aObject::getUid(), IsConducted(), aDatabase::markDeleted(), aLog::print(), aObject::selected() и UnConduct().

Используется в aDocJournal::Delete().

◆ First

bool aDocument::First ( )
virtualslot

ScriptAPI. Переходит к первому документу .

Перекрестные ссылки aDocJournal::findDocument(), aObject::First() и aObject::getUid().

◆ GetDocumentValue

QVariant aDocument::GetDocumentValue ( QVariant  docId,
const QString &  fname 
)
slot

ScriptAPI. Получение значения атрибута документа c указанным идентификатором.

Перекрестные ссылки aObject::docId(), select(), aObject::setLastError() и Value().

◆ getTable()

aSQLTable * aDocument::getTable ( const QString &  tname)

Возвращает таблицу дакумента по имени. Функция позволяет получить ссылку на таблизу документа по ее имени.

См. также
aObject::table()
Аргументы
tname- имя таблицы в бизнес схеме.
Возвращает
ссылка на таблицу.

Перекрестные ссылки aObject::table().

Используется в aARegister::New() и aIRegister::New().

◆ initObject()

ERR_Code aDocument::initObject ( )
virtual

Инициализирует объект элементом метаданных бизнес схемы. В процесе инициализации выполняется настройка на шапку документа и все его табличные части. После инициализации появляется возможность работать с полями и таблицами, используя их имена, определенные в бизнес схеме.

Возвращает
код ошибки.

Переопределяет метод предка aObject.

Перекрестные ссылки aCfg::attr(), aCfg::count(), aCfg::find(), aObject::initObject(), aDatabase::tableDbName() и aObject::tableInsert().

Используется в aDocument().

◆ IsMarkDeleted

bool aDocument::IsMarkDeleted ( )
virtualslot

ScriptAPI. Проверяет помечен ли документ как удаленный. .

Перекрестные ссылки aObject::IsMarkDeleted().

◆ IsMarked

bool aDocument::IsMarked ( )
virtualslot

ScriptAPI. Проверяет помечен ли документ. .

Перекрестные ссылки aObject::IsMarked().

◆ IsSignedIn

bool aDocument::IsSignedIn ( )
slot

ScriptAPI. Проверяет, проведен ли документ. .

Перекрестные ссылки aDatabase::db() и aObject::getUid().

Используется в IsConducted().

◆ Last

bool aDocument::Last ( )
virtualslot

ScriptAPI. Переходит к последнему документу .

Перекрестные ссылки aDocJournal::findDocument(), aObject::getUid() и aObject::Last().

◆ New

ERR_Code aDocument::New ( )
virtualslot

ScriptAPI. Создает и регистрирует в системном журнале объект aDocument.

Перекрестные ссылки aCfg::attr(), aObject::getUid(), aCfg::id(), aObject::LastErrorCode(), aDatabase::markDeleted(), aObject::New(), aDocJournal::New(), Prefix(), aLog::print(), aObject::setLastError(), SetPrefix(), aObject::table() и aObject::Uid().

◆ Next

bool aDocument::Next ( )
virtualslot

ScriptAPI. Переход к следующему документу. .

Перекрестные ссылки aDocJournal::findDocument(), aObject::getUid() и aObject::Next().

◆ Prefix

QString aDocument::Prefix ( )
slot

ScriptAPI. Возвращает префикс документа. .

Используется в New().

◆ Prev

bool aDocument::Prev ( )
virtualslot

ScriptAPI. Переход к предыдущему документу .

Перекрестные ссылки aDocJournal::findDocument(), aObject::getUid() и aObject::Prev().

◆ Seek

void aDocument::Seek ( int  pos,
const QString &  tname 
)
slot

ScriptAPI. Устанавливает позицию в табличной части документа на строку с заданным номером. .

Перекрестные ссылки aObject::setSelected() и aObject::table().

◆ Select [1/2]

ERR_Code aDocument::Select ( const QString &  num)
virtualslot

ScriptAPI. Выбирает документы по номеру.

Перекрестные ссылки aCfg::attr(), aDocJournal::findDocument(), aObject::getUid(), aObject::IsFiltred(), aDocJournal::selectionFilter(), aObject::setSelected() и aObject::table().

◆ select()

ERR_Code aDocument::select ( Q_ULLONG  uid)
virtual

Выбирает документ с заданным идентификатором.

Переопределяет метод предка aObject.

Перекрестные ссылки aCfg::attr(), aCfg::count(), aCfg::find(), aDocJournal::findDocument() и aObject::select().

Используется в Copy(), aDocJournal::CurrentDocument(), aIRegister::GetDocument(), GetDocumentValue() и SelectDocument().

◆ Select [2/2]

ERR_Code aDocument::Select ( QDateTime  from,
QDateTime  to 
)
virtualslot

ScriptAPI. Выбирает документы по интервалу времени.

Перекрестные ссылки aCfg::attr(), aDocJournal::findDocument(), aObject::getUid(), aObject::IsFiltred(), aDocJournal::selectionFilter(), aObject::setSelected() и aObject::table().

◆ SelectDocument

int aDocument::SelectDocument ( QVariant  uid)
virtualslot

ScriptAPI. Выбирает документ с заданным идентификатором. .

Перекрестные ссылки select().

◆ SetFilter

ERR_Code aDocument::SetFilter ( const QString &  valname,
const QVariant &  value 
)
virtualslot

ScripAPI. Устанавливает фильтр на доступные документы.

Перекрестные ссылки aObject::SetFilter().

◆ SetMarkDeleted

ERR_Code aDocument::SetMarkDeleted ( bool  Deleted)
virtualslot

ScriptAPI. Устанавливает флаг удаления. .

Перекрестные ссылки aObject::SetMarkDeleted().

◆ SetMarked

ERR_Code aDocument::SetMarked ( bool  Marked)
virtualslot

ScriptAPI Помечает документ.

Перекрестные ссылки aObject::SetMarked().

◆ SetPrefix

void aDocument::SetPrefix ( const QString &  pr)
slot

ScriptAPI. Задает префикс документа.

Используется в New().

◆ setSysValue()

ERR_Code aDocument::setSysValue ( const QString &  sname,
QVariant  value,
const QString &  = "" 
)
virtual

Устанавливает значение системного поля. Используется для установки значения системного поля по его имени

Аргументы
sname- имя ситемного поля.
value- устанавливаемое значение
Возвращает
код ошибки.

Переопределяет метод предка aObject.

Перекрестные ссылки aDocJournal::setDate() и aDocJournal::setNumber().

◆ SignIn

ERR_Code aDocument::SignIn ( )
slot

ScriptAPI. Вызывает проведение документа. .

Перекрестные ссылки IsConducted().

Используется в Conduct().

◆ SignOut

ERR_Code aDocument::SignOut ( )
slot

ScriptAPI. Отменяет проведение документа. .

Перекрестные ссылки aCfg::count(), aARegister::deleteDocument(), aIRegister::deleteDocument(), aCfg::find(), IsConducted() и aLog::print().

Используется в UnConduct().

◆ sysValue()

QVariant aDocument::sysValue ( const QString &  sname,
const QString &  = "" 
)
virtual

Читает значение системного поля. Используется для получения значения системного поля по его имени

Аргументы
sname- имя ситемного поля.
Возвращает
значение поля или ошибочное значение, если имя поля неизвестно.

Переопределяет метод предка aObject.

Перекрестные ссылки aDocJournal::getDate(), aDocJournal::getNumber() и aDocJournal::getSerialNumber().

◆ TableDelete

ERR_Code aDocument::TableDelete ( const QString &  tablename)
virtualslot

ScriptAPI. Удаляет текущую строку табличной части документа.

Перекрестные ссылки aIRegister::deleteTable(), IsConducted(), aObject::LastErrorCode(), aDatabase::markDeleted(), aLog::print(), aObject::setLastError() и aObject::table().

◆ TableFirst

bool aDocument::TableFirst ( const QString &  name)
virtualslot

ScriptAPI. Переход к первой записи в табличной части документа .

Перекрестные ссылки aObject::table().

◆ TableLast

bool aDocument::TableLast ( const QString &  name)
virtualslot

ScriptAPI. Переход к последней записи в табличной части документа .

Перекрестные ссылки aObject::table().

◆ TableNewLine

ERR_Code aDocument::TableNewLine ( const QString &  tablename)
virtualslot

ScriptAPI. Добавляет новую строку табличной части документа.

Перекрестные ссылки aDatabase::db(), aObject::getUid(), IsConducted(), aObject::LastErrorCode(), aLog::print(), aObject::setLastError(), aObject::table() и TableUpdate().

Используется в Copy().

◆ TableNext

bool aDocument::TableNext ( const QString &  name)
virtualslot

ScriptAPI. Переход к следуещей записи в табличной части документа .

Перекрестные ссылки aObject::table().

Используется в Copy().

◆ TablePrev

bool aDocument::TablePrev ( const QString &  name)
virtualslot

ScriptAPI. Переход к предыдущей записи в табличной части документа .

Перекрестные ссылки aObject::table().

◆ TableSelect

ERR_Code aDocument::TableSelect ( const QString &  name)
virtualslot

ScriptAPI. Выбирает табличную часть документа по ее имени.

Используется в Copy().

◆ TableSetValue

ERR_Code aDocument::TableSetValue ( const QString &  tablename,
const QString &  name,
const QVariant &  value 
)
virtualslot

ScriptAPI. Записывает значение в поле текущей строки табличной части документа. .

Перекрестные ссылки aObject::setTValue().

Используется в Copy().

◆ TableUpdate

ERR_Code aDocument::TableUpdate ( const QString &  tablename = "")
virtualslot

SrciptAPI. Обновляет текущую запись табличной части документа.

Перекрестные ссылки aCfg::attr(), aCfg::count(), aCfg::find(), IsConducted(), aLog::print() и aObject::TableUpdate().

Используется в Copy() и TableNewLine().

◆ TableValue

QVariant aDocument::TableValue ( const QString &  tablename,
const QString &  name 
)
virtualslot

ScriptAPI. Читает значение поля табличной части документа.

Перекрестные ссылки aDataTable::sysValue(), aObject::table(), trSysName() и aObject::tValue().

Используется в Copy().

◆ trSysName()

QString aDocument::trSysName ( const QString &  sname)
virtual

Используется для перевода предопределенных имен для системных полей. Позволяет использовать для обращения к системным полям из скриптов назавания, близкие по смыслу к их назначению с учетом языка пользователя. Например к полю номер документа можно обратиться используя имя "НомерДок" или "DocNumber".

Аргументы
sname- одно из предопределенных имен поля.
Возвращает
имя поля

Переопределяет метод предка aObject.

Используется в TableValue().

◆ Update

ERR_Code aDocument::Update ( )
virtualslot

ScriptAPI. Обновляет информацию в базе данных.

Перекрестные ссылки IsConducted(), aObject::LastErrorCode(), aObject::setLastError() и aObject::Update().

◆ Value

QVariant aDocument::Value ( const QString &  name,
const QString &  tableName = "" 
)
virtualslot

Возвращает значения поля с именем = name основг\ной таблицы объекта.

Аргументы
name- имя поля
Возвращает
значение поля. Поля типа Q_ULLONG и DateTime переводятся в строки.

Перекрестные ссылки aObject::Value().

Используется в aARegister::deleteDocument(), GetDocumentValue(), aARegister::New() и aARegister::Update().


Объявления и описания членов классов находятся в файлах: