The essence this CODB class is storehouse of metadata - objects what keeping specifier other objects of classes: DEPOSIT,EXTENT,ATTR,COUNTER,INDEX,CLASS,TCOLUMN,TVIEW,REPORT,PLUGINS,USER,GROUP
coDictionaryNew(<sDictID>, <sUser>, <sPasswd>) --> CODBDICTIONARY object coDictionary:New(<sDictID>, <sUser>, <sPasswd>) --> CODBDICTIONARY object
APPEND | Append object to storehouse. |
ATTRBODYBYNAME | Returns object of metaclass ATTR. |
CHECKBODY | Checks object a valid metaclass. |
CLASSBODYBYNAME | Returns object of metaclass CLASS. |
CLOSE | Close opened files. |
COUNTER | Returns counter value. |
CREATE | Create empty dictionary. |
DELETE | Delete object from storehouse. |
GETVALUE | Get object from storehouse. |
HASHNAME | Returns properties name by hashcode. |
IDLIST | Returns object of class IDLIST. |
NEW | Initiation new CODBDICTIONARY object. |
OPEN | Open all necessary files. |
PADRBODY | Makes data representation. |
SELECT | Returns identifier list of selected objects. |
UPDATE | Update object into storehouse. |
/* create new object of class CODICTIONARY */ oDict := coDictionary():new("MY001") oDict:open() .... /* create new object specifier */ depBody := map() depBody:name := "depository for Russian global information" ... /* append object to dictionary */ dep_id := oDict:append(depBody,"DEPOSIT") /* check error */ if !empty(oDict:error) ? "Error:",oDict:error endif
No dependies of platform.
Append object to storehouse.
Append(<oData>, <sClassName>) --> <sDataID>
Returns <sDataID> - identifier registered object.
Append() appends new object <oData> to storehouse as object of class <sClassName> and returns objects identifier <sDataID>.
The structure description of added metadata see in section CODB metadata
<::Error> contain error descriptions if araised.
Returns object of metaclass ATTR.
AttrBodyByName(<sObjClassName>) --> <oData>
Returns <oData> - object of class ATTR.
AttrBodyByName() returns <oData> - object of class ATTR with name <sClassObjName>.
Checks object a valid metaclass.
CheckBody(<oData>, <sClassName>) --> <oData>
Returns object <oData>.
CheckBody() checks object <oData> a valid metaclass <sClassName>. If object is a valid, CheckBody() fills <oData> properties the default values if necessary.
<::Error> contain error descriptions if araised.
Returns object of metaclass CLASS.
ClassBodyByName(<sObjClassName>) --> <oData>
Returns <oData> - object of class CLASS.
ClassBodyByName() returns <oData> - object of class CLASS with name <sClassObjName>.
Close opened files.
Close() --> TRUE || FALSE
No arguments
Returns TRUE if files closed.
Close() is close files or connection with SQL server.
Returns counter value.
Counter(<sCounterName>, <nDep>[, <nValue>]) --> <nCounter>
Returns current counter value.
Counter() returns <nCounter> the current value for counter with name <sCounterName> into depository with number <nDep>.
If specified <nValue>, then counter <sCounterName> takes new value <nValue>.
Create empty dictionary.
Create() --> TRUE || FALSE
No arguments
Returns TRUE if new empty dictionary created.
Create() returns TRUE if new empty ditionary created. Usualy, this method do not needy to direct invitation. It's call automaticaly when new dictionary appending into CODBLIST.
<::Error> contain error descriptions if araised.
Delete object from storehouse.
Delete(<sDataID>) --> TRUE || FALSE
Returns TRUE if object was deleted.
Delete() deletes object with identifier <sDataID> from dictionary.
<::Error> contain error descriptions if araised.
Get object from storehouse.
GetValue(<sDataID>) --> <oData>
Returns object <oData> with identifier <sDataID>.
GetValue() gets form dictionary and returns object <oData> with identifier <sDataID>.
<::Error> contain error descriptions if araised.
Returns properties name by hashcode.
HashName(<nHashCode>) --> <sName>
Returns properties name by hashcode.
HashName() returns <sName> properties name by hashcode <nHashCode> or empty string if unfortunately.
Returns object of class IDLIST.
IdList(<sClassName>[, <nOrder>][, <sName>][, <sWhere>]) --> <oIDList>
Returns <oIDList> - object of class IDLIST.
IdList() returns <oIDList> - object of class CODBIDLIST.
Initiation new CODBDICTIONARY object.
New(<sDictID>, <sUser>, <sPasswd>) --> CODBDICTIONARY object
Method returns new CODBDICTIONARY object.
New() inits new CODBDICTIONARY object and returns it.
If object <sDictID> already exist, New() openes and returns this dictionary.
Open all necessary files.
Open() --> TRUE || FALSE
No arguments
Returns TRUE if files opened.
Open() openes all necessary files or openes connection with SQL server.
<::Error> contain error descriptions if araised.
Makes data representation.
PadrBody(<oData>, <sClassName>) --> <oData>
Returns object <oData>.
PadrBody() makes data representation for <oData> to metaclass <sClassName>.
<::Error> contain error descriptions if araised.
Returns identifier list of selected objects.
Select(<sClassName>[, <nOrder>][, <sName>][, <sWhere>]) --> <aIdent>
Returns <aIdent> array of object identifier what equal searching condition.
Select() returns for class <sClassName> identifier list <aIdent> selected objects in order <nOrder> whose attribute <Name> == <sName> and attributes equal <sWhere>.
<::Error> contain error descriptions if araised.
Update object into storehouse.
Update(<oData>) --> TRUE || FALSE
Returns TRUE if object updated.
Update() updates object <oData> into storehouse. If dictinary have not object with identifier <oData:ID>, Update() returns FALSE.
The structure description of metadata see in section CODB metadata
<::Error> contain error descriptions if araised.