Show TOC

/IWBEP/IF_MGW_ODATA_ENTITY_SETLocate this document in the navigation structure

Use

This is an interface which represents an OData Channel EntitySet object.

Methods

Method SET_TITLE

Note

This method is deprecated. Use method SET_MEMBER_TITLE_FR_TELEMENT instead.

The method creates a description for a field <atom:title> 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, for example, a reference to a text symbol from text references of a class or report.

Example: /IWFBEP/CL_MGW_MED_SFLIGHT-000

The text is not case-sensitive.

IV_TEXT_OBJ_TYPE

Text object type.

Example: GCS_SAP_TEXT_OBJECT_TYPES-BACKEND_GATEWAY_TEXT

Method SET_MEMBER_TITLE

Note

This method is deprecated. Use method SET_MEMBER_TITLE_FR_TELEMENT instead.

The method creates a description for a field <sap:member-title> 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

The text is not case-sensitive.

IV_TEXT_OBJ_TYPE

Text in the text object type defined in the field mentioned above.

Example: GCS_SAP_TEXT_OBJECT_TYPES-BACKEND_GATEWAY_TEXT

Method SET_MEMBER_TITLE_FR_TELEMENT

This method creates the <sap:member-title> of a collection from a reference to a text element.

Parameter

Description

IW_TEXT_ELEMENT_SYMBOL

Symbol of the text element, for example 000.

IV_TEXT_ELEMENT_CONTAINER

Name of the text element container, for example, a report name or the class name. This is an optional parameter which should be filled if the text reference is located in another class or report and not the MPC.

IO_OBJECT_REF

Reference of the class which contains the text element. If the MPC contains the texts ABAP me needs to be passed.

Method SET_CREATABLE

This method indicates whether instances of this type can be created. The default value is true and therefore not shown in the service metadata document.

Parameter

Description

IV_CREATABLE

Value of EntitySet.

Method SET_UPDATABLE

This method indicates whether instances of this type can be updated. The default value is true and therefore not shown in the service metadata document.

Parameter

Description

IV_UPDATABLE

Value of EntitySet.

Method SET_DELETABLE

This method indicates whether instances of this type can be deleted. The default value is true and therefore not shown in the service metadata document.

Parameter

Description

IV_DELETABLE

Value of EntitySet.

Method SET_PAGEABLE

This method indicates whether paging can be applied to an EntitySet, for example parameters $top and $skip. The default value is true and therefore not shown in the service document for the collection (directly associated to EntitySet).

Parameter

Description

IV_PAGEABLE

Value

Method SET_ADDRESSABLE

This method indicates whether an EntitySet can be addressed directly or only via NavigationProperty. The default value is true and therefore not shown in the service document.

Parameter

Description

IV_ADDRESSABLE

Value

Method SET_SUBSCRIBABLE

This method iIndicates whether it is possible to subscribe to this type. The default value is false and therefore nothing is shown in the service document. Types supporting subscriptions are annotated with an atom:link element with attribute rel="http:/www.sap.com/Protocols/SAPData/rel#subscribe" in the service document.

Parameter

Description

IV_IS_SUBSCRIBABLE

Value

Method SET_FILTER_REQUIRED

Method HAS_FTXT_SEARCH

Collections of this data type can be searched through OpenSearch. The default value is false and therefore nothing is shown in the service document. Types supporting OpenSearch are annoted an atom:link element with attribute rel="search" in the service document. The atom:link href points to the OpenSearch description document.

Parameter

Description

IV_FSEARCH

Value

For more information, see the SAP NetWeaver documentation about Search and OpenSearch Capabilities.