Interfaces

This interface is responsible for analyzing service requests, which are specific to each individual map provider and is also responsible for providing request contexts in the framework’s internal format.

The interface implements a collection of interfaces:

• IF_GEF_REQ_CATALOG
• IF_GEF_REQ_DISPATCH
• IF_GEF_REQ_EDIT
• IF_GEF_REQ_METADATA
• IF_GEF_REQ_QUERY
• IF_GEF_REQ_QUERY_BO

An instance of IF_GEF_INBOUND_MAP_SERVICE will be created for each request and the framework will keep the instance. A proper base interface will be consumed by the framework and by applications during different stages of the execution.

Method GET_REQ_OPERATION

Used to get the operation of the current request. A request asks for certain operations such as catalog, service metadata, layer metadata, query, applyEdits, and so on.

Method GET_BL_ID

Used to get the business layer ID of the current request.

Method SET_CREATE_DATA

Used to set the create data to the implementation class of the interface.

Method SET_UPDATE_DATA

Used to set the update data to the implementation class of the interface.

Method SET_DELETE_DATA

Used to set the delete data to the implementation class of the interface.

Method GET_BUFFER_INSTANCE_ID

Used to get the buffer instance ID.

Method GET_EXTENSION_ID

Used to get the Extension ID of the application.

Method GET_BO_ID

Used to get the Business Object ID.

Method GET_GEO_ID

Used to get the Geo ID.

This interface is used to provide the request context of an enterprise search and is used by the application side.

Method GET_MSG_LOG

Used to get the instance of SAP application log object of type GEF.

Method GET_FREE_SEARCH_TEXT

Used to get the keyword for enterprise search.

Method GET_CONNECTOR_ID

Used to get the geo object specific, enterprise search connector ID from the geo object Customizing activity.

Method GET_REQUEST_ID

Used to get the geo object specific, enterprise search request type ID from the geo object Customizing activity.

Method GET_START_INDEX

Used to get the start index of each run of enterprise search. An enterprise search request might take several runs of execution depending on the geo object Customizing activity.

Method GET_NUMBER_OF_RESULTS

Used to get the number of records returned for an enterprise search from geo object Customizing activity. If it is not maintained on the geo object level, the value on the system level Customizing activity will be used.

Method GET_GEO_ID

Used to get geo object ID for the current request.

Method GET_GEO_FILTERS

Used to get the filter values for the current request. The application side should take the opportunity to apply the filter to improve performance. The framework will enforce the validation only for data accuracy.

This interface provides the request context of a regular query (non-enterprise search query) to the application side.

Method GET_GL_KEY

Used to get the geometry layer key of the current request.

Method GET_GDB_OBJECTS

Used to get the geometry objects returned from the SAP HANA GIS database.

Method GET_GEO_FILTERS

Used to get the filter values for the current request. The application side should take the opportunity to apply the filter mostly for performance reasons. The framework will enforce the validation only for data accuracy reasons.

Method GET_GBO_STRUCT_DESCR

Used to get the descriptor of the combined structure that consists of both geometry attributes and business attributes from the Customizing of the geo object. The application side needs to enrich the geometry objects with business data and fill this structure.

Method GET_GBO_TAB_DESCR

Used to get the table descriptor of the combined structure that consists of both geometry attributes and business attributes from the Customizing of the geo object. The application will return the framework of a data reference to such a table.

Method GET_MSG_LOG

Used to get the instance of SAP application log object (of type GEF).

Method GET_DYN_FILTER

Returns the filter in an internal table or SQL Where clause, based on filter type. The supported types are BO filter, Geometry filter, or a combination of both.

Method GET_BUFFER_INSTANCE_ID

Used to get the buffer instance ID.

Method GET_EXTENSION_ID

Used to get the Extension ID.

This interface has its own set of methods. In addition, it also implements interfaces IF_GEF_REQ_QUERY_BO and IF_GEF_REQ_ES_BO. It is used by the framework itself. When the framework needs to provide request contexts to applications, this interface is cast to its base interfaces and passed to the application side.

For the methods of interfaces IF_GEF_REQ_QUERY_BO and IF_GEF_REQ_ES_BO, refer to their respective sections.

Method GET_GDB_PARAMETERS

Used to get the list of parameters relevant to the SAP HANA GIS database.

Method GET_GL_KEY

Used to get the geometry layer key of the current request.

Method GET_BL_ID

Used to get the business layer ID of the current request.

Method GET_BO_ID

Used to get the business object ID of the current request.

Method GET_GEO_ID

Used to get the geo object ID of the current request.

Method GET_GEO_CONTEXT_ID

Used to get the geometry context ID of the current request.

