OpenEdge Development: Mobile Applications - Product ...

Chapter 1: OpenEdge Mobile Overview
In Figure 3, a singleton Customers class object provides ABL methods to implement
the operations of the Customers Mobile resource. The figure shows all the operations
that are available for a Mobile resource. The standard, built-in Mobile operations are
create, read, update, and delete (the familiar CRUD operations) and you can use
Developer Studio to annotate ABL routines of the corresponding Mobile interface that
implement them. For each built-in Mobile CRUD operation, you annotate only one ABL
routine as the implementation, in this case an ABL method. All the ABL routines that
implement the built-in Mobile operations must support exactly the same schema in the
form of a single temp-table or ProDataSet parameter. In addition, the read operation
implementation must provide an initial CHARACTER input parameter named filter (see
Table 1). For non-built-in invoke operations, you can annotate any number of ABL
routines using any supported ABL signature. (For more information on the supported
ABL data types, see Appendix A, “ABL to JavaScript Data Type Mapping.”) However,
the ABL routines you annotate as invoke operations cannot already be annotated to
implement built-in CRUD operations.
Table 1 shows the required parameter lists for ABL routines (class methods, internal
procedures, or user-defined functions) that implement the built-in Mobile CRUD
operations.
Table 1: Required ABL parameters for built-in Mobile operations
Built-in
operation Required parameter list for the implementing ABL routine 1
create INPUT-OUTPUT { TABLE table-name | DATASET dataset-name
| TABLE-HANDLE table-hdl | DATASET-HANDLE dataset-hdl } 2
read INPUT filter3 AS CHARACTER ,
OUTPUT { TABLE table-name | DATASET dataset-name
| TABLE-HANDLE table-hdl | DATASET-HANDLE dataset-hdl } 2
update INPUT-OUTPUT { TABLE table-name | DATASET dataset-name
| TABLE-HANDLE table-hdl | DATASET-HANDLE dataset-hdl } 2
delete INPUT-OUTPUT { TABLE table-name | DATASET dataset-name
| TABLE-HANDLE table-hdl | DATASET-HANDLE dataset-hdl } 2
1. If the implementing ABL routine is a class method, its return type must be VOID. The return value of any
ABL routine is ignored.
2. Because all the built-in operations of a Mobile resource must support the same schema, their
implementations all must share either a TABLE, TABLE-HANDLE, DATASET, or DATASET-HANDLE
parameter with exactly the same temp-table or ProDataSet schema. NOTE: The schema for any
ProDataSet (DATASET or DATASET-HANDLE) parameter can have no data-relations defined with the
NESTED option.
3. The filter parameter is passed as a query string that is intended to filter the records returned for the
temp-table or ProDataSet parameter of a read operation. Your ABL routine can use this value for any
purpose, or ignore the parameter entirely. Note that to allow the prescribed mapping to work between the
ABL routine for the built-in read operation and the JavaScript method that calls it, you must name this
parameter filter in the signature of the ABL routine.
For information on coding and annotating these ABL routines, see Chapter 3, “Creating
Mobile Services.”
38 OpenEdge ® Development: Mobile Applications