Класс aDocJournal

Определяет программный интерфейс управления общим (системным) журналом документов. Наследует 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="")

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

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

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.

Невизуальный объект для работы с системным журналом документов базы данных. Все хранящиеся в базе данных Ананаса документы система регистрирует в журнале. Используется для доступа к системному журналу скриптами и визуальными объектами. Включается в объект 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().

Методы

ERR_Code aDocJournal::selectDocument ( Q_ULLONG idd )

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

Аргументы:

idd

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

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

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

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

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

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().

int aDocJournal::type ( ) [inline]

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

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

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

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

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

Аргументы:

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

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

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

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

QVariant aDocJournal::getDate ( )

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

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

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

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

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

QString aDocJournal::getNumber ( )

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

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

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

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

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

int aDocJournal::getSerialNumber ( )

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

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

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

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

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

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().

ERR_Code aDocJournal::New	(	Q_ULLONG	idd,
		const QString &	docPrefix,
		int	type
	)			`[virtual]`

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

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

Аргументы:

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

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

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

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

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::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().

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().

QString aDocJournal::getPrefix ( )

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

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

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

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

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().

aDocument * aDocJournal::CurrentDocument ( ) [slot]

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

Возвращает:

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

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

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

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

ERR_Code aDocJournal::Delete ( ) [virtual, slot]

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

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

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

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

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

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

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

Аргументы:

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

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

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

ERR_Code aDocJournal::Select	(	const QString &	number,
		const QString &	mdName = `""`
	)			`[virtual, slot]`

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

Аргументы:

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

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

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

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

adocjournal.h
adocjournal.cpp


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