Класс aIRegister

Класс aIRegister определяет программный интерфейс Информационных регистров. Подробнее...

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

Полный список членов класса

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

virtual int SetDocument (aDocument *doc)

Отфильтровывает записи регистра, принадлежащие документу. Подготовливает регистр для добавления записи функцией New.

virtual aDocument * GetDocument ()

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

virtual int SetTable (const QString &tblname)

Задает табличную часть документа для использования при добавдении новых записей регистра методом New.

virtual int New ()

Добавляет новую строку к таблице информационного регистра.

virtual int Select (const QString &from, const QString &to)

Выбирает записи в информационном регистре за заданный период.

virtual int Select (QDateTime from, QDateTime to)

Выбирает записи в информационном регистре за заданный период.

virtual int SelectByDoc ()

Выбирает первую запись регистра по документу, установленному перед этим функцией SetDocument( aDocument * doc ).

virtual QVariant Value (const QString &name, const QString &tableName="")

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

virtual int SetFilter (const QString &fieldName, const QVariant &value)

Устанавливает фильтр на записи регистра.

virtual bool Next ()

Переход к следующей записи регистра.

virtual bool Prev ()

Переход к предыдущей записи регистра.

virtual bool First ()

Переход к первой записи регистра.

virtual bool Last ()

Переход к последней записи регистра.

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

aIRegister (aCfgItem registerItem, aDatabase *adb=0)

Создает новый экземпляр объекта информационного регистра по описанию в бизнес схеме.

aIRegister (const QString &name, aDatabase *adb=0, const QString &type="InfoRegister.")

Создает новый экземпляр объекта информационного регистра по имени.

virtual ~aIRegister ()

virtual ERR_Code initObject ()

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

virtual bool deleteDocument (aDocument *doc)

Удаляет все записи с идентификатором данного документа из всех информационных регистров.

virtual bool deleteTable (Q_ULLONG iddt)

Удаляет все записи из всех информационных регистрах о таблице с данным идентификатором.

Защищенные данные

bool docseted

bool tableseted

QString tname

aDocument * nowDoc

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

Класс aIRegister определяет программный интерфейс Информационных регистров.

Информационный регистр служит для хронологической записи данных. Для хранения остатков следует использовать Накопительные регистры aARegister

См. также:: aARegister

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

aIRegister::aIRegister	(	aCfgItem	context,
		aDatabase *	adb = `0`
	)

Создает новый экземпляр объекта информационного регистра по описанию в бизнес схеме.

Аргументы:

	context	- Ссылка на объект бизнес схемы, описывающий регистр.
	adb	- Можно не передавать. Значение по умолчанию = 0. Текущая база данных Ананаса.

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

aIRegister::aIRegister	(	const QString &	name,
		aDatabase *	adb = `0`,
		const QString &	type = `"InfoRegister."`
	)

Создает новый экземпляр объекта информационного регистра по имени.

Новый объект создается по описанию объекта с таким именем, хранимом в бизнес схеме.

Аргументы:

	name	- Имя Регистра в бизнес схеме
	adb	- Можно не передавать. Значение по умолчанию = 0. Ссылка на текущую базу данных Ананаса
	type	- Можно не передавать. Значение по умолчанию = "InfoRegister". Тип (класс) реристра в бизнес схеме

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

aIRegister::~aIRegister ( ) [virtual]

Деструктор.

Методы

ERR_Code aIRegister::initObject ( ) [virtual]

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

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

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

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

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

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

bool aIRegister::deleteDocument ( aDocument * doc ) [virtual]

Удаляет все записи с идентификатором данного документа из всех информационных регистров.

Аргументы:

doc

- Документ, записи о котором будут удалены.

Возвращает:: true - успех, false - ошибка

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

Перекрестные ссылки aCfg::attr(), aDatabase::cfg, aCfg::count(), aDatabase::db(), aCfg::find(), aObject::getUid(), aObject::setLastError() и aDatabase::tableDbName().

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

bool aIRegister::deleteTable ( Q_ULLONG iddt ) [virtual]

Удаляет все записи из всех информационных регистрах о таблице с данным идентификатором.

Аргументы:

iddt

- id таблицы.

Возвращает:: true - успех, false - ошибка

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

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

int aIRegister::SetDocument ( aDocument * doc ) [virtual, slot]

Отфильтровывает записи регистра, принадлежащие документу. Подготовливает регистр для добавления записи функцией New.

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

Аргументы:

-

Ссылка на существующий документ

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

См. также:: New()

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

aDocument * aIRegister::GetDocument ( ) [virtual, slot]

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

Возвращяет хранящийся в текущей записи регистра указатель на документ (не идентификатор, а объект), позволяющий обратиться к реквизитам документа.

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

