This interface represents an OData service operation / function import: see http://www.odata.org/developers/protocols/operations#InvokingServiceOperations and http://www.odata.org/developers/protocols/uri-conventions#AddressingServiceOperations.
Method SET_RETURN_ENTITY_TYPE
This method sets the return entity type of a function import.
Note that a function import can either return an entity type or a complex type.
Parameter |
Description |
---|---|
IV_DATA_OBJECT_NAME |
Name of the entity type which is returned by the function import and which is declared for the current model. |
Method SET_RETURN_ENTITY_SET
This method sets return entity set of a function import which can be a single entity set or a collection of entity sets depending on the defined multiplicity.
Note that a function import can either return an entity type or a complex type.
Parameter |
Description |
---|---|
IV_ENTITY_SET_NAME |
Name of the entity set which is returned by the function import and which is declared for the current model. |
Method SET_RETURN_MULTIPLICITY
This method sets multiplicity to indicate whether a function import returns a collection / feed of entries or just a single entry.
Parameter |
Description |
---|---|
IV_MULTIPLICITY |
Use constants /IWBEP/CL_MGW_ABS_MODEL=>CARDINALITY_FEED or /IWBEP/CL_MGW_ABS_MODEL=>CARDINALITY_ENTITY to set the multiplicity. |
Method SET_HTTP_METHOD
This method sets the HTTP method of a function import, for example GET.
The HTTP method of a function import is used to indicate whether the function import does any modifications or is read-only. Modifying function imports should use PUT, non-modifying should set GET.
Parameter |
Description |
---|---|
IV_HTTP_METHOD |
Method, for example GET or POST. |
Method CREATE_INPUT_PARAMETER
This method defines an input parameter for the function import.
Note that parameters are only passed via URL parameters and not in the request body (OData 2.0 Specification).
Parameter |
Description |
---|---|
IV_PARAMETER_NAME |
External parameter name which is shown in the service metadata document and used when invoking a service operation. |
IV_ABAP_FIELDNAME |
Internal ABAP name representation of the parameter. |
RO_PARAMETER |
Instance of parameter to do a data element binding, for example. |
Method SET_RETURN_COMPLEX_TYPE
This method sets the return complex type of a function import.
Note that a function import can either return an entity type or a complex type. In SAP Gateway it is only possible to have single complex types as return types. Collections are not allowed and therefore multiplicity had best use /IWBEP/CL_MGW_ABS_MODEL=>CARDINALITY_ENTITY for return complex types.
Parameter |
Description |
---|---|
IV_COMPLEX_TYPE_NAME |
Name of the complex type which is declared in the model and used as return type. |
Method SET_ACTION_FOR
This method sets the value of the sap annotation sap:action-for.
Parameter |
Description |
---|---|
IV_ENTITY_TYPE_NAME |
Name for which the action can be applied. |