Show TOC

/IWBEP/IF_MGW_ODATA_PROPERTYLocate this document in the navigation structure

Use

This is an interface which represents and OData Channel property object.

Methods

Method SET_TYPE_EDM_BINARY

This method sets the EDM core type of a property.

Method SET_TYPE_EDM_BYTE

This method sets the EDM core type of a property.

Method SET_TYPE_EDM_DATETIME

This method sets the EDM core type of a property.

Method SET_TYPE_EDM_DATETIMEOFFSET

This method sets the EDM core type of a property.

Method SET_TYPE_EDM_DECIMAL

This method sets the EDM core type of a property.

Method SET_TYPE_EDM_DOUBLE

This method sets the EDM core type of a property.

Method SET_TYPE_EDM_FLOAT

This method sets the EDM core type of a property.

Method SET_TYPE_EDM_SINGLE

This method sets the EDM Core type of property to SINGLE. The type EDM.Single is handled in the same way as the type EDM.Float at runtime.

Example:

<EntityType sap:content-version="*1*">
<Key>
<PropertyRef />
<PropertyRef />
</Key>
<Property Type="*Edm.String*" Nullable="*false*" MaxLength="*4*" />
...
<Property Type="*Edm.Single*" /> 

Method SET_TYPE_EDM_GUID

This method sets the EDM core type of a property.

Method Method SET_TYPE_EDM_INT16

This method sets the EDM core type of a property.

Method SET_TYPE_EDM_INT32

This method sets the EDM core type of a property.

Method SET_TYPE_EDM_INT64

This method sets the EDM core type of a property.

Method SET_TYPE_EDM_SBYTE

This method sets the EDM core type of a property.

Method SET_TYPE_EDM_STRING

This method sets the EDM core type of a property.

Method SET_TYPE_EDM_TIME

This method sets the EDM core type of a property.

Method SET_FIELD_CONTROL

This method sets the property that contains the field control, it creates the annotation sap:field-code=“SomeOtherProperty“.

Method SET_PRECISION

This method sets the precision of a property. Note that this is only applicable for certain EDM core types.

Parameter

Description

IV_PRECISION

Precision of the property.

Method SET_MAXLENGTH

This method sets the maximal length of a property, for example for an EDM.string. Note that this is only applicable for certain EDM core types.

Parameter

Description

IV_MAX_LENGTH

Maximum length of the property.

Method SET_CONVERSION_EXIT

This method sets the name of conversion exit (for example, ALPHA) to be executed for the property in in-/outbound flow.

If a conversion exit (for example, ALPHA) has been set, the corresponding functions (for example, CONVERSION_EXIT_ALPHA_INPUT and CONVERSION_EXIT_ALPHA_OUTPUT) are executed by the framework automatically during inbound and outbound flow.

Parameter

Description

IV_CONV_EXIT

Name of the conversion exit.

/IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_CONV_EXIT

Method SET_NULLABLE

This method sets the Nullable attribute for a property in the service metadata document, for example, Nullable=true or Nullable=false.

Parameter

Description

IV_NULLABLE

Value of the property.

Method SET_CREATABLE

This method sets the value of sap:creatable of the property. The default value is true and therefore not shown in service metadata document.

Parameter

Description

IV_CREATABLE

Value of the property.

Method SET_UPDATABLE

This method sets the value of sap:updatable of the property. The default value is true and therefore not shown in service metadata document.

Parameter

Description

IV_UPDATABLE

Value of the property.

Method SET_FILTERABLE

This method sets the value of sap:filterable of the property. The default value is true and therefore not shown in service metadata document.

Parameter

Description

IV_FILTERABLE

Value of the property.

Method SET_SORTABLE

This method sets the value of sap:sortable of the property. The default value is true and therefore not shown in service metadata document.

Parameter

Description

IV_SORTABLE

Value of the property.

Method SET_IS_KEY

This method sets the property as key of the enclosing entity type.

Parameter

Description

IV_KEY

Value of the property.

Method SET_SEMANTIC

This method sets the semantics for the property. Supported values are the components of the structure /IWBEP/CL_MGW_ABS_MODEL=>GCS_SAP_SEMANTIC, in particular the following:

  • CL_MGW_ABS_MODEL=>GCS_SAP_SEMANTIC-CURRENCY_CODE

    Currency code. If set, conversion between SAP internal code (for example, DEM3) and external (ISO) one (for example, DEM) is performed automatically by the framework for inbound and outbound flow.

  • CL_MGW_ABS_MODEL=>GCS_SAP_SEMANTIC-UNIT_OF_MEASURE

    Unit of measurement. If set, conversion between SAP internal code (for example, KG) and external (ISO) one (for example, KGM) is performed automatically by the framework for inbound and outbound flow.

Parameter

Description

IV_SEMANTIC

Semantics.

/IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_SEMANTIC

Method SET_INTERNAL_TYPE

This method sets the internal (ABAP) type of a property. This information is usually derived from the underlying ABAP Dictionary binding. Note that this method should only be used in exceptional cases.

Parameter

Description

IV_TYPE

Type based on the ABAP type system of the property.

Method SET_INTERNAL_LENGTH

This method sets the internal (ABAP) length of a property. Note that this method should only be used in exceptional cases.

This information is usually derived from the underlying ABAP Dictionary binding. The method is purely a setter method and does not do any calculation. This has to be done up-front and all circumstances, for example Unicode or non-Unicode have to be taken into account.

Parameter

Description

IV_INTERNAL_LENGTH

Internal ABAP length of property.

Method SET_TEXT_KEY

This method sets the source of a text label, for example, a text element or ABAP Dictionary label.

