Определяет программный интерфейс управления общим (системным) журналом документов. Наследует aObject. Подробнее...

#include <adocjournal.h>

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

Открытые слоты
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="")
	Выбирает документ определенного типа и номера. Подробнее...

Открытые слоты inherited from 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 ()
	Возвращает сообщение, поясняющее последнюю ошибку. Подробнее...

Открытые члены
	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 запросе. Подробнее...

Открытые члены inherited from 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 запрос. Подробнее...

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 таблицы. Подробнее...

Additional Inherited Members
Открытые атрибуты inherited from aObject
aCfg *	md

aCfgItem	obj

aDatabase *	db

Защищенные члены inherited from 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.

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 класса Подробнее...

Защищенные данные inherited from aObject
bool	concrete

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

Определяет программный интерфейс управления общим (системным) журналом документов. Наследует aObject.

Невизуальный объект для работы с системным журналом документов базы данных. Все хранящиеся в базе данных Ананаса документы система регистрирует в журнале. Используется для доступа к системному журналу скриптами и визуальными объектами. Включается в объект aDocument, для обеспечения работы документа с ситемным журналом.

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

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

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

Аргументы

context	- объект метаданных
adb	- ссылка на базу данных

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

aDocJournal::aDocJournal	(	const QString &	name,
		aDatabase *	adb = `0`
	)

Конструктор. Инициализирует объект объектом метаданных с именем name.

Аргументы

name	- имя объекта метаданных
adb	- ссылка на базу данных

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

aDocJournal::aDocJournal ( aDatabase * adb = 0 )

Конструктор. Создает экземпляр системного журнала, в котором хранятся ссылки на все созданные документы.

Аргументы

adb	- ссылка на базу данных

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

Методы

aDocument * aDocJournal::CurrentDocument ( )

slot

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

    \return текущий документ

*       aDocument *doc = sysJournal->CurrentDocument();
*       //какие-то действия с документом
*       delete doc;
*       doc=0;
*       

Перекрестные ссылки docId(), docType(), aCfg::find() и aDocument::select().

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

ERR_Code aDocJournal::Delete ( )

virtualslot

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

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

См. также: deleteDocument( Q_ULLONG idd )

Перекрестные ссылки CurrentDocument() и aDocument::Delete().

ERR_Code aDocJournal::deleteDocument ( Q_ULLONG idd )

virtual

Удаляет документ с заданным идентификатором.

Аргументы

idd	- идентификатор документа.

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

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

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

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

Q_ULLONG aDocJournal::docId ( )

virtual

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

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

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

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

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

Используется в CurrentDocument(), docType() и getPrefix().

int aDocJournal::docType ( )

Получение типа текущего документа.

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

Перекрестные ссылки docId() и aDatabase::uidType().

Используется в CurrentDocument(), Select() и selectionFilter().

Q_ULLONG aDocJournal::findDoc	(	const QString &	number,
		int	type
	)

Ищет документ по его номеру и типу.

Аргументы

number	- номер документа, состоящий из префикса и номера
type	- тип документа

Возвращает: id документа или 0, если документ не найден

См. также: findDocument( Q_ULLONG idd )

Перекрестные ссылки aObject::decodeDocNum(), aLog::print(), aObject::select(), aObject::setSelected(), aDataTable::sysValue() и aObject::table().

Q_ULLONG aDocJournal::findDocument ( Q_ULLONG idd )

Ищет документ в системном журнале по его идентификатору.

Аргументы

idd	- номер документа

Возвращает: id документа или 0, если документ не найден see findDoc( const QString & number, int type ) selectDocument( Q_ULLONG idd )

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

Используется в deleteDocument(), aDocument::First(), aDocument::Last(), aDocument::Next(), aDocument::Prev(), aDocument::select() и aDocument::Select().

QVariant aDocJournal::getDate ( )

Возвращает дату текущего документа.

Возвращает: дату документа

См. также: setDate( QVariant date )

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

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

QString aDocJournal::getNumber ( )

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

Возвращает: номер документа

См. также: setNumber( QVariant number )

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

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

QString aDocJournal::getPrefix ( )

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

Возвращает: префикс

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

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

int aDocJournal::getSerialNumber ( )

