Show TOC

Interface IF_GEF_BUFFER_SERVICELocate this document in the navigation structure

IF_GEF_BUFFER_SERVICE is the interface for the framework's global buffering service. This interface allows the application to maintain and query geometries in the global buffer. It can be easily used to:

  • Query geometries from the DB (Changes incorporated and displayed in the buffer)
  • Save changes into the DB
  • Reset the buffer
  • Get all entries from the buffer
  • Get geometries from the DB by the Business Object ID (Changes incorporated in the buffer)

SAP has delivered CL_GEF_SHM_BUFFER_SERVICE as the default implementation class of the interface IF_GEF_BUFFER_SERVICE, and as the standard for the framework's global buffering service. The application side can use the standard implementation directly, or inherit their own application specific, implementation classes from CL_GEF_SHM_BUFFER_SERVICE.

Methods

Method CREATE_GEOMETRIES

This method is used to create new geometries in the global buffer.

Parameter Description
IT_FEATURE_ADD

Import geometry list that is to be added

Type GEFT_FEATURE_OBJECT

IV_GEO_ID

Geo Object ID

Type GEF_GEO_ID

ET_FEATURE_ADD

Export the added geometry list with new Object IDs in the buffer

Type GEFT_FEATURE_OBJECT

Method UPDATE_GEOMETRIES

This method is used to update existing geometries. The updated objects are stored in the global buffer.

Parameter Description
IT_FEATURE_UPDATE

Import geometry list that is to be updated

Type GEFT_FEATURE_OBJECT

IV_GEO_ID

Geo Object ID

Type GEF_GEO_ID

ET_FEATURE_UPDATE

Export the updated geometry list in the buffer

Type GEFT_FEATURE_OBJECT

Method DELETE_GEOMETRIES

This method is used to delete existing geometries. The deleted objects are flagged as deleted in the global buffer.

Parameter Description
IT_FEATURE_DELETE

Import the geometry list that is to be deleted

Type GEFT_FEATURE_OBJECT

IV_GEO_ID

Geo Object ID

Type GEF_GEO_ID

ET_FEATURE_DELETE

Export the deleted geometry list from the buffer

Type GEFT_FEATURE_OBJECT

Method QUERY

This method is used to query geometries from both the database and the global buffer. The changes in the global buffer will be merged into the query results.

Parameter Description
IO_REQ_CONTEXT

Request Context for Query

Type Ref to IF_GEF_REQ_QUERY

ET_GBO_OBJECTS

Query Results List

Type DATA

Method SAVE

This method is used to save the changes in the global buffer to the database.

Parameter Description
IV_NEW_PERSISTENT_OBJKEY

The ID for the newly created business object (Optional).

Type GEF_OBJKEY

IV_TEMP_OBJKEY_TO_REPLACE

The temporary ID for the newly created business object. It will be replaced by the persistent ID IV_NEW_PERSISTENT_OBJKEY when saving . (Optional).

Type GEF_OBJKEY

IV_COMMIT

Commit flag. The default value is false. (Optional)

Type BOOLEAN

ET_FEATURE_RETURN

Structure is returned with an error message, if it exists.

Type GEFT_FEATURE_OBJECT

Method RESET

This method is used to reset the buffer.

Method GET_BUFFER

This method returns all buffered geometries. For each buffered object that is returned, the field <UPD_TYPE> indicates the geometry's status with the following:

  • initial: Unchanged
  • I: Insert
  • D: Delete
  • U: Update
Parameter Description
ET_BUFFER

The table for the buffered geometries.

Type GEFT_GEO_BUFFER

Method GET_GEOMETRIES_BY_BO_ID

This method is used to query geometries using the Business Object key, from both the database and the global buffer. The changes in the global buffer will be merged into the query results.

Parameter Description
IV_BO_ID

Business Object ID.

Type GEF_BO_ID

IV_OBJKEY

Business Object key

Type GEF_OBJKEY

IV_CONTEXT

Geometry Context ID (Optional)

Type GEF_GEO_CONTEXT_ID

IV_GEO_ID

Geo Object ID (Optional)

Type GEF_GEO_ID

IV_UTC_TIMESTAMP

UTC Time Stamp (Optional)

Type GEF_DATETIME

ET_FEATURE_RETURN

Structure is returned with an error message, if it exists.

Type GEFT_FEATURE_OBJECT