Компилятор, совместимый с языками семейства xBase и Clipper
Пред.След.

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> содержит описание ошибки, если таковая произошла.

<oData>

Object, новый объект для хранения.

Returns :

Возвращает <sDataID> - идентификатор добавленного объекта.

Method CODBIDLIST:BOF()

 Bof() 	--> TRUE || FALSE

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

Returns :

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

Method CODBIDLIST:CLOSE()

 Close() 	--> TRUE

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

Returns :

Возвращает TRUE.

Method CODBIDLIST:CODBIDLIST()

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

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

<oDbm>

Object, объект класса CODBDICTIONARY или CODBDEPOSITORY

<sMetaName>

String, имя метакласса или идентификатор хранимого объекта

<nIndex>

Numeric, порядковый номер индекса

<sName>

String, значение атрибута <Name>; список хранит только те объекты, свойство <Name> которых равно <sName>

<sWhereExpr>

String, выражение условия

<nCount>

Numeric, максимальное количество объектов в списке

Returns :

Метод возвращает новый объект CODBIDLIST.

Method CODBIDLIST:DELETE()

 Delete() 	--> TRUE || FALSE

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

Returns :

Возвращает TRUE если текущий объект удален.

Method CODBIDLIST:DEPOSITORY()

 Depository() 	--> <oDep>

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

Returns :

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

Method CODBIDLIST:DICTIONARY()

 Dictionary() 	--> <oDict>

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

Returns :

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

Method CODBIDLIST:EOF()

 Eof() 	--> TRUE || FALSE

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

Returns :

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

Method CODBIDLIST:GETBLANK()

 GetBlank() 	--> <oData>

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

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

Returns :

Возвращает <oData> - объект класса <sMetaName>.

Method CODBIDLIST:GETEXPR()

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

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

<sExpr>

String, выражение для вычисления.

Returns :

Возвращает результат вычисления выражения <sExpr>.

Method CODBIDLIST:GETVALUE()

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

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

<sAttrName>

String, название атрибута

Returns :

Возвращает значение атрибута <vData>.

Method CODBIDLIST:GOBOTTOM()

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

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

Returns :

Возвращает FALSE.

Method CODBIDLIST:GOTO()

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

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

<nPos>

Numeric, новая позиция

Returns :

Возвращает FALSE, если переход не состоялся.

Method CODBIDLIST:GOTOP()

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

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

Returns :

Возвращает FALSE.

Method CODBIDLIST:IDEXIST()

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

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

<sDataID>

String, идентификатор объекта.

Returns :

Возвращает TRUE если объект существует в хранилище.

Method CODBIDLIST:LOCATE()

 Locate(Expr) 	--> TRUE || FALSE

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

<Expr>

String or block code - условия поиска

Returns :

Возвращает TRUE если объект найден.

Method CODBIDLIST:LOCATEREST()

 LocateRest() 	--> TRUE || FALSE

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

Returns :

Возвращает TRUE если объект найден.

Method CODBIDLIST:RECNO()

 Recno() 	--> <nPos>

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

Returns :

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

Method CODBIDLIST:REFRESH()

 Refresh() 	--> NIL

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

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

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

Returns :

Возвращает NIL.

Method CODBIDLIST:SETINDEX()

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

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

<vIndex>

Номер или название индекса.

Returns :

Возвращает TRUE если индекс устаовлен.

Method CODBIDLIST:SETWHERE()

 SetWhere(<sWhereExpr>) 	--> NIL

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

<sWhereExpr>

String, условия отбора

Returns :

Возвращает NIL.

Method CODBIDLIST:SKIP()

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

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

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

<nSkip>

Numeric, количество позиций, на которое перемещается указатель. Если <nSkip> > 0 перемещение вперед, иначе назад.

Returns :

Возвращает NIL.

Method CODBIDLIST:UPDATE()

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

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

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

<oData>

Object, объект для обновления

Returns :

Возвращает TRUE если объект обновлен.

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.

Пред.НачалоСлед.
Class CODBFORMATTERУровень вышеClass CODBLIST