Ananas Library  0.9.5
Открытые слоты | Открытые члены | Защищенные члены | Полный список членов класса
Класс aCatalogue

Класс aCatalogue определяет программный интерфейс иерархических справочников. Наследует aObject. Подробнее...

#include <acatalogue.h>

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

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

virtual int New (bool child)
 Задает идентификатор группы. Подробнее...
 
virtual int New ()
 Создает новый элемент справочника в текущей группе. Подробнее...
 
virtual int Delete ()
 Выполняет удаление текущего элемента каталога. Подробнее...
 
virtual int newGroup (Q_ULLONG parentId)
 
virtual int newElement (Q_ULLONG parentId)
 
virtual int Update ()
 Обновляет значение элемента справочника в базе данных.
 
virtual int Copy ()
 Клонирует элемент справочника, создавая новый элемент с теми же значениями свойств что и у текущего элемента. Подробнее...
 
virtual int Select (bool grouponly=false)
 Делает один (первый) элемент справочника текущим. Подробнее...
 
void UnSelect (bool grouponly=false)
 Выставляет признаки выбранности элемента/группы в false.
 
virtual int selectByLevel (int level)
 
virtual int selectByGroup (Q_ULLONG idg)
 
virtual Q_ULLONG idGroupByElement (Q_ULLONG ide)
 
virtual int groupSelect (Q_ULLONG idg)
 
virtual QVariant GetElementValue (QVariant ide, const QString &fname)
 
virtual bool FindById (QString el_id)
 
virtual Q_ULLONG delElement ()
 
virtual Q_ULLONG delGroup (Q_ULLONG idg, QValueList< Q_ULLONG > &listDelId)
 
Q_ULLONG setMarkDeletedElement (Q_ULLONG el_id, bool del)
 
Q_ULLONG setMarkDeletedGroup (Q_ULLONG gr_id, bool del)
 
void getMarkDeletedList (Q_ULLONG idg, QValueList< Q_ULLONG > &listDelId)
 
virtual bool isGroupMarkDeleted ()
 
virtual bool isElementMarkDeleted ()
 
virtual bool Next ()
 
virtual bool Prev ()
 
virtual bool First ()
 
virtual bool Last ()
 
virtual bool NextInGroupTable ()
 
virtual bool PrevInGroupTable ()
 
virtual bool FirstInGroupTable ()
 
virtual bool LastInGroupTable ()
 
virtual int GroupNew (bool reparent=false)
 
virtual int GroupDelete ()
 
virtual int GroupMarkDeleted ()
 
virtual int GroupUpdate ()
 
virtual int GroupSelect ()
 
virtual int GroupSetGroup (aCatalogue *cat)
 
virtual QVariant GroupValue (const QString &name)
 
virtual int GroupSetValue (const QString &name, const QVariant &value)
 
virtual QVariant GroupSysValue (const QString &name)
 
virtual int GroupSetSysValue (const QString &name, const QVariant &value)
 
virtual QStringList getUserFields ()
 
virtual QStringList getGroupUserFields ()
 
- Открытые слоты 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 ()
 Возвращает сообщение, поясняющее последнюю ошибку. Подробнее...
 

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

 aCatalogue (aCfgItem context, aDatabase *adb=0)
 Конструктор.
 
 aCatalogue (QString name, aDatabase *adb=0)
 Конструктор.
 
virtual ERR_Code initObject ()
 Выполняет реальную инициализацию объекта. Вызывается всеми конструкторами.
 
- Открытые члены 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 запрос. Подробнее...
 