Возвращает номер текущего документа.

Возвращает: номер документа

См. также: getNumber( QVariant number )

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

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

ERR_Code aDocJournal::New	(	Q_ULLONG	idd,
		const QString &	docPrefix,
		int	type
	)

virtual

Добавляет запись в системный журнал.

Запись добавляется после создания документа и использует информацию о его id в базе данных, префиксе номера и id в конфигурации. Номер досумента генерируется функцией nextNumber()

Аргументы

idd	- id базы данных.
docPrefix	- перфикс номера документа.
type	- id документа в конфигурации.

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

Перекрестные ссылки nextNumber(), aLog::print(), selectDocument(), aObject::setSelected() и aObject::table().

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

QString aDocJournal::nextNumber	(	const QString &	prefix,
		int	mdId
	)

Генерирует следующий номер для документа.

Номер представляет собой строку, состоящую из префикса номера и числа. Номер документа генерируется используя префикс номера документа и его тип (id в конфигурации), как следующий за максимальным для даного сочетания. Номер является уникальным в для доументов одного типа.

Аргументы

prefix	- префикс номера.
mdId	- id документа в метаданных бизнес-схемы.

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

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

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

ERR_Code aDocJournal::Select	(	QDateTime	from,
		QDateTime	to,
		const QString &	mdName = `""`
	)

virtualslot

Выбирает документы определенного типа за некоторый период.

Аргументы

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

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

Перекрестные ссылки docType(), aCfg::find(), aCfg::id(), aObject::setSelected(), aObject::table() и type().

ERR_Code aDocJournal::Select	(	const QString &	number,
		const QString &	mdName = `""`
	)

virtualslot

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

Аргументы

number	- составной номер документа
nmName	- тип документа

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

Перекрестные ссылки aCfg::attr(), aObject::decodeDocNum(), aCfg::find(), aLog::print(), aObject::setSelected() и aObject::table().

ERR_Code aDocJournal::selectDocument ( Q_ULLONG idd )

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

Аргументы

idd	- идентификатор документа.

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

См. также: findDocument( Q_ULLONG idd )

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

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

QString aDocJournal::selectionFilter	(	QDateTime	from,
		QDateTime	to,
		const QString &	mdName = `""`,
		bool	full = `false`
	)

Формирует строку с булевым выражением, для использования при отборе записей в SQL запросе.

Следует использовать при фильтрации по интервалу времени.

Аргументы

from	- дата, задающая начало интервала времени
to	- дата, задающая конец интервала времени
mdName	- Имя типа документа, как оно определено в Дизайнере Ананаса при проектировании бизнес-схемы. В выражение будет добавлена проверка на соответствие типу документа.
full	- булевый параметр, влияющий на формат создаваемого выражения. true - указывать имя sql таблицы "a_journ." перед имененами полей в выражении.

Перекрестные ссылки docType(), aCfg::find(), aCfg::id() и type().

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

QString aDocJournal::selectionFilter	(	const QString &	num,
		const QString &	mdName = `""`,
		bool	full = `false`
	)

Формирует строку с булевым выражением, для использования при отборе записей в SQL запросе.

Следует использовать при фильтрации по номеру документа.

Аргументы

from	- дата, задающая начало интервала времени
to	- дата, задающая конец интервала времени
mdName	- Имя типа документа, как оно определено в Дизайнере Ананаса при проектировании бизнес-схемы. В выражение будет добавлена проверка на соответствие типу документа.
full	- булевый параметр, влияющий на формат создаваемого выражения. true - указывать имя sql таблицы "a_journ." перед имененами полей в выражении.

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

ERR_Code aDocJournal::setDate ( QVariant date )

Устанавливает дату текущего документа.

Аргументы

date	- дата документа.

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

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

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

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

ERR_Code aDocJournal::setNumber ( QVariant number )

Устанавливает номер текущего документа.

Аргументы

number - номер документа.

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

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

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

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

int aDocJournal::type ( )

inline

Возвращает: тип журнала.
0 - общий, содержит список документов всех типовб.
1 - специализированный журнал, содержит список документов одного типа, например "Расходные накладные".

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

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

adocjournal.h
adocjournal.cpp

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

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

Additional Inherited Members

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

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

Методы