CODB class are destined to select objects by assertion and represenation its in table-navigationy mode.
CODB_IdList(<oDbm>,<sMetaName>,<nIndex>,<sName>,<sWhereExpr>,<nCount>) --> CODBIDLIST object
| APPEND | Append new object. |
| BOF | Check BOF. |
| CLOSE | Cancel job. |
| CODBIDLIST | Constructor CODBIDLIST class. |
| DELETE | Delete current object. |
| DEPOSITORY | Returns object CDOBDEPOSITORY, what <::sMetaName> belong. |
| DICTIONARY | Returns object CDOBDICTIONARY, what <::sMetaName> belong. |
| EOF | Check EOF. |
| GETBLANK | Returns object of class <sMetaName> |
| GETEXPR | Compute expression for current object. |
| GETVALUE | Get values of attribute. |
| GOBOTTOM | Goes to last position. |
| GOTO | Goes to the new position. |
| GOTOP | Goes to first position. |
| IDEXIST | Check object a existence storehouse. |
| LOCATE | Locate first object, what equal some condition. |
| LOCATEREST | Restore locate with old condition. |
| RECNO | Returns current position. |
| REFRESH | Refresh object list. |
| SETINDEX | Set index. |
| SETWHERE | Set new condition to object selection. |
| SKIP | Move relative to the current position. |
| UPDATE | Update object. |
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
No dependies of platform.
Append new object.
Append(<oData>) --> <sDataID>
Returns <sDataID> - identifier registered object.
Append() appends new object <oData> to storehouse as object of class <sMetaName> and returns objects identifier <sDataID>.
Class <sMetaName> - that class what was passed to constructor of CODBIDLIST.
<::Error> contain error descriptions if araised.
Check BOF.
Bof() --> TRUE || FALSE
No arguments
Returns TRUE if arrive at bottom of file.
Bof() returns TRUE if arrive at top of file.
Cancel job.
Close() --> TRUE
No arguments
Returns TRUE.
Close() closes dictionary or depository and canceles job.
Constructor CODBIDLIST class.
CODB_IdList(<oDbm>,<sMetaName>,<nIndex>,<sName>,<sWhereExpr>,<nCount>) --> CODBIDLIST object
| <oDbm> | Object, object of class CODBDICTIONARY or CODBDEPOSITORY |
| <sMetaName> | String, the metaclass name or identifier of keeping class. |
| <nIndex> | Numeric, the index number |
| <sName> | String, the value of attribute <Name>; list kept objects whouse |
| propoerties <Name> is equal <sName> | |
| <sWhereExpr> | String, the searching condition |
| <nCount> | Numeric, the maximize count objects in list |
Method returns new CODBIDLIST object.
CODB_IdList() inits new CODBIDLIST object and returns it.
Delete current object.
Delete() --> TRUE || FALSE
No arguments
Returns TRUE if current object deleted.
Delete() returns TRUE if current object deleted from a dictionary or from a depository. In other returns FALSE.
Returns object CDOBDEPOSITORY, what <::sMetaName> belong.
Depository() --> <oDep>
No arguments
Returns object CDOBDEPOSITORY, what <::sMetaName> belong.
Depository() returns <oDep> object CDOBDEPOSITORY, what <::sMetaName> belong.
Returns object CDOBDICTIONARY, what <::sMetaName> belong.
Dictionary() --> <oDict>
No arguments
Returns object CDOBDICTIONARY, what <::sMetaName> belong.
Dictionary() returns <oDict> object CDOBDICTIONARY, what <::sMetaName> belong.
Check EOF.
Eof() --> TRUE || FALSE
No arguments
Returns TRUE if arrive at bottom of file.
Eof() returns TRUE if arrive at bottom of file.
Returns object of class <sMetaName>
GetBlank() --> <oData>
No arguments
Returns <oData> - the object of class <sMetaName>.
GetBlank() returns <oData> - the object of class <sMetaName>. All atributes <oData> filled values by default.
Class <sMetaName> - that class what was passed to constructor of CODBIDLIST.
Compute expression for current object.
GetExpr(<sExpr>) --> <vData>
Returns the result of computing <sExpr>.
GetExpr() compute expression for current object and returns result <vData>.
Get values of attribute.
GetValue([<sAttrName>]) --> <vData>
Returns attribute value <vData>.
GetValue() returns attribute value <vData> or if <sAttrName> not specified returns whole object.
Goes to last position.
GoBottom() --> FALSE GotoBottom() --> FALSE
No arguments
Returns FALSE.
GoBottom() and GotoBottom() goes to last position.
Goes to the new position.
Goto(<nPos>]) --> TRUE || FALSE
Returns FALSE if goes unfortunately.
Goto() goes to the new position <nPos>.
Goes to first position.
GoTop() --> FALSE GotoTop() --> FALSE
No arguments
Returns FALSE.
GoTop() and GotoTop() goes to first position.
Check object a existence storehouse.
IdExist(<sDataID>) --> TRUE || FALSE
Returns TRUE if object exist into storehouse.
IdExist() returns TRUE if object with identifier <sDataID> exist into dictionary or depository.
Locate first object, what equal some condition.
Locate(Expr) --> TRUE || FALSE
Returns TRUE if locate.
Locate() returns TRUE if object, what equal condition <Expr> is locate.
Restore locate with old condition.
LocateRest() --> TRUE || FALSE
No arguments
Returns TRUE if locate.
LocateRest() returns TRUE if object, what equal previouse condition is locate.
Returns current position.
Recno() --> <nPos>
No arguments
Returns <nPos> the current position.
Recno() returns <nPos> the current position.
Refresh object list.
Refresh() --> NIL
No arguments
Returns NIL.
Refresh() updates object list. Every object in this list is content strart conditions <sName> and <sWhereExpr>.
<sName> and <sWhereExpr> - that parameters what was passed to constructor of CODBIDLIST.
<::Error> contain error descriptions if araised.
Set index.
SetIndex(<vIndex>) --> TRUE || FALSE
Returns TRUE if index setted.
SetIndex() returns TRUE if index with number <vIndex> or with name <vIndex> setted. In other returns FALSE.
Set new condition to object selection.
SetWhere(<sWhereExpr>) --> NIL
Returns NIL.
SetWhere() sets new condition <sWhereExpr> to object selection.
Move relative to the current position.
Skip([<nSkip>]) --> NIL
Returns NIL.
Skip() moves either forward or backward relative to the current position.
If <nSkip> not specified, it is 1.
Update object.
Update(<oData>) --> TRUE || FALSE
Returns TRUE if object updated.
Update() updates object <oData> into storehouse. If dictionary or depository have not object with identifier <oData:ID>, Update() returns FALSE.
<::Error> contain error descriptions if araised.