The method thus creates a description for a field that differs from those of the ABAP Dictionary. A source of this text can be a text symbol of a class. The semantics of the input parameter must be the CLASS NAME and the symbol Id of the text element separated by -. The corresponding text object key is defined in class /IWBEP/CL_MGW_ABS_MODEL.

Parameter

Description

IV_TEXT_KEY

Text key in the class name and the text element separated by -.

Example: /IWFBEP/CL_MGW_MED_POOL_TX_LOAD-000

IV_TEXT_OBJECT_TYPE

Text object type defined in the field mentioned above.

Example: GCS_SAP_TEXT_OBJECT_TYPES-BACKEND_GATEWAY_TEXT

IV_CREATE

In the text the key will be created if not available. This parameter must always be set to ABAP_TRUE.

Method BIND_DATA_ELEMENT

This method binds a property to given data element.

If a data element has been bound to a property, type (ABAP and EDM core) and label information are retrieved from the ABAP Dictionary.

Parameter

Description

IV_ELEMENT_NAME

Name of the data element in the ABAP Dictionary.

Method BIND_DATA_ELEMENT_FOR_TEXT

Entity types bound to ABAP Dictionary structures might want to exchange bindings of single properties to data elements. For this method BIND_DATA_ELEMENT_FOR_TEXT of interface /IWBEP/IF_MGW_ODATA_PROPERTY is provided. With this method you can overwrite the text source for a property, that is, it binds a property to given data element for text. This method declares the given data element from the ABAP Dictionary as text source for this property.

Parameter

Description

IV_ELEMENT_NAME

Name of the data element in the ABAP Dictionary.

Method SET_UNIT

This method is obsolete. Use method SET_UNIT_PROPERTY instead.

Method SET_UNIT_PROPERTY

This method declares another property as measurement unit for the current one.

If the property set as unit for the current one has currency semantic (/cl_mgw_abs_model=>gcs_sap_semantic-currency_code) the current property is considered to be a currency amount property. This causes currency amount conversion to be executed automatically by the framework during inbound and outbound flow. This is normally required for every currency amount field since the internal (DB) representation may be differ from the external (real) one, for example 10.000 JPY are stored internally as 100.00.

Parameter

Description

IV_UNIT_PROPERTY

Type /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_ENTITY_NAME— Name of the property, set as measurement unit for the current one.

Method SET_PRECISION

This method is obsolete. Use method SET_UNIT_PRECISION_PROPERTY instead.

Method SET_UNIT_PRECISION_PROPERTY

This method sets the property that contains the precision for the current unit property.

Parameter

Description

IV_PRECISION_PROPERTY

Type /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_ENTITY_NAME - Name of the property set as precision for the current one

Method /IWBEP/IF_MGW_ODATA_PROPERTY~SET_REF_ANNO_PROPERTY

This method declares another property as a certain role for the current one.

The method allows to set all annotation keys generically. Currently, there is a check on the backend system for the following annotation keys:

  • sap:text

  • sap:unit

  • sap:precision

  • sap:lower-boundary

  • sap:upper-boundary

  • sap:super-ordinate

  • sap:attribute-for

  • sap:hierarchy-node-for

  • sap:hierarchy-level-for

  • sap:hierarchy-parent-node-for

  • sap:hierarchy-drill-state-for

Parameter

Description

IV_ANNOTATION_KEY

Name of the annotation element, of type /IWBEP/MED_ANNOTATION_KEY.

IV_PROPERTY

Name of the property referred to in the annotation, of type /IWBEP/MED_EXTERNAL_NAME.

On the SAP Gateway hub system the GUID of the referenced property is replaced by the actual name of the property. This method can be used instead of SET_UNIT_PROPERTY and SET_UNIT_PRECISION_PROPERTY.

Method SET_FC_TARGET_PATH

This method sets the target path of feed customization to a property.

The SET_AS* methods represent concrete target paths and wrap the SET_FC_TARGET_PATH method.

Parameter

Description

IV_KEEP_IN_CONTENT

Boolean to decide whether to keep the property still in the content or only in the target of the property.

Method SET_AS_AUTHOR

This method sets the target path of the property to feed customization target SyndicationTitle (atom:author).

Parameter

Description

IV_KEEP_IN_CONTENT

Boolean to decide whether to keep the property still in the content or only in the target of the property.

Method SET_AS_ETAG

This method sets the target path of the property to the ETag of the entry (m:etag in <atom:entry>) and also to the HTTP response header of a single read. If the Compatibility Mode for SP 02 is used the ETag needs to be set manually in the DPC. If the Standard Mode is used the ETag is set automatically.

Parameter

Description

IV_KEEP_IN_CONTENT

Boolean to decide whether to keep the property still in the content or only in the target of the property.

Method SET_AS_TITLE

This method sets the target path of the property to feed the customization target SyndicationTitle (atom:title).

Parameter

Description

IV_KEEP_IN_CONTENT

Boolean to decide whether to keep the property still in the content or only in the target of the property.

Method SET_AS_UPDATED

This method sets the target path of the property to feed the customization target SyndicationUpdated (atom:updated).

Parameter

Description

IV_KEEP_IN_CONTENT

Boolean to decide whether to keep the property still in the content or only in the target of the property.

Method SET_AS_PUBLISHED

This method sets the target path of the property to feed the customization target SyndicationPublished(atom:published).

Parameter

Description

IV_KEEP_IN_CONTENT

Boolean to decide whether to keep the property still in the content or only in the target of the property.

Method DISABLE_CONVERSION

This method disables the conversion for the property.

For more information, see SAP Note 1893788 Information published on SAP site.

Method ENABLE_CONVERSION

This method enables the conversion for the property.

For more information, see SAP Note 1893788 Information published on SAP site.