Show TOC

ClassesLocate this document in the navigation structure

Class CL_GEF_FRW_MSG_LOG

Use

The framework uses this SAP application log to record error messages, which is also available to the application side. All messages are under log object GEF, as it is required to instantiate the logger.

Methods

ADD_MESSAGE

Used to add message to the message log. You can use transaction SLG1 and object GEF to view your message.

Parameter Description
I_MSGTY

Message type

Type SY-MSGTY
I_MSGID

Message class

Type SY-MSGID
I_MSGNO

Message number

Type SY-MSGNO
I_MSGV1

Message variable 1

Type SY-MSGV1
I_MSGV2

Message variable 2

Type SY-MSGV2
I_MSGV3

Message variable 3

Type SY-MSGV3
I_MSGV4

Message variable 4

Type SY-MSGV4
RS_MSG

Message structure

Type BAL_S_MSG
Class CL_GEF_API

Use

This API provides functionalities that might be helpful for the application side to geo enable business objects.

Methods

Method FIND_MATCHING_GEOS

This method is used to find matching geo objects for a given record of a business object by applying the filter conditions of the geo objects.

Parameter Description
IV_BO_ID

Business Object ID

Type GEF_BO_ID
IS_DATA

Business Object record

Type ANY
ET_GEO

Table of matching geo objects

Type CL_GEF_API=> GEFT_MATCHING_GEO

Method FIND_MATCHING_EDITABLE_GEO

This method is used to find a matching geo object that has an edit relevant business layer for a business object record. If more than one satisfying geo object exists, the one with most number of filter attributes, that is, the one with the most restrictions, will be returned.

Parameter Description
IV_BO_ID

Business Object ID

Type GEF_BO_ID
IS_DATA

Business Object record

Type ANY
ET_GEO

Matching geo object

Type CL_GEF_API=>GEFS_MATCHING_GEO

Method CHECK_IF_BO_HAS_GEOM

This method is used to check if a specified business object has any associated geometries.

Parameter Description
IV_BO_ID

Business Object ID

Type GEF_BO_ID
IV_OBJKEY

Business Object Key

Type GEF_BO_KEY
IV_GEOMETRY_TYPE

Geometry type (optional parameter)

Type GEF_GEOM_TYPE (1: Point; 2: Line; 3: Polygon)
IV_CONTEXT Geometry Context ID
IV_UTC_TIMESTAMP Time Stamp in Format YYYYMMDDHHMMSS (UTC). If provided, only geometries that are valid at a specified date are returned.
RV_GEOM_FLAG

Flag is returned to indicate if such a geometry exists or not

Type GEF_BOOLEAN

Method GET_GEOMETRIES_BY_BO_ID

This method is used to read all the geometries for a certain SAP object.

Parameter Description
IV_BO_ID

Business Object ID

Type GEF_BO_ID
IV_OBJKEY

Business Object Key

Type GEF_BO_KEY
IV_GEO_ID

Geo Object ID. If provided, use the database table defined in Customizing for the geo object type; if not specified, use the default database table from System Settings

Type GEF_GEO_ID
IV_UTC_TIMESTAMP Time Stamp in format YYYYMMDDHHMMSS (UTC). If provided, only geometries that are valid at a specified date are returned.
RT_GDB_GEOMETRY

Geometry table contains multiple GIS geometry entries

Type GEFT_GDB_GEOM

Method GET_GEOMETRY_BY_GEOMETRY_ID

This method is used to read the geometry for a given geometry ID (Object Identification Number for GIS Database Geometry).

Parameter Description
IV_GEOMETRY_ID

Object Identification Number for GIS Database Geometry

Type GEF_GDB_OBJECT_ID
IV_GEO_ID

Geo Object ID. If provided, use the database table defined in Customizing for the geo object type; if not specified, use the default database table from System Settings

Type GEF_GEO_ID

IV_UTC_TIMESTAMP Time Stamp in format YYYYMMDDHHMMSS (UTC). If provided, only the geometry that is valid at a specified date is returned.
RS_GDB_GEOMETRY

