Class CODBIDLIST

Name

CODBIDLIST  --  CODB класс предназначен для отбора объектов удовлетворяющих условию и представления их в таблично-навигационном виде.

Synopsis

 CODB_IdList(<oDbm>,<sMetaName>,<nIndex>,<sName>,<sWhereExpr>,<nCount>) --> CODBIDLIST object

Description

CODB класс предназначен для отбора объектов удовлетворяющих условию и представления их в таблично-навигационном виде.

Attributes

<ClassName> CODBIDLIST
<Error> String, описание ошибки, возникшей при выполнении последней операции.
  

Methods

APPEND Добавить новый объект.
BOF Проверить на начало файла.
CLOSE Закончить работу.
CODBIDLIST Конструктор класса CODBIDLIST.
DELETE Удалить текущий объект.
DEPOSITORY Возвращает объект CODBDEPOSITORY, которому принадлежит <::sMetaName>
DICTIONARY Возвращает объект CODBDITIONARY, которому принадлежит <::sMetaName>
EOF Проверить на конец файла.
GETBLANK Вернуть объект класса <sMetaName>.
GETEXPR Вычислить выражение для текущего объекта.
GETVALUE Получить значение атрибута.
GOBOTTOM Перейти вм конец.
GOTO Перейти на новую позицию.
GOTOP Перейти на начало.
IDEXIST Проверить объект на существование в хранилище.
LOCATE Найти первый объект, удовлетворяющий выражению.
LOCATEREST Продолжить поиск с прежними условиями.
RECNO Вернуть текущую позицию.
REFRESH Перечитать список объектов.
SETINDEX Установить индекс.
SETWHERE Задать новые условия для выбора объектов.
SKIP Переместить относительно текущей позиции.
UPDATE Обновить объект.

Method CODBIDLIST:APPEND()

 Append(<oData>) 	--> <sDataID>

Append() добавляет новый объект <oData> в хранилище как объект класса <sMetaName> и возвращает идентификатор зарегистрированного объекта <sDataID>.

Класс <sMetaName> - это класс, который был передан в конструктор CODBIDLIST.

<::Error> содержит описание ошибки, если таковая произошла.

Method CODBIDLIST:BOF()

 Bof() 	--> TRUE || FALSE

Bof() возвращает TRUE если достигнуто начало файла.

Method CODBIDLIST:CLOSE()

 Close() 	--> TRUE

Close() закрывает словарь или депозитарий и заканчивает работу.

Method CODBIDLIST:CODBIDLIST()

 CODB_IdList(<oDbm>,<sMetaName>,<nIndex>,<sName>,<sWhereExpr>,<nCount>) --> CODBIDLIST object

CODB_IdList() инициализирует новый объект CODBIDLIST возвращает его.

Method CODBIDLIST:DELETE()

 Delete() 	--> TRUE || FALSE

Delete() возвращает TRUE если текущий объект удален из словаря или депозитария. Иначе - возвращает FALSE.

Method CODBIDLIST:DEPOSITORY()

 Depository() 	--> <oDep>

Depository() возвращает <oDep> объект CODBDEPOSITORY, которому принадлежит <::sMetaName>

Method CODBIDLIST:DICTIONARY()

 Dictionary() 	--> <oDict>

Dictionary() возвращает <oDict> объект CODBDITIONARY, которому принадлежит <::sMetaName>

Method CODBIDLIST:EOF()

 Eof() 	--> TRUE || FALSE

Eof() возвращает TRUE если достигнут конец файла.

Method CODBIDLIST:GETBLANK()

 GetBlank() 	--> <oData>

GetBlank() возвращает <oData> - объект класса <sMetaName>. Все атрибуты объекта заполняются значениями по умолчанию.

Класс <sMetaName> - это класс, который был передан в конструктор CODBIDLIST.

Method CODBIDLIST:GETEXPR()

 GetExpr(<sExpr>) 	--> <vData>

GetExpr() вычисляет выражение <sExpr> для текущего объекта и возвращает не задан - весь объект.

Method CODBIDLIST:GETVALUE()

 GetValue([<sAttrName>]) 	--> <vData>

GetValue() возвращает значение атрибута <vData> или, если атрибут <sAttrName> не задан - весь объект.

Method CODBIDLIST:GOBOTTOM()

 GoBottom() 	--> FALSE
 GotoBottom() 	--> FALSE

GoBottom() и GotoBottom() перемещают указатель на последнюю позицию списка.

Method CODBIDLIST:GOTO()

 Goto(<nPos>]) 	--> TRUE || FALSE

Goto() перемещает указатель на новую позицию <nPos>.

Method CODBIDLIST:GOTOP()

 GoTop() 	--> FALSE
 GotoTop() 	--> FALSE

GoTop() и GotoTop() перемещают указатель на первую позицию списка.

Method CODBIDLIST:IDEXIST()

 IdExist(<sDataID>) 	--> TRUE || FALSE

IdExist() возвращает TRUE если объект с идентификатором <sDataID> зарегистрирован в словаре или депозитарии.

Method CODBIDLIST:LOCATE()

 Locate(Expr) 	--> TRUE || FALSE

Locate() возвращает TRUE если объект, удовлетворяющий условию <Expr> найден.

Method CODBIDLIST:LOCATEREST()

 LocateRest() 	--> TRUE || FALSE

LocateRest() возвращает TRUE если объект, удовлетворяющий предыдущему условию найден.

Method CODBIDLIST:RECNO()

 Recno() 	--> <nPos>

Recno() возвращает <nPos> текущую позицию.

Method CODBIDLIST:REFRESH()

 Refresh() 	--> NIL

Refresh() обновляет список объектов. Каждый элемент списка удовлетворяет начальным условиям <sName> и <sWhereExpr>.

<sName> и <sWhereExpr> - это параметры, которые были переданы в конструктор CODBIDLIST.

<::Error> содержит описание ошибки, если таковая произошла.

Method CODBIDLIST:SETINDEX()

 SetIndex(<vIndex>) 	--> TRUE || FALSE

SetIndex() возвращает TRUE если индекс с номером <vIndex> или названием <vIndex> установлен. Иначе - возвращает FALSE.

Method CODBIDLIST:SETWHERE()

 SetWhere(<sWhereExpr>) 	--> NIL

SetWhere() задает новые условия <sWhereExpr> отбора объектов.

Method CODBIDLIST:SKIP()

 Skip([<nSkip>]) 	--> NIL

Skip() перемещает вперед или назад указатель на <nSkip> позиций относительно текущей.

Если <nSkip> не определено, <nSkip> == 1.

Method CODBIDLIST:UPDATE()

 Update(<oData>) 	--> TRUE || FALSE

Update() обновляет объект <oData> в хранилище. Если словарь или депозитарий не содержит объект с идентификатором <oData:ID>, Update() возвращает FALSE.

<::Error> содержит описание ошибки, если таковая произошла.

Example:

 oDep := coDepository():new("MY00101")
 oDict := oDep:dictionary()
 currency := oDict:classBodyByName("currency")
 
 * select all objects of currency class whose attribute <CODE> begin with "U"
 idList:= codb_idList(currency:id,,,'code="U"')
 while !idList:eof()
 obj := idList:getValue()
 ? obj:code, obj:name
 idList:skip()
 end
 

See also

CODBDICTIONARY CODBDEPOSITORY

Platforms

No dependies of platform.