LC Classes

The Connectors provides external data and system access to the LotusScript® environment. The LSX classes consist of LCConnection, LCFieldlist and LCField, and four advanced data types, LCStream, LCNumeric, LCCurrency, and LCDatetime. In addition to these seven classes, there is also an LCSession class. Each of these classes and their primary usage is described as follows.

LCSession

The LCSession class provides error information useful in error handlers. It also provides for query and lookup of available Connectors.

Note: The LCSession class has additional capabilities for HCL Enterprise Integrator (HEI) users. For example, using LCSession enables you to create a new session. These additional capabilities are described in Appendix E, "Additional Scripting Capability for HEI."

LCConnection

The LCConnection class represents an instance of a Connector. This class provides query and data access to the external system. Multiple connections may be allocated to a single connector.

LCFieldlist

The LCFieldlist class is the primary class for manipulating data through a connection. It binds a group of fields together with names and an implied order.

Fieldlists are used primarily for a number of connection operations; result sets and selection criteria, as well as reading and writing data.

When a result set is generated, and an empty fieldlist was initially passed in, the fieldlist is automatically populated by the connector. For each data element of the result set, the fieldlist receives the element's name and a field object of the corresponding data type. The result set may be controlled by manually building the fieldlist before the result set is constructed or by using the FieldNames property of the connection.

The Select and Call connection methods use an optional fieldlist of keys or parameters to restrict the result set. This fieldlist is manually constructed and passed to the select method. A key or parameter list is constructed by appending or inserting names and data types to the list. These methods create fields in the fieldlist and return these fields for further manipulation. These fields are then given values and, using field flags, may be given conditions such as greater-than, not-equal, and so on.

By specifying a number of rows in the New method, you make it possible for the field list to contain multiple rows of data. This lets you fetch or write several rows simultaneously. Some connectors are capable of "array" read and write operations; using a multirow fieldlist lets you take advantage of this capability to improve performance by minimizing network traffic. If the connector does not allow array operations, you can still read and write multiple rows but doing so will not improve performance.

LCField

LCField is the storage class that contains one or more data values. The data type of a field is for all values contained within and may be any of the four advanced data types below. Other advanced data types include long integer, double precision floating point, fieldlist, and connection.

LCStream

LCStream is a general-purpose text and binary data type. The contents of a stream are marked with a format that details the character set of the text or any special attributes of the binary data.

LCNumeric

The LCNumeric class is a container for very high precision numbers.

LCCurrency

The LCCurrency class is a fixed point decimal data type with 4 decimal places and 19 digits of precision. (This is mathematically equivalent to the LotusScript® data type and is provided to support connections with a dedicated currency.)

LCDatetime

The LCDatetime class is a date and time data type which is accurate to the hundredth of a second and which is aware of time zones and daylight savings time.