Geometry structure which contains all GIS related database information

Type GEFS_GDB_GEOM

Method ADD_GEOMETRY

This method is used to add a geometry to a given Object ID, Object Key, Context, Geometry Type, and Geometry in WKT format. If the geometry is successfully added, the RV_GEOMETRY_ID is returned; otherwise, exception CX_GEF_EXCEPTION is raised. Since the geometry structure is required, and is an addition, the following attributes are required in the importing structure IS_GEOMETRY:

Attribute

Description

GEF_OBJTYPE

Business Object ID

GEF_OBJKEY

Business Object Key used in HANA DB

GEF_CONTEXT

Geometry Context ID

GEF_GEOM_TYPE

Geometry Type (1: Point; 2: Line; 3: Polygon)

GEF_GEOM_WKT
Geometry in WKT format, the value must be in one of the following formats:

  1. Point (POINT): (14581255.73486 -1462532.29834)

  2. Line (LINESTRING): (13345496.9475 -1652199.89325,13731962.5625 -2038665.50824,13768652.33606 -1598388.22534,13311253.1588 -1652199.89325,14739708.3434 -2425131.1233)

  3. Polygon (POLYGON): ((16029685.424 -3877947.8201,15966089.81647 -3904853.65405,15973427.7712 -3941543.4277,16071267.1674 -3961111.3069,16081051.10706 -3890177.7446,16029685.424 -3877947.8201))
Note

The following attributes are optional: GEF_DATE_FROM, GEF_DATE_TO, and GEF_GEOM_SRID.

If the attribute GEF_DATE_FROM or GEF_DATE_TO is provided, it is a Time Stamp in the format YYYYMMDDHHMMSS (UTC).

Parameter Description
IS_GEOMETRY

Geometry structure which contains all GIS related database information

Type GEFS_GDB_GEOM
IV_GEO_ID

Geo Object ID. If provided, use the database table defined in Customization for the geo object type; if not specified, use the default database table from System Settings

Type GEF_GEO_ID

RV_GEOMETRY_ID

Object Identification Number for GIS Database Geometry

Type GEF_GDB_OBJECT_ID

Method UPDATE_GEOMETRY

This method is used to update a geometry for a given geometry ID. If the geometry is successfully updated, the RV_SUCCESS is set to true (X); otherwise, exception CX_GEF_EXCEPTION is raised. Since the geometry structure is required, and is an update, the following attributes are required in the importing structure IS_GEOMETRY:

GEF_OBJECTID Object Identification Number for GIS Database Geometry (geometry ID)

Note If the attribute GEF_GEOM_WKT is provided, the value must be the same format as mentioned above.
Parameter Description
IS_GEOMETRY

Geometry structure which contains all GIS related database information

Type GEFS_GDB_GEOM
IV_GEO_ID

Geo Object ID. If provided, use the database table defined in Customization for the geo object type; if not specified, use the default database table from System Settings

Type GEF_GEO_ID

RV_SUCCESS

RV_SUCCESS is returned as true to indicate if such a geometry is updated successfully

Type GEF_BOOLEAN

Method DELETE_GEOMETRY

This method is used to delete the geometry for a given geometry ID. If the geometry is successfully deleted, the RV_SUCCESS is set to true (X); otherwise, exception CX_GEF_EXCEPTION is raised.

Parameter Description
IV_GEOMETRY_ID

Object Identification Number for GIS Database Geometry

Type GEF_GDB_OBJECT_ID
IV_GEO_ID

Geo Object ID. If provided, use the database table defined in Customization for the geo object type; if not specified, use the default database table from System Settings

Type GEF_GEO_ID

RV_SUCCESS

RV_SUCCESS is returned as true to indicate if such a geometry is deleted successfully

Type GEF_BOOLEAN

Method GET_EXTENSION_ID

This method is used to get the Extension ID of a given Business Object ID.

Parameter Description
IV_BO_ID

Business Object ID

Type GEF_BO_ID
IV_GEO_ID

Application Extension ID

Type GEF_EXTENSION_ID