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

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

Открытые члены
	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
	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 таблицы.

virtual int	TableUpdate (const QString &tablename)
	Обновляет базу данных данными табличной части объекта.

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

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

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

Дополнительные унаследованные члены
Открытые атрибуты унаследованные от aObject
aCfg *	md

aCfgItem	obj

aDatabase *	db

Защищенные члены унаследованные от 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, для обеспечения работы документа с ситемным журналом.

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

◆ aDocJournal() [1/3]

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

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

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

◆ aDocJournal() [2/3]

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

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

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

◆ aDocJournal() [3/3]

aDocJournal::aDocJournal ( aDatabase * adb = 0 )

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

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

Методы

◆ CurrentDocument

aDocument * aDocJournal::CurrentDocument ( )

slot

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

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

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

◆ Delete

ERR_Code aDocJournal::Delete ( )

virtualslot

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

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

◆ deleteDocument()

ERR_Code aDocJournal::deleteDocument ( Q_ULLONG idd )

virtual

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

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

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

◆ docId()

Q_ULLONG aDocJournal::docId ( )

virtual

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

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

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

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

◆ docType()

int aDocJournal::docType ( )

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

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

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

◆ findDoc()

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

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

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

◆ findDocument()

Q_ULLONG aDocJournal::findDocument ( Q_ULLONG idd )

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

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

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

◆ getDate()

QVariant aDocJournal::getDate ( )

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

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

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

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

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

◆ getNumber()

QString aDocJournal::getNumber ( )

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

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

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

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

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

◆ getPrefix()

QString aDocJournal::getPrefix ( )

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

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

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

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

◆ getSerialNumber()

int aDocJournal::getSerialNumber ( )

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

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

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

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

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

◆ initObject()

ERR_Code aDocJournal::initObject ( )

virtual

Выполняет реальную инициализацию объекта. Вызывается из всех конструкторов. .

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

Перекрестные ссылки aCfg::attr(), aDatabase::cfg, aCfg::find(), aObject::LastErrorCode(), aCfg::parent(), aLog::print(), aObject::setLastError(), aDatabase::tableDbName(), aObject::tableInsert() и aCfg::text().

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

◆ New()

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

virtual

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

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

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

◆ nextNumber()

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

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

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

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

◆ Select [1/2]

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

virtualslot

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

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

◆ Select [2/2]

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

virtualslot

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

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

◆ selectDocument()

ERR_Code aDocJournal::selectDocument ( Q_ULLONG idd )

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

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

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

◆ selectionFilter() [1/2]

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

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

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

◆ selectionFilter() [2/2]

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

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

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

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

◆ setDate()

ERR_Code aDocJournal::setDate ( QVariant date )

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

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

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

◆ setNumber()

ERR_Code aDocJournal::setNumber ( QVariant number )

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

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

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

◆ type()

int aDocJournal::type ( )

inline

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

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

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

adocjournal.h
adocjournal.cpp

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

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

Дополнительные унаследованные члены

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

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

◆ aDocJournal() [1/3]

◆ aDocJournal() [2/3]

◆ aDocJournal() [3/3]

Методы

◆ CurrentDocument

◆ Delete

◆ deleteDocument()

◆ docId()

◆ docType()

◆ findDoc()

◆ findDocument()

◆ getDate()

◆ getNumber()

◆ getPrefix()

◆ getSerialNumber()

◆ initObject()

◆ New()

◆ nextNumber()

◆ Select [1/2]

◆ Select [2/2]

◆ selectDocument()

◆ selectionFilter() [1/2]

◆ selectionFilter() [2/2]

◆ setDate()

◆ setNumber()

◆ type()