$CLASSNAME$
	CODBIDLIST
$SUMMARY$
	CODB class are destined to select objects by assertion and represenation
	its in table-navigationy mode.
$LANG_RU$
	CODB        
	   - .
$ABOUT$
	CODB class are destined to select objects by assertion and represenation
	its in table-navigationy mode.
$LANG_RU$
	CODB        
	   - .
$SYNTAX$
	CODB_IdList(<oDbm>,<sMetaName>,<nIndex>,<sName>,<sWhereExpr>,<nCount>) --> CODBIDLIST object
$ATTRIBUTES$
	<ClassName> 	CODBIDLIST
	<Error>		String, the error description what araised within running last operation.
$LANG_RU$
	<ClassName> 	CODBIDLIST
	<Error>		String,  ,     .

$METHODNAME$
	CODB_IdList()
$SUMMARY$
	Constructor CODBIDLIST class.
$LANG_RU$
	  CODBIDLIST.
$SYNTAX$
	CODB_IdList(<oDbm>,<sMetaName>,<nIndex>,<sName>,<sWhereExpr>,<nCount>) --> CODBIDLIST object
$ARGUMENTS$
	<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
$LANG_RU$
	<oDbm>		Object,   CODBDICTIONARY  CODBDEPOSITORY
	<sMetaName>	String,      
	<nIndex>	Numeric,   
	<sName>		String,   <Name>;     ,
			 <Name>   <sName>
	<sWhereExpr>	String,  
	<nCount>	Numeric,     
$RETURNS$
	Method returns new CODBIDLIST object.
$LANG_RU$
	    CODBIDLIST.
$DESCRIPTION$
	CODB_IdList() inits new CODBIDLIST object and returns it.
$LANG_RU$
	CODB_IdList()    CODBIDLIST  .
$ENDMETHOD$

$METHODNAME$
	Dictionary()
$SUMMARY$
	Returns object CDOBDICTIONARY, what <::sMetaName> belong.
$LANG_RU$
	  CODBDITIONARY,   <::sMetaName>
$SYNTAX$
	Dictionary() 	--> <oDict>
$ARGUMENTS$

$RETURNS$
	Returns object CDOBDICTIONARY, what <::sMetaName> belong.
$LANG_RU$
	  CODBDITIONARY,   <::sMetaName>
$DESCRIPTION$
	Dictionary() returns <oDict> object <link linkend="classCODBDICTIONARY">CDOBDICTIONARY</link>, what <::sMetaName> belong.
$LANG_RU$
	Dictionary()  <oDict>  <link linkend="classCODBDICTIONARY">CODBDITIONARY</link>,   <::sMetaName>
$ENDMETHOD$

$METHODNAME$
	Depository()
$SUMMARY$
	Returns object CDOBDEPOSITORY, what <::sMetaName> belong.
$LANG_RU$
	  CODBDEPOSITORY,   <::sMetaName>
$SYNTAX$
	Depository() 	--> <oDep>
$ARGUMENTS$

$RETURNS$
	Returns object CDOBDEPOSITORY, what <::sMetaName> belong.
$LANG_RU$
	  CODBDITIONARY,   <::sMetaName>
$DESCRIPTION$
	Depository() returns <oDep> object <link linkend="classCODBDEPOSITORY">CDOBDEPOSITORY</link>, what <::sMetaName> belong.
$LANG_RU$
	Depository()  <oDep>  <link linkend="classCODBDEPOSITORY">CODBDEPOSITORY</link>,   <::sMetaName>
$ENDMETHOD$

$METHODNAME$
	Close()
$SUMMARY$
	Cancel job.
$LANG_RU$
	 .
$SYNTAX$
	Close() 	--> TRUE
$ARGUMENTS$

$RETURNS$
	Returns TRUE.
$LANG_RU$
	 TRUE.
$DESCRIPTION$
	Close() closes dictionary or depository and canceles job.