Method GET_GDB_SRID

Used to get the SRID of the SAP HANA GIS database table for the business object of the current request.

Method GET_REQUESTED_SRID

Used to get the SRID of the current request.

Method GET_GL_GEOMETRY_TYPE

Used to get the geometry type of the current request.

Method GET_REQ_GDB_STRUCT

Used to get the structure descriptor and the ABAP components of the SAP HANA GIS database table for the business object of the current request.

Method GET_REQ_BL_STRUCT

Used to get the structure descriptor and the ABAP components of the business layer of the current request.

Method GET_REQ_COMBINED_STRUCT

Used to get the descriptor and the ABAP components of the combined structure of both geometry data and business data of the current request.

Method GET_MAX_RECORD_COUNT

Used to get the maximum number of records for the geo object of the current request.

Method GET_PROPERTY

Used to get the property of the implementation class of the interface. As the attributes of an interface have to be public, which is not always desirable, the interface itself doesn't declare any attributes.

Method SET_PROPERTY

Used to get property.

Method SET_GDB_OBJECTS

Used to set geometry objects retrieved from the SAP HANA GIS database to the interface.

Method GET_MSG_LOG

Used to get the instance of SAP application logger of object type GEF.

Method GET_GEO_FILTERS

Used to get filter values from the Customizing for the geo object of the current request.

Method GET_GEO_SCENARIO_ID

Used to get the scenario ID from the Customizing for the geo object of the current request. A scenario ID indicates how the geometry data and business data are set up in the backend system.

Method GET_RETURN_GEOMETRY_FLAG

Used to get the flag indicating where geometry is required for the current request.

Method IS_CROSS_GEOMETRY_TYPE_SEARCH

Used to get the flag indicating where the current request is a cross geometry type search. A cross geometry type search is one where multiple geometry types are required, if they exist. It isn't consumed by map layers.

Method GET_GBO_OBJECTS

Used to get the list of objects, each of which consists of both geometry data and business data for the current request.

Method SET_GBO_OBJECTS

Used to set the list of objects, each of which consists of both geometry data and business data for the current request to be consumed later during the execution.

Method GET_RESPONSE_FORMAT

Used to get the requested response format.

This interface is used by the framework to get the contexts of a metadata request.

Method GET_BL_ID

Used to get the business layer ID of the current request.

Method GET_GL_KEY

Used to get the geometry layer key of the current request.

Method GET_SERVICE_TYPE

Used to get the service type of the current request. A GIS-specific implementation can choose to support feature service, map service, catalog service, and so on.

Method GET_SERVICE_HOST

Used to get the service host of the current request.

Method GET_SERVICE_SCHEME

Used to get the service scheme of the current request.

Method GET_MSG_LOG

Used to get the instance of SAP application logger of object type GEF.

This interface is used by the framework and the application to get the contexts of the current apply edit, create, delete, and update requests.

Method GET_CREATE_DATA

Used to get the create data of the current request.

Method GET_UPDATE_DATA

Used to get the update data of the current request.

Method GET_DELETE_DATA

Used to get the delete data of the current request.

Method GET_GEO_ID

Used to get geo object ID of the current request.

Method GET_MSG_LOG

Used to get the instance of SAP application logger of object type GEF.

Method GET_BUFFER_INSTANCE_ID

Used to get the buffer instance ID.

Method GET_EXTENSION_ID

Used to get the Extension ID.

This interface is used by the framework to get the contexts required for dispatching.

Method GET_REQ_OPERATION

Used to get the geo object ID [CP3] of the current request.

Method GET_MSG_LOG

Used to get the instance of SAP application logger of object type GEF.

This interface is used by the framework to get the contexts of the current request.

Method GET_MSG_LOG

Used to get the instance of SAP application logger of object type GEF.

This interface is used by the framework to get the GIS specific response.

Method GET_RESP_SERVICE_METADATA

Used by the framework to get the response of a service metadata request.

Method GET_RESP_LAYER_METADATA

Used by the framework to get the response of a layer metadata request.

Method GET_RESP_QUERY

Used by the framework to get the response of a query request.

Method GET_RESP_CREATE_GEOMETRY

Used by the framework to get the response of a create request.

Method GET_RESP_UPDATE_GEOMETRY

Used by the framework to get the response of an update request.

Method GET_RESP_DELETE_GEOMETRY

Used by the framework to get the response of a delete request.

Method GET_RESP_EDIT_GEOMETRY

Used by the framework to get the response of an applyEdits request. An applyEdits operation adds, updates, and deletes features of the associated feature layer.

Method GET_RESP_SERVICE_CATALOG

Used by the framework to get the response of a catalog request.