Difference between revisions of "CursorAdapter"
From Lianjapedia
Helen.george (Talk | contribs) |
Helen.george (Talk | contribs) |
||
| Line 5: | Line 5: | ||
This class supports the [[:Category:Common_Properties|Common Properties]] plus the following: | This class supports the [[:Category:Common_Properties|Common Properties]] plus the following: | ||
| − | {| class="wikitable" width=100% | + | {| class="wikitable" width="100%" |
!width="20%"|Property | !width="20%"|Property | ||
!Access (R/RW) | !Access (R/RW) | ||
| Line 197: | Line 197: | ||
This class supports the [[:Category:Common_Methods|Common Methods]] plus the following: | This class supports the [[:Category:Common_Methods|Common Methods]] plus the following: | ||
| − | {| class="wikitable" width=100% | + | {| class="wikitable" width="100%" |
!width="20%"|Method | !width="20%"|Method | ||
!Args | !Args | ||
!width="50%"|Description | !width="50%"|Description | ||
|- | |- | ||
| − | |valign=top|CursorFill | + | |valign="top"|CursorFill |
| − | |valign=top|None | + | |valign="top"|None |
| − | |valign=top|Fill the cursor based on Select Cmd | + | |valign="top"|Fill the cursor based on Select Cmd |
|- | |- | ||
| − | |valign=top|CursorRefresh | + | |valign="top"|CursorRefresh |
| − | |valign=top|None | + | |valign="top"|None |
| − | |valign=top|Refresh the cursor based on Select Cmd | + | |valign="top"|Refresh the cursor based on Select Cmd |
|- | |- | ||
|Open | |Open | ||
| Line 218: | Line 218: | ||
|Close the DataSource | |Close the DataSource | ||
|- | |- | ||
| − | |valign= | + | |valign="top2|Exec |
|command as Character | |command as Character | ||
| − | |valign=top|Execute the specified command | + | |valign="top"|Execute the specified command |
|- | |- | ||
|Transaction | |Transaction | ||
| Line 244: | Line 244: | ||
This class supports the [[:Category:Common_Events|Common Events]] plus the following: | This class supports the [[:Category:Common_Events|Common Events]] plus the following: | ||
| − | {| class="wikitable" width=100% | + | {| class="wikitable" width="100%" |
!width="20%"|Event | !width="20%"|Event | ||
!Args | !Args | ||
Revision as of 11:24, 5 February 2013
Note: property, method and event names should be referred to in lowercase in case-sensitive scripting languages.
Properties
This class supports the Common Properties plus the following:
| Property | Access (R/RW) | Value | Description |
|---|---|---|---|
| DataSourceType | RW | Character | Type of the DataSource: "" (native) or "ODBC" |
| DataSource | RW | Character | Source of data |
| DataSourceUsername | RW | Character | Username for DataSource |
| DataSourcePassword | RW | Character | Password for DataSource |
| DataSourceOptions | RW | Character | Options string for DataSource |
| DataSourceHost | RW | Character | Hostname or IP for DataSource |
| DataSourcePort | RW | Numeric | Port number for DataSource |
| Alias | RW | Character | Alias name |
| SelectCmd | RW | Character | Select command string |
| DeleteCmd | RW | Character | Delete command string |
| UpdateCmd | RW | Character | Update command string |
| InsertCmd | RW | Character | Insert command string |
| Database | RW | Character | Database name |
| Table | RW | Character | Table name |
| Tables | RW | Character | Comma-separated list of table names |
| KeyFieldList | RW | Character | Comma-separated list of primary fields |
| UpdatableFieldList | RW | Character | Comma-separated list of fields |
| UpdateNameList | RW | Character | Comma-separated list of pairs of local and remote field names |
| AllowInsert | RW | Boolean | Whether insert operations are allowed |
| AllowDelete | RW | Boolean | Whether delete operations are allowed |
| AllowUpdate | RW | Boolean | Whether update operations are allowed |
| AllowSimultaneousFetch | RW | Boolean | Whether simultaneous fetch operations are allowed |
| BatchUpdateCount | RW | Numeric | Number of update statements sent |
| BreakOnError | RW | Boolean | Whether errors break program execution |
| FetchAsNeeded | RW | Boolean | Whether records are fetched as needed |
| FetchSize | RW | Numeric | Number of rows fetched |
| MaxRecords | RW | Numeric | Maximum number of rows returned |
| Flags | RW | Numeric | Flag settings |
| WhereType | RW | Numeric | Type of fields used for where clauses: 1 = KeyFieldList, 2 = KeyFieldList and updatable fields, 3 = KeyFieldList and modified fields, 4 = KeyFieldList and comparison of time stamps |
| UpdateType | RW | Numeric | Type of update: 1 = update old data with new data, 2 = delete old data and insert new data |
| UseMemoSize | RW | Numeric | Minimum size in bytes for returning a value as a memo field |
| CompareMemo | RW | Boolean | Whether memos are included in where update clauses |
| SendUpdates | RW | Boolean | Whether to send an update query |
| Prepared | RW | Boolean | Whether to prepare SQL statements for subsequent requery |
| ConversionFunc | RW | Character | Comma-separated list of field and function name pairs |
| CursorSchema | RW | Character | Structure of the cursor |
Methods
This class supports the Common Methods plus the following:
| Method | Args | Description |
|---|---|---|
| CursorFill | None | Fill the cursor based on Select Cmd |
| CursorRefresh | None | Refresh the cursor based on Select Cmd |
| Open | None | Open the DataSource |
| Close | None | Close the DataSource |
| Exec | command as Character | Execute the specified command |
| Transaction | None | Begin transaction |
| Commit | None | Commit transaction data changes |
| Rollback | None | Rollback transaction data changes |
| Cancel | None | Cancel transaction |
Events
This class supports the Common Events plus the following:
| Event | Args | Description |
|---|---|---|
| afterCursorAttach | alias as Character | Occurs after cursoradapter is open |
| afterCursorClose | alias as Character | Occurs after cursoradapter is closed and after afterCursorDetach |
| afterCursorDetach | alias as Character | Occurs after cursoradapter is closed |
| afterCursorFill | cursorSchema as Character | Occurs after cursor is filled |
| afterCursorOpen | alias as Character | Occurs after cursoradapter is open and afterCursorAttach |
| afterCursorRefresh | alias as Character, refreshed as Boolean | Occurs after cursor is refreshed |
| afterCursorUpdate | rows as Numeric, result as Boolean, error as Character | Occurs after cursor is updated |
| afterDelete | fieldstate as Character, force as Boolean, deleteCmd as Character, deleted as Boolean | Occurs after delete operation is performed |
| afterInsert | fieldstate as Character, force as Boolean, insertCmd as Character, inserted as Boolean | Occurs after insert operation is performed |
| afterUpdate | fieldstate as Character, force as Boolean, insertCmd as Character, inserted as Boolean | Occurs after update operation is performed |
| beforeCursorAttach | alias as Character | Occurs before cursor is open and after beforeCursorOpen |
| beforeCursorClose | alias as Character | Occurs when close method is called |
| beforeCursorDetach | alias as Character | Occurs before cursoradapter is closed and after beforeCursorClose |
| beforeCursorFill | cursorSchema as Character, noDataOnLoad as Boolean, selectCmd as Character | Occurs before when cursorFill method is called |
| beforeCursorOpen | alias as Character | Occurs when open method is called |
| beforeCursorRefresh | alias as Character | Occurs when cursorRefresh method is called |
| beforeCursorUpdate | rows as Numeric, force as Boolean | Occurs before cursor is updated |
| beforeDelete | fieldstate as Character, force as Boolean, deleteCmd as Character | Occurs before delete operation is performed |
| beforeInsert | fieldstate as Character, force as Boolean, deleteCmd as Character | Occurs before insert operation is performed |
| beforeUpdate | fieldstate as Character, force as Boolean, deleteCmd as Character | Occurs before update operation is performed |