$LANG_RU$
	Close()       .
$ENDMETHOD$


$METHODNAME$
	GoTop()
$SUMMARY$
	Goes to first position.
$LANG_RU$
	  .
$SYNTAX$
	GoTop() 	--> FALSE
	GotoTop() 	--> FALSE
$ARGUMENTS$

$RETURNS$
	Returns FALSE.
$LANG_RU$
	 FALSE.
$DESCRIPTION$
	GoTop() and GotoTop() goes to first position.
$LANG_RU$
	GoTop()  GotoTop()      .
$ENDMETHOD$


$METHODNAME$
	GoBottom()
$SUMMARY$
	Goes to last position.
$LANG_RU$
	  .
$SYNTAX$
	GoBottom() 	--> FALSE
	GotoBottom() 	--> FALSE
$ARGUMENTS$

$RETURNS$
	Returns FALSE.
$LANG_RU$
	 FALSE.
$DESCRIPTION$
	GoBottom() and GotoBottom() goes to last position.
$LANG_RU$
	GoBottom()  GotoBottom()      .
$ENDMETHOD$

$METHODNAME$
	Skip()
$SUMMARY$
	Move relative to the current position.
$LANG_RU$
	   .
$SYNTAX$
	Skip([<nSkip>]) 	--> NIL
$ARGUMENTS$
	<nSkip>		Numeric, the numer of position move relative to the current position.
			If <nSkip> > 0 skip to forward, else backward.
$LANG_RU$
	<nSkip>		Numeric,  ,    .
			 <nSkip> > 0  ,  .
$RETURNS$
	Returns NIL.
$LANG_RU$
	 NIL.
$DESCRIPTION$
	Skip() moves either forward or backward relative to the current position.

	If <nSkip> not specified, it is 1.
$LANG_RU$
	Skip()       <nSkip>  
	.

	 <nSkip>  , <nSkip> == 1.
$ENDMETHOD$


$METHODNAME$
	Goto()
$SUMMARY$
	Goes to the new position.
$LANG_RU$
	   .
$SYNTAX$
	Goto(<nPos>]) 	--> TRUE || FALSE
$ARGUMENTS$
	<nPos>		Numeric, the new position
$LANG_RU$
	<nPos>		Numeric,  
$RETURNS$
	Returns FALSE if goes unfortunately.
$LANG_RU$
	 FALSE,     .
$DESCRIPTION$
	Goto() goes to the new position <nPos>.
$LANG_RU$
	Goto()      <nPos>.
$ENDMETHOD$


$METHODNAME$
	Recno()
$SUMMARY$
	Returns current position.
$LANG_RU$
	  .
$SYNTAX$
	Recno() 	--> <nPos>
$ARGUMENTS$
$RETURNS$
	Returns <nPos> the current position.
$LANG_RU$
	 <nPos>  .
$DESCRIPTION$
	Recno() returns <nPos> the current position.
$LANG_RU$
	Recno()  <nPos>  .
$ENDMETHOD$


$METHODNAME$
	Bof()
$SUMMARY$
	Check BOF.
$LANG_RU$
	   .
$SYNTAX$
	Bof() 	--> TRUE || FALSE
$ARGUMENTS$
$RETURNS$
	Returns TRUE if arrive at bottom of file.
$LANG_RU$
	 TRUE    .
$DESCRIPTION$
	Bof() returns TRUE if arrive at top of file.
$LANG_RU$
	Bof()  TRUE    .
$ENDMETHOD$


$METHODNAME$
	Eof()
$SUMMARY$
	Check EOF.
$LANG_RU$
	   .
$SYNTAX$
	Eof() 	--> TRUE || FALSE
$ARGUMENTS$
$RETURNS$
	Returns TRUE if arrive at bottom of file.
$LANG_RU$
	 TRUE    .
$DESCRIPTION$
	Eof() returns TRUE if arrive at bottom of file.
$LANG_RU$
	Eof()  TRUE    .