Перекрестные ссылки aCfg::find(), aDocument::select(), aDataTable::sysValue(), aObject::table() и aDatabase::uidType().

int aIRegister::SetTable ( const QString & tblname ) [virtual, slot]

Задает табличную часть документа для использования при добавдении новых записей регистра методом New.

Вновь добавляемые записи регистра будут содержать ссылку на текущую запись указанной табличной части документа. Используется только когда нужно добавить строки из таблицы документа. До вызова этой функции должна быть вызвана функция установки документа SetDocument( aDocument * doc ).

Аргументы:

tblname

- Имя таблицы документа.

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

См. также:: SetDocument( aDocument * doc )

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

Добавляет новую строку к таблице информационного регистра.

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

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

См. также:: SetDocument( aDocument * doc )
SetTable( const QString & tblname )

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

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

Перекрестные ссылки aDocument::getTable(), aObject::getUid(), aObject::New(), aObject::select(), aObject::table() и aObject::Update().

int aIRegister::Select	(	const QString &	from,
		const QString &	to
	)			`[virtual, slot]`

Выбирает записи в информационном регистре за заданный период.

Вспомогательный метод для скриптов.

Аргументы:

	from	- дата начала периода в строке в фрмате ISO 8601 (ГГГГ-ММ-ДД)
	to	- дата окончания периода в строке в формате ISO 8601 (ГГГГ-ММ-ДД)

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

См. также:: Select( QDateTime from, QDateTime to )

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

int aIRegister::Select	(	QDateTime	from,
		QDateTime	to
	)			`[virtual, slot]`

Выбирает записи в информационном регистре за заданный период.

Аргументы:

	from	- Дата начала периода
	to	- Дата окончания периода

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

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

int aIRegister::SelectByDoc ( ) [virtual, slot]

Выбирает первую запись регистра по документу, установленному перед этим функцией SetDocument( aDocument * doc ).

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

См. также:: SetDocument( aDocument * doc )

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

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

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

Аргументы:

name

- имя поля

Возвращает:: значение поля. Поля типа Q_ULLONG и DateTime переводятся в строки.

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

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

int aIRegister::SetFilter	(	const QString &	name,
		const QVariant &	value
	)			`[virtual, slot]`

Устанавливает фильтр на записи регистра.

После установки фильтра навигация происходит по записям значение данного поля которых равно указанному значению.

Аргументы:

	name	- Имя столбца в метаданных, на который устанавливается фильтр
	value	- Значение для фильтрации

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

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

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

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

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

airegister.h
airegister.cpp


Открытые слоты
virtual int	SetDocument (aDocument *doc)
	Отфильтровывает записи регистра, принадлежащие документу. Подготовливает регистр для добавления записи функцией New.
virtual aDocument *	GetDocument ()
	Возвращает документ, на основании которого была сделана текущая запись регистра.
virtual int	SetTable (const QString &tblname)
	Задает табличную часть документа для использования при добавдении новых записей регистра методом New.
virtual int	New ()
	Добавляет новую строку к таблице информационного регистра.
virtual int	Select (const QString &from, const QString &to)
	Выбирает записи в информационном регистре за заданный период.
virtual int	Select (QDateTime from, QDateTime to)
	Выбирает записи в информационном регистре за заданный период.
virtual int	SelectByDoc ()
	Выбирает первую запись регистра по документу, установленному перед этим функцией SetDocument( aDocument * doc ).
virtual QVariant	Value (const QString &name, const QString &tableName="")
	Возвращает значения поля с именем = name основной таблицы объекта.
virtual int	SetFilter (const QString &fieldName, const QVariant &value)
	Устанавливает фильтр на записи регистра.
virtual bool	Next ()
	Переход к следующей записи регистра.
virtual bool	Prev ()
	Переход к предыдущей записи регистра.
virtual bool	First ()
	Переход к первой записи регистра.
virtual bool	Last ()
	Переход к последней записи регистра.
Открытые члены
	aIRegister (aCfgItem registerItem, aDatabase *adb=0)
	Создает новый экземпляр объекта информационного регистра по описанию в бизнес схеме.
	aIRegister (const QString &name, aDatabase *adb=0, const QString &type="InfoRegister.")
	Создает новый экземпляр объекта информационного регистра по имени.
virtual	~aIRegister ()
virtual ERR_Code	initObject ()
	Инициализирует объект информационного регистра.
virtual bool	deleteDocument (aDocument *doc)
	Удаляет все записи с идентификатором данного документа из всех информационных регистров.
virtual bool	deleteTable (Q_ULLONG iddt)
	Удаляет все записи из всех информационных регистрах о таблице с данным идентификатором.
Защищенные данные
bool	docseted
bool	tableseted
QString	tname
aDocument *	nowDoc