| ppcstype1servertable | ||
|---|---|---|
 | Chapter 7. The PPCS Server for SBME Databases (PPSR) Component |  |
ppcstype1servertable
Description
A ppcstype1servertable object represents an table in an SBME database.
Type Tags
None
Object Value
Properties
| Property | Type | Description |
|---|---|---|
| _ | type(*) | This property is provided for use by the user to attach any object of any type to the type in which this property is provided. |
| __ | type(*) | This property is provided for use by the user to attach any object of any type to the type in which this property is provided. It has the additional feature of being marked with the resolve keyword, so that object resolution can continue down this property. |
| firstfield | ppcstype1serverfield | Specifies the object which represents the first field in the table. |
| hidden | boolean | Indicates whether the table is hidden when a PPCS client attempts to retrieve the list of available tables. By default, tables that are SBME shared are NOT hidden. |
| next | ppcstype1servertable | Gives the next ppcstype1servertable object for the same SBME file. |
| recordidfieldname | string |
Contains the name of the field that is being used to show the internal record
ID. If the record ID is not being shown, this field will be equal to
.nul. If this is not equal to
.nul then PPCS clients of the server will see a
TXT RDO IXU 12 (12 character length, text,
read-only, uniquely-indexed) field called whatever the
recordidfieldname property has been set to for
that table.
|
| sbme | ppcstype1serversbme | Specifies the SBME database file to which the table belongs. |
| shareable | boolean | Indicates whether the table can be accessed by PPCS clients, i.e. whether or not it is shared via PPCS. By default, tables in an SBME database file are NOT shareable. |
| sharename | string | Gives the table name which PPCS clients must use when accessing the table. By default, this is the same as the name recorded in the SBME database file. |
| tablename | string | Gives the name of the table as recorded in the SBME database file. |
| type | type | Specifies the ppcstype1servertable type object. |
Methods
getpassword()
Description
Gets the access rights associated with the specified password for that table.
The access mode string will not necessarily be the same as the access
string given in the setpassword() method,
but it will always return the same string for the same access rights
(e.g. if you specify 'LR' in the
setpassword() method, you will get
'rl' back from
getpassword(), but you will always get
'rl' for a password that gives only read and lock
rights.
Prototype
ppcstype1servertablevar.getpassword (
string password
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| password | None | string | The password for which the access rights are being queried. |
setpassword()
Description
Sets the access mode associated with a password for a table. If the empty password is not specifically set to something other than "" then it gives full access to a table which has no passwords set, and no access to a table which has at least one password set.
Prototype
ppcstype1servertablevar.setpassword (
string passwordaccess
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| password | None | string | The password to be associated with the set of access modes. |
| access | None | string |
An access mode of "" removes the password from the table.
Valid access strings are made up of any combination of
'r' (read), 'c' (create),
'l' (lock), 'w' (write),
'd' (delete) where 'w' and 'd' require that
'r' and 'l' are also included. The characters are not case
sensitive.
|
setrecordidfieldname()
Description
Call this function to both set the name to be used and to expose using that
name the internal record ID from the *.sbm file.
If this is not equal to .nul then PPCS clients
of the server will see a TXT RDO IXU 12 (12
character length, text, read-only, uniquely-indexed) field called
whatever the recordidfieldname parameter has been set
to for that table.
Prototype
ppcstype1servertablevar.setrecordidfieldname (
string recordidfieldname
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| recordidfieldname | None | string | The name to be used for exposing the internal read-only record ID. |
setshareability()
Description
Determines the sharing characteristics of a table.
Prototype
ppcstype1servertablevar.setshareability (
boolean shareablesharenamehidden
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| shareable | The current value of the shareable property | boolean | Determines whether or not the table can be accessed by PPCS clients, i.e. whether or not it is shared via PPCS. |
| sharename | The current value of the sharename property | string | Determines the name by which the table is accessed by PPCS clients. |
| hidden | The current value of the hidden property | boolean | Determines whether the table can be seen in table lists retrieved from the server by PPCS clients. |