$ENDMETHOD$


$METHODNAME$
	Locate()
$SUMMARY$
	Locate first object, what equal some condition.
$LANG_RU$
	  ,  .
$SYNTAX$
	Locate(Expr) 	--> TRUE || FALSE
$ARGUMENTS$
	<Expr>	String or block code - the locate condition.
$LANG_RU$
	<Expr>	String or block code -  
$RETURNS$
	Returns TRUE if locate.
$LANG_RU$
	 TRUE   .
$DESCRIPTION$
	Locate() returns TRUE if object, what equal condition <Expr> is locate.
$LANG_RU$
	Locate()  TRUE  ,   <Expr> .
$ENDMETHOD$


$METHODNAME$
	LocateRest()
$SUMMARY$
	Restore locate with old condition.
$LANG_RU$
	    .
$SYNTAX$
	LocateRest() 	--> TRUE || FALSE
$ARGUMENTS$
$RETURNS$
	Returns TRUE if locate.
$LANG_RU$
	 TRUE   .
$DESCRIPTION$
	LocateRest() returns TRUE if object, what equal previouse condition is locate.
$LANG_RU$
	LocateRest()  TRUE  ,    .
$ENDMETHOD$


$METHODNAME$
	SetWhere()
$SUMMARY$
	Set new condition to object selection.
$LANG_RU$
	     .
$SYNTAX$
	SetWhere(<sWhereExpr>) 	--> NIL
$ARGUMENTS$
	<sWhereExpr>  String, condition of select.
$LANG_RU$
	<sWhereExpr>	String,  
$RETURNS$
	Returns NIL.
$LANG_RU$
	 NIL.
$DESCRIPTION$
	SetWhere() sets new condition <sWhereExpr> to object selection.
$LANG_RU$
	SetWhere()    <sWhereExpr>  .
$ENDMETHOD$

$METHODNAME$
	GetValue()
$SUMMARY$
	Get values of attribute.
$LANG_RU$
	  .
$SYNTAX$
	GetValue([<sAttrName>]) 	--> <vData>
$ARGUMENTS$
	<sAttrName>  String, the attribute name
$LANG_RU$
	<sAttrName>	String,  
$RETURNS$
	Returns attribute value <vData>.
$LANG_RU$
	   <vData>.
$DESCRIPTION$
	GetValue() returns attribute value <vData> or if <sAttrName> not
	specified returns whole object.
$LANG_RU$
	GetValue()    <vData> ,   <sAttrName>
	  -  .
$ENDMETHOD$

$METHODNAME$
	GetExpr()
$SUMMARY$
	Compute expression for current object.
$LANG_RU$
	    .
$SYNTAX$
	GetExpr(<sExpr>) 	--> <vData>
$ARGUMENTS$
	<sExpr>  String, the expression for computing.
$LANG_RU$
	<sExpr>	String,   .
$RETURNS$
	Returns the result of computing <sExpr>.
$LANG_RU$
	    <sExpr>.
$DESCRIPTION$
	GetExpr() compute expression for current object and returns result <vData>.
$LANG_RU$
	GetExpr()   <sExpr>     
	  -  .
$ENDMETHOD$

$METHODNAME$
	GetBlank()
$SUMMARY$
	Returns object of class <sMetaName>
$LANG_RU$
	   <sMetaName>.
$SYNTAX$
	GetBlank() 	--> <oData>
$ARGUMENTS$
$RETURNS$
	Returns <oData> - the object of class <sMetaName>.
$LANG_RU$
	 <oData> -   <sMetaName>.
$DESCRIPTION$
	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.
$LANG_RU$
	GetBlank()  <oData> -   <sMetaName>.  
	    .

	 <sMetaName> -  ,      CODBIDLIST.
$ENDMETHOD$

$METHODNAME$
	SetIndex()
$SUMMARY$
	Set index.
$LANG_RU$
	 .
$SYNTAX$
	SetIndex(<vIndex>) 	--> TRUE || FALSE
$ARGUMENTS$
	<vIndex>	The number or name of index.
$LANG_RU$
	<vIndex>	   .
$RETURNS$
	Returns TRUE if index setted.
$LANG_RU$
	 TRUE   .
$DESCRIPTION$
	SetIndex() returns TRUE if index with number <vIndex> or with
	name <vIndex> setted. In other returns FALSE.
$LANG_RU$
	SetIndex()  TRUE     <vIndex>  
	<vIndex> .  -  FALSE.
$ENDMETHOD$

$METHODNAME$
	Delete()
$SUMMARY$
	Delete current object.
$LANG_RU$
	  .
$SYNTAX$
	Delete() 	--> TRUE || FALSE
$ARGUMENTS$
$RETURNS$
	Returns TRUE if current object deleted.
$LANG_RU$
	 TRUE    .
$DESCRIPTION$
	Delete() returns TRUE if current object deleted from a dictionary or
	from a depository. In other returns FALSE.
$LANG_RU$
	Delete()  TRUE       
	.  -  FALSE.
$ENDMETHOD$

$METHODNAME$
	Append()
$SUMMARY$
	Append new object.
$LANG_RU$
	  .
$SYNTAX$
	Append(<oData>) 	--> <sDataID>
$ARGUMENTS$
	<oData> 	Object, new object to keeping
$LANG_RU$
	<oData> 	Object,    .
$RETURNS$
	Returns <sDataID> - identifier registered object.
$LANG_RU$
	 <sDataID> -   .
$DESCRIPTION$
	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.
$LANG_RU$
	Append()    <oData>     
	<sMetaName>    
	 <sDataID>.

	 <sMetaName> -  ,      CODBIDLIST.

	<::Error>   ,   .
$ENDMETHOD$

$METHODNAME$
	Update()
$SUMMARY$
	Update object.
$LANG_RU$
	 .
$SYNTAX$
	Update(<oData>) 	--> TRUE || FALSE
$ARGUMENTS$
	<oData> 	Object, object to updating
$LANG_RU$
	<oData> 	Object,   
$RETURNS$
	Returns TRUE if object updated.
$LANG_RU$
	 TRUE   .
$DESCRIPTION$
	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.
$LANG_RU$
	Update()   <oData>  .      
	   <oData:ID>, Update()  FALSE.

	<::Error>   ,   .
$ENDMETHOD$

$METHODNAME$
	Refresh()
$SUMMARY$
	Refresh object list.
$LANG_RU$
	  .
$SYNTAX$
	Refresh() 	--> NIL
$ARGUMENTS$
$RETURNS$
	Returns NIL.
$LANG_RU$
	 NIL.
$DESCRIPTION$
	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.
$LANG_RU$
	Refresh()   .    
	  <sName>  <sWhereExpr>.

	<sName>  <sWhereExpr> -  ,      CODBIDLIST.

	<::Error>   ,   .
$ENDMETHOD$


$METHODNAME$
	IdExist()
$SUMMARY$
	Check object a existence storehouse.
$LANG_RU$
	     .
$SYNTAX$
	IdExist(<sDataID>) 	--> TRUE || FALSE
$ARGUMENTS$
	<sDataID>	String, object identifier
$LANG_RU$
	<sDataID>	String,  .
$RETURNS$
	Returns TRUE if object exist into storehouse.
$LANG_RU$
	 TRUE     .
$DESCRIPTION$
	IdExist() returns TRUE if object with identifier <sDataID> exist into dictionary
	or depository.
$LANG_RU$
	IdExist()  TRUE     <sDataID>   
	 .
$ENDMETHOD$


$EXAMPLES$
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

$PLATFORMS$
   No dependies of platform.
$SEEALSO$
	CODBDICTIONARY, CODBDEPOSITORY
$AUTHOR$
ITK
$LASTDATE$



