Класс aObject

Базовый класс для невизуальных классов (моделей в терминологии MVC) Ананаса, которым необходим доступ к базе данных. Наследует QObject. Подробнее...

#include <aobject.h>

Граф наследования: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 ()

Показывает наличие активного фильтра.

virtual int TableUpdate (const QString &tablename)

Обновляет базу данных данными табличной части объекта.

virtual QString displayString ()

Возвращает строку, предназначенную для отображения пользователю объекта сложного типа.

virtual int LastErrorCode ()

Возвращает код последней ошибки.

virtual QString LastErrorMessage ()

Возвращает сообщение, поясняющее последнюю ошибку.

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

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 таблицы.

Открытые атрибуты

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.

Как правило такие классы предоставляют методы для работы с пользовательскими "объектами" типа "Журнал операций", первичный учетный документ "Приходная накладная", "Справочник товаров", "Элемент справочника товаров" и др.

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

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

aObject::aObject	(	QObject *	parent = `0`,
		const char *	name = `0`
	)

Конструктор для создания абстрактного объекта.

Создает абстрактный не связанный с базой данных объект управления данными. Созданный таким образом объект не использует информацию из метаданных о составе и типах полей. То есть он не является какой-либо моделью данных. И на самом деле малопригоден для использования. В базе данных ни как не отражается создание этого объекта. Для того, что бы зарегистрировать вновь созданный абстрактный объект в базе данных, необходимо сначала проинициализировать его с использованием метаданных, а затем вызвать метод New().

Аргументы:

	parent	- родительский объект в терминологии Qt (смотри QObject::QObject)
	name	- имя объекта в терминологии Qt (смотри QObject::QObject)

aObject::aObject	(	const QString &	oname,
		aDatabase *	adb,
		QObject *	parent = `0`,
		const char *	name = `0`
	)

Создает объект как модель данных, описанную в метаданных.

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

Аргументы:

	oname	- имя объекта метаданных с добавленным префиксом в начале. Допускаются следующие значения префикса: "Document." для документов, "InfoRegister." для информационных регистров, "Catalogue." для справочников, "AccumulationRegister." для накопительных регистров, "DocJournal." для журналов
	adb	- ссылка на объект, представляющий базу данных. Значение 0 (ноль) говорит, что следует использовать текущую базу данных.
	parent	- родительский объект в терминологии Qt (смотри QObject::QObject)
	name	- имя объекта в терминологии Qt (смотри QObject::QObject)

См. также:: aCfg::find( const QString &)

Перекрестные ссылки aDatabase::cfg, aCfg::find(), setLastError() и setObject().

aObject::aObject	(	aCfgItem	context,
		aDatabase *	adb,
		QObject *	parent = `0`,
		const char *	name = `0`
	)

Создает объект как модель данных, описанную в метаданных.

Объект создается по контексту метаданных, которому он принадлежит.

Аргументы:

	context	- Контекст(объект) метаданных, которому принадлежит (как ветвь дерева) создаваемый объект.
	adb	- ссылка на объект, представляющий базу данных. Значение 0 (ноль) говорит, что следует использовать текущую базу данных.
	parent	- родительский объект в терминологии Qt (смотри QObject::QObject)
	name	- имя объекта в терминологии Qt (смотри QObject::QObject)

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

Методы

bool aObject::checkStructure ( ) [virtual]

Not implemented.

Возвращает:: false

ERR_Code aObject::init ( )

Вспомогоательный метод. Проверяет необходимость вызова метода initObject() и вызывает его.

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

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

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

ERR_Code aObject::decodeDocNum	(	QString	nm,
		QString &	pref,
		int &	num
	)

Осуществляет выделение символьного префикса из строки.

TODO перенести этот метод в сервисный класс.

Перекрестные ссылки aLog::print().

Используется в aDocJournal::findDoc(), aDocJournal::Select(), aDocJournal::selectionFilter() и aDocJournal::setNumber().

ERR_Code aObject::select ( Q_ULLONG id ) [virtual]

Позиционирует указатель в БД на запись, соотвествующую объекту с указанным идентификатором.

Аргументы:

id

- Идентификатор объекта.

Возвращает:: возвращает код ошибки или 0 в случае успеха.

Переопределяется в aDocument.

Перекрестные ссылки aCfg::find(), aDataTable::first(), aDataTable::getMdObjId(), aDataTable::select(), setObject(), setSelected(), table() и aDatabase::uidType().