aDataTabletable (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 aCfgItem displayStringContext ()
 Возвращает контекст (узел дерева) метаданных для вычисления строкового представления сложного типа.
 
- Защищенные члены inherited from aObject
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 класса Подробнее...
 

Additional Inherited Members

- Открытые атрибуты inherited from aObject
aCfgmd
 
aCfgItem obj
 
aDatabasedb
 
- Защищенные данные inherited from aObject
bool concrete
 

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

Класс aCatalogue определяет программный интерфейс иерархических справочников. Наследует aObject.

Не визуальный объект используемый для работы с иерархическими каталогами (справочниками). Используется как интерфейс между базой данных и скриптами или wObjects*

Методы

ERR_Code aCatalogue::Copy ( )
virtualslot

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

Возвращает
err_noerror в случае успеха.

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

Q_ULLONG aCatalogue::delElement ( )
virtualslot

Только удаляет элемент. Не поддерживает связь один ко многим.

Возвращает
идентификационный номер удаляемого элемента.

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

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

ERR_Code aCatalogue::Delete ( )
virtualslot

Выполняет удаление текущего элемента каталога.

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

Возвращает
err_notable, err_notselected в случае возникновения ошибки. Или то, что вернет aObject::Delete()

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

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

Q_ULLONG aCatalogue::delGroup ( Q_ULLONG  idg,
QValueList< Q_ULLONG > &  listDelId 
)
virtualslot

Физически удаляет группу со всеми ее дочерними элементами и группами.

Аргументы
idg(in) - идентификационный номер выделенной для удаления группы.
listDelId(in,out) - список идентификационных номеров выделенных для удаления элементов и групп.

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

bool aCatalogue::FindById ( QString  el_id)
virtualslot

Находит и позиционирует курсор на элемент справочника с ID=el_id

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

QStringList aCatalogue::getGroupUserFields ( )
virtualslot

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

void aCatalogue::getMarkDeletedList ( Q_ULLONG  idg,
QValueList< Q_ULLONG > &  listDelId 
)
slot

Выделяет удаляемую группу с дочерними элементами и группами. При первом вызове параметр listDelId должен быть пустой, он не обнуляется автоматически при вызове этой функции. Функция рекурсивно вызывает сама себя для всех дочерних подгрупп и добавляет их id в список. Также туда добавляются и id элементов, содержащихся в этих группах. Для изменения атрибута удаления используте функции setElementMarkDeleted(id)(для элементов) и setGroupMarkDeleted(id) (для групп)

Аргументы
idg(in) - идентификационный номер выделенной для удаления группы.
listDelId(in,out) - список идентификационных номеров выделенных для удаления элементов и групп.

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

QStringList aCatalogue::getUserFields ( )
virtualslot

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

int aCatalogue::GroupSelect ( )
virtualslot
Возвращает

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

QVariant aCatalogue::GroupSysValue ( const QString &  name)
virtualslot

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

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

Q_ULLONG aCatalogue::idGroupByElement ( Q_ULLONG  ide)
virtualslot

Получает идентификационный номер группы по номеру элемента

Аргументы
ide(in) - идентификационный номер элемента.
Возвращает
идентификационный номер группы.

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

ERR_Code aCatalogue::New ( bool  child)
virtualslot

Задает идентификатор группы.

    \return константу err_notable или err_notselected в случае ошибки. err_noerror в случае успеха.

Задает значение идентификатора текущей группы равным значению идентификатора текущей группы указанного Справочника.

Аргументы
cat- Каталог значение идентификатора текущей группы которого используется.
Возвращает
константу err_notable или err_notselected в случае ошибки. err_noerror в случае успеха. Возвращает идентификатор владельца. Задает идентификатор владельца.
    \return константу err_notable или err_notselected в случае ошибки. err_noerror в случае успеха.

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

    Новый элемент будет создан либо как элемент текущей группы, либо 
    как дочерний элемент выбранного элемента справочника.
    \param child - задает вариант создания элемента. true - будет создан дочерний элемент текущего элемента 
    справочника. false - будет создан элемент в текущей группк
    \return err_noerror в случае успешного выполнения или ошибки, возвращаемые методом aObject::New()

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

ERR_Code aCatalogue::New ( )
virtualslot

Создает новый элемент справочника в текущей группе.

Возвращает
то же, что и aCatalogue::New( bool child )
ERR_Code aCatalogue::newElement ( Q_ULLONG  parentId)
virtualslot

Вставляет новый элемент в таблицу элементов

Аргументы
parentId(in) - идентификационный номер группы предка.

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

ERR_Code aCatalogue::newGroup ( Q_ULLONG  parentId)
virtualslot

Вставляет новую группу в таблицу групп

Аргументы
parentId(in) - идентификационный номер группы предка или 0 если нет предка.

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

ERR_Code aCatalogue::Select ( bool  grouponly = false)
virtualslot

Делает один (первый) элемент справочника текущим.

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

Аргументы
grouponly- значение true требует, чтобы текущим стал один из элементов текущей группы. Значение false означает, что текущим элементом станет первый элемент справочника, а не первый элемент текущей группы.

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

Q_ULLONG aCatalogue::setMarkDeletedElement ( Q_ULLONG  id_el,
bool  del 
)
slot

Только выделяет удаляемый элемент. Не поддерживает связь один ко многим.

Возвращает
идентификационный номер удаляемого элемента.

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


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