Используется в aDocJournal::findDoc(), aIRegister::New(), aARegister::New(), aWidget::Select(), aDocument::select(), aCatGroup::Select(), aForm::SelectByCurrent(), aCatGroup::SelectChild(), aCatalogue::setMarkDeletedElement() и aCatGroup::SetParent().

Q_ULLONG aObject::getUid ( )

Возвращает уникальный идентификатор объекта из базы данных.

См. также:: aObject::Uid()

Перекрестные ссылки selected(), aDataTable::sysValue(), table() и Uid().

Используется в aDocument::Copy(), Delete(), aDocument::Delete(), aIRegister::deleteDocument(), aARegister::deleteDocument(), aDocJournal::findDocument(), aDocument::First(), aDocument::IsSignedIn(), aDocument::Last(), aIRegister::New(), aDocument::New(), aCatalogue::New(), aARegister::New(), aDocument::Next(), aDocument::Prev(), aDocument::Select(), aIRegister::SelectByDoc(), aCatGroup::SelectChild(), aIRegister::SetDocument(), aWidget::setObjValue(), aCatGroup::SetParent(), aDocument::TableNewLine(), aWidget::uid(), Uid() и aARegister::Update().

bool aObject::selected ( const QString & tablename = "" )

Показывает задан ли текущий объект или запись в его табличной части.

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

Аргументы:

tablename

-имя табличной части объекта. Необязательный параметр, имеющий значение "" по-умолчанию.

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

Используется в aDocument::Delete(), aCatalogue::Delete(), aDocJournal::getDate(), aDocJournal::getNumber(), aDocJournal::getSerialNumber(), getUid(), aCatalogue::GroupSelect(), IsSelected(), New(), aCatGroup::parentUid(), aDocJournal::setDate() и aDocJournal::setNumber().

ERR_Code aObject::select	(	const QString &	query,
		const QString &	tableName = `""`
	)

Осуществляет SQL запрос.

В случае успешного выполнения запроса, первая запись таблицы результатов становится текущей.

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

Перекрестные ссылки aDataTable::first(), aDataTable::select(), setSelected() и table().

aDataTable * aObject::table ( const QString & name = "" )

Возвращает одну из таблиц бизнес-объекта по ее имени.

Для хранения в базе данных значений свойств бизнес-объектов Ананаса, таких как документы, каталоги, журналы используется одна или несколько реляционных таблиц. Каждая такая таблица представлена объектом aDataTable, а список указателей на объекты aDataTable проинициализированного экземпляра бизнес-объекта хранится в его свойстве dbtables. Инициализация и наполнение dbtables осуществляется наследниками aObject. Метод возвращает ссылку на объект aDataTable с именем, соответствующим значению, переданному в параметре. Вызов метода без параметров, аналогичен вызову метода с пустой строкой table(""); В этом случае метод вернет объект aDataTable представляющий главную таблицу бизнес-объекта. Главная таблица используется для хранения значений свойств не табличных частей бизнес-объекта. Например, реквизитов шапки и подвала документа. Такой объект хранит все значения ровно в одной записи. Таким образом, вызов table() без параметров позволяет получить объект aDataTable для доступа к основным свойствам бизнес-объекта.

Аргументы:

name

- имя таблицы. Для доступа к главной таблице бизнес-объекта пареметр должен быть равен "" или пропущен.

Возвращает:: ссылку на объект aDataTable или 0 если таблица не найдена.

См. также:: aDatabase::table( const QString & )

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

Используется в aRole::addPermission(), aUser::addRole(), Copy(), aDocument::Copy(), aCatalogue::delElement(), aUser::Delete(), aRole::Delete(), Delete(), aCatalogue::Delete(), aDocJournal::deleteDocument(), aARegister::deleteDocument(), aCatalogue::delGroup(), aUser::delRole(), displayString(), aDocJournal::docId(), aCatalogue::FindById(), aDocJournal::findDoc(), aDocJournal::findDocument(), First(), aDocJournal::getDate(), aIRegister::GetDocument(), aCatalogue::getMarkDeletedList(), aDocJournal::getNumber(), aARegister::getSaldo(), aARegister::getSaldoByManyDimensions(), aDocJournal::getSerialNumber(), aDocument::getTable(), getUid(), aUser::getUserId(), aCatalogue::GroupSelect(), aRole::hasPermission(), aUser::hasRole(), aCatalogue::idGroupByElement(), aARegister::initObject(), IsMarkDeleted(), IsMarked(), Last(), aUser::New(), aRole::New(), New(), aIRegister::New(), aDocument::New(), aDocJournal::New(), aCatalogue::New(), aARegister::New(), aCatalogue::newElement(), aCatalogue::newGroup(), Next(), aCatGroup::parentUid(), Prev(), aDocument::Seek(), aUser::Select(), aRole::Select(), select(), aIRegister::Select(), aDocument::Select(), aDocJournal::Select(), aCatalogue::Select(), aIRegister::SelectByDoc(), 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(), Update(), aARegister::Update() и Value().

Q_ULLONG aObject::docId ( ) [virtual]

Возвращает id документа в базе данных.

Всегда возвращает 0. Следует преопределить в наследующем классе. Предназначена для совместимости и работы в wJournal.

Возвращает:: 0

Переопределяется в aDocJournal.

bool aObject::Next ( const QString & tableName = "" ) [virtual]

Перемещает указатель на следующую запись SQL таблицы.

Таким образом меняется текущий объект.

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

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

bool aObject::Prev ( const QString & tableName = "" ) [virtual]

Перемещает указатель на предыдующую запись SQL таблицы.

Таким образом меняется текущий объект.

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

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

bool aObject::First ( const QString & tableName = "" ) [virtual]

Перемещает указатель на первую запись SQL таблицы.

Таким образом меняется текущий объект.

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

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

bool aObject::Last ( const QString & tableName = "" ) [virtual]

Перемещает указатель на последнюю запись SQL таблицы.

Таким образом меняется текущий объект.

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

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

QString aObject::Uid ( ) [virtual, slot]

Возвращает уникальный идентификатор объекта из базы данных.

В качестве объекта например может выступать "Приходная накладная" от такого-то числа за таким то номером. Каждый вновь созданный в системе документ или элемент справочника, включая группы справочника имеет свой уникальный неповторяющийся идентификатор. Если какое-либо поле, какого-либо объекта имеет тип Объект (например Document.Накладная), то в качестве значения ему нужно задавать уникальный идентификатор объекта, возвращаемый функцией Uid(). Не существует возможности изменить существующий идентификатор какого-либо объекта. Созданием и управлением идентификаторами объектов занимается система.

Возвращает:: строка со значением уникального идентификатора.

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

Используется в aDocument::Copy(), aDocJournal::deleteDocument(), getUid() и aDocument::New().

bool aObject::IsSelected ( ) [virtual, slot]

Checks if object selected.

Возвращает:: true if object record selected in database.

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

bool aObject::IsMarkDeleted ( const QString & tname = "" ) [virtual, slot]

Checks "Deleted" marker.

Возвращает:: true if record marked as deleted or false if not.

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

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

bool aObject::IsMarked ( ) [virtual, slot]

Checks "Marked" marker.

Возвращает:: true if record marked or false if not.

См. также:: aObject::SetMarked()

Переопределяется в aDocument.

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

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

int aObject::SetMarkDeleted	(	bool	Deleted,
		const QString &	tname = `""`
	)			`[virtual, slot]`

Устанавливает признак логического удаления объекта (записи SQL таблицы).

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

Перекрестные ссылки setLastError(), aDataTable::setSysValue(), aDataTable::sysFieldExists() и table().

Используется в aDocument::SetMarkDeleted() и aCatalogue::setMarkDeletedElement().

int aObject::SetMarked ( bool Marked ) [virtual, slot]

Выставляет отметку на объекте.

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

См. также:: aObject::IsMarked()

Переопределяется в aDocument.

Перекрестные ссылки setLastError(), aDataTable::setSysValue(), aDataTable::sysFieldExists() и table().

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

int aObject::New ( ) [virtual, slot]

Add new object record in database.

Возвращает:: error code

Переопределяется в aARegister, aCatalogue, aCatGroup, aDocument и aIRegister.

Перекрестные ссылки aDataTable::New(), selected(), setSelected() и table().

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

int aObject::Copy ( ) [virtual, slot]

Создает новый объект, являющийся клоном текущего объекта.

Copy current selected object data in database.

Возвращает:: err_copyerror в случае возникновения ошибки или err_noerror в случае успешного выполнения.

Переопределяется в aCatalogue и aDocument.

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

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

int aObject::Delete ( ) [virtual, slot]

Удаляет текущий объект из базы данных.

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

Переопределяется в aCatalogue, aDocJournal, aDocument, aRole и aUser.

Перекрестные ссылки aDataTable::Delete(), getUid(), aDatabase::markDeleted(), setSelected() и table().

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

int aObject::Update ( ) [virtual, slot]

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

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

Переопределяется в aARegister, aCatalogue, aDocument, aRole и aUser.

Перекрестные ссылки setLastError(), table() и aDataTable::Update().

Используется в aIRegister::New(), wDocument::Update(), aWidget::Update(), aUser::Update(), aRole::Update(), aDocument::Update(), aCatalogue::Update() и aARegister::Update().

int aObject::Conduct ( ) [virtual, slot]

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

Следует переопределить в наследующем классе. Предназначена для wDocument.

Возвращает:: код ошибки - абстрактный обект - err_abstractobj.

Переопределяется в aDocument.

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

int aObject::UnConduct ( ) [virtual, slot]

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

Следует переопределить в наследующем классе. Предназначена для wDocument.

Возвращает:: код ошибки - абстрактный обект - err_abstractobj.

Переопределяется в aDocument.

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

bool aObject::IsConducted ( ) [virtual, slot]

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

Ничего не делает. Следует переопределить в наследующем классе. Предназначена для wDocument.

Возвращает:: код ошибки - абстрактный обект - err_abstractobj.

Переопределяется в aDocument.

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

QVariant aObject::Value	(	const QString &	name,
		const QString &	tableName = `""`
	)			`[virtual, slot]`

Return field value of the primary object database table.

Аргументы:

	name	(in) - field name
	tableName	(in) - name of table field belongs to. Optional. default value - "".

Возвращает:: field value

Переопределяется в aDocument и aIRegister.

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

Используется в aCatGroup::SetParent(), aIRegister::Value() и aDocument::Value().

int aObject::SetValue	(	const QString &	name,
		const QVariant &	value,
		const QString &	tableName = `""`
	)			`[virtual, slot]`

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 - "".

Возвращает:: error code

Перекрестные ссылки setSysValue(), aDataTable::setValue(), table() и trSysName().

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

QVariant aObject::sysValue	(	const QString &	name,
		const QString &	tableName = `""`
	)			`[virtual, slot]`

Gets system field value.

Аргументы:

name

(in) - field name.

Возвращает:: field value or QVariant::Invalid if field no exist.

Переопределяется в 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().

int aObject::setSysValue	(	const QString &	name,
		QVariant	value,
		const QString &	tableName = `""`
	)			`[virtual, slot]`

Sets system field value.

Аргументы:

	name	(in) - field name.
	value	(in) - sets value.

Переопределяется в aDocument.

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

Используется в aRole::SetName() и SetValue().

int aObject::ClearFilter ( ) [virtual, slot]

Чистит фильтр записей/объектов.

Фильтр влияет на навигацию и выбор текущего объекта.

См. также:: aObject::clearTFilter( const QString &)

Переопределяется в aDocument.

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

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

int aObject::TableSetFilter	(	const QString &	tname,
		const QString &	valname,
		const QVariant &	value
	)			`[virtual, slot]`

Устанавливает вильтр записей табличной части объекта.

Вспомогательный метод. Делегирует вызов методу aObject::setTFilter( const QString &, const QString &, const QVariant &)

Аргументы:

	tname	- имя табличной части
	valname	- имя поля, используемого для фильтрации
	value	- значение поля, используемое для фильтрации

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

int aObject::TableClearFilter ( const QString & tname ) [virtual, slot]

Чистит фильтр записей указанной табличной части объекта.

Вспомогательный метод. Делегирует вызов методу aObject::clearTFilter( const QString &)

Аргументы:

tname

- имя табличной части объекта.

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

int aObject::TableUpdate ( const QString & tablename ) [virtual, slot]

Обновляет базу данных данными табличной части объекта.

Обычно вызывается после метода TableSetValue.

Аргументы:

tablename

- имя таблицы. Необходим для указания имени, так как в объекте возможно наличие нескольких табличных частей.

Возвращает:: возвращает код ошибки или 0 в случае успеха.

Переопределяется в aDocument.

Перекрестные ссылки setLastError(), table() и aDataTable::Update().

Используется в aDocument::TableUpdate(), aUser::Update(), aRole::Update(), aCatalogue::Update() и aUser::UpdateRole().

QString aObject::displayString ( ) [virtual, slot]

Возвращает строку, предназначенную для отображения пользователю объекта сложного типа.

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

Возвращает:: строку для показа пользователю

Перекрестные ссылки aCfg::attr(), displayStringContext(), aLog::print(), aCfg::sText(), aDataTable::sysValue() и table().

int aObject::LastErrorCode ( ) [virtual, slot]

Возвращает код последней ошибки.

Метод позволяет проверить код ошибки после выполнения той или иной операции. Если возвращенное значение не равно 0 (нулю), то имела места ошибка, о которой возможно следует сообщить пользователю. Текст сообщения об ошибке можно получить методом aObject::LastErrorMessage(). Рекомендуется использовать метод в обязательном порядке при создании объектов доступа к данным из Ананас-Скрипта. Пример:

        var  goods = new Catalogue("Номенклатура товаров"); 
        if ( goods.LastErrorCode() != 0)
        {
                sys.Message(0,"Ошибка при создании объекта доступа к справочнику: "+goods.LastErrorMessage()); 
                return;
        }

См. также:: aObject::LastErrorMessage()

Используется в aDocJournal::deleteDocument(), aDocJournal::initObject(), aARegister::initObject(), aDocument::New(), aDocument::TableDelete(), aDocument::TableNewLine() и aDocument::Update().

QString aObject::LastErrorMessage ( ) [virtual, slot]

Возвращает сообщение, поясняющее последнюю ошибку.

См. также:: aObject::LastErrorCode()

ERR_Code aObject::setObject ( aCfgItem newobject ) [protected, virtual]

Задает метатип объекта.

Используется в процессе создания/инициализации объекта. Метатип - это описание объекта в метаданных, узел дерева метаданных.

Аргументы:

newobject

- метатип, присваиваемый объекту

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

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

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

ERR_Code aObject::initObject ( ) [protected, virtual]

Инициализирует объект при его создании.

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

Переопределяется в aARegister, aCatalogue, aCatGroup, aDocJournal, aDocument, aIRegister, aReport, aRole и aUser.

Перекрестные ссылки aDatabase::cfg, aLog::print() и setLastError().

Используется в init(), aUser::initObject(), aRole::initObject(), aReport::initObject(), aIRegister::initObject(), aDocument::initObject(), aCatGroup::initObject() и aCatalogue::initObject().

ERR_Code aObject::tableInsert	(	const QString &	dbname,
		aCfgItem	obj,
		const QString &	name = `""`
	)			`[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

Возвращает:: error code

Перекрестные ссылки setLastError(), aDataTable::setObject() и aDatabase::table().

Используется в aUser::initObject(), aRole::initObject(), aIRegister::initObject(), aDocument::initObject(), aDocJournal::initObject(), aCatGroup::initObject(), aCatalogue::initObject() и aARegister::initObject().

ERR_Code aObject::tableInsert	(	const QString &	dbname,
		const QString &	name = `""`
	)			`[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

Возвращает:: error code

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

ERR_Code aObject::tableRemove ( const QString & name = "" ) [protected]

Remove table from buffer.

Аргументы:

name

- table name

Возвращает:: err_notable if table not found

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

QString aObject::trSysName ( const QString & sname ) [protected, virtual]

Not implemented.

Возвращает:: ""

Переопределяется в aARegister и aDocument.

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

void aObject::setLastError	(	int	errorCode,
		QString	errorMessage
	)			`[protected]`

Задает значения свойствам lastErrorCode и lastErrorMessage класса.

Также выводит в лог сообщение об ошибке.

Аргументы:

	errorCode	- (in) код ошибки для записи в свойство lastErrorCode
	errorMessage	- (in) сообщение об ошибке для записи в свойство lastErrorMessage

См. также:: aObject::LastErrorMessage(), aObject::LastErrorCode()

Перекрестные ссылки aLog::print().

Используется в aObject(), aIRegister::deleteDocument(), aDocJournal::deleteDocument(), aIRegister::deleteTable(), aDocument::GetDocumentValue(), aARegister::getSaldo(), aARegister::getSaldoByManyDimensions(), initObject(), aDocJournal::initObject(), aARegister::initObject(), aDocument::New(), aCatGroup::New(), aReport::save(), SetMarkDeleted(), SetMarked(), table(), aDocument::TableDelete(), tableInsert(), aDocument::TableNewLine(), tableRemove(), TableUpdate(), Update(), aDocument::Update() и aCatalogue::Update().

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

aobject.h
aobject.cpp


Открытые слоты
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 ()
	Показывает наличие активного фильтра.
virtual int	TableUpdate (const QString &tablename)
	Обновляет базу данных данными табличной части объекта.
virtual QString	displayString ()
	Возвращает строку, предназначенную для отображения пользователю объекта сложного типа.
virtual int	LastErrorCode ()
	Возвращает код последней ошибки.
virtual QString	LastErrorMessage ()
	Возвращает сообщение, поясняющее последнюю ошибку.
Открытые члены
	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 таблицы.
Открытые атрибуты
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