SAP ABAP Class /IWCOR/CL_REST_BASE_REQUEST (REST Base Request)
Hierarchy
☛
SAP_GWFND (Software Component) SAP Gateway Foundation
⤷
OPU-FND-CCL (Application Component) IWF Consumer Connectivity Layer
⤷
/IWCOR/SREST_CORE (Package) REST library core
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | /IWCOR/IF_REST_DESTROYABLE | REST destroyable object | 20120410 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | /IWCOR/IF_REST_ENVIRONMENT | REST environment | 20120410 |
| 3 | Interface implementation (CLASS c. INTERFACES i_ref) | /IWCOR/IF_REST_MESSAGE | REST Messages | 20120305 |
| 4 | Interface implementation (CLASS c. INTERFACES i_ref) | /IWCOR/IF_REST_REQUEST | REST Request | 20120305 |
Properties
| Class | /IWCOR/CL_REST_BASE_REQUEST | |
| Short Description | REST Base Request | |
| Super Class | ||
| Instantiability of a Class | 1 | Protected |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | /IWCOR/SREST_CORE | REST library core |
| Created | 20120302 | SAP |
| Last change | 20131127 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | /IWCOR/IF_REST_DESTROYABLE | REST destroyable object | 20120410 | ||
| 2 | /IWCOR/IF_REST_ENVIRONMENT | REST environment | 20120410 | ||
| 3 | /IWCOR/IF_REST_MESSAGE | REST Messages | 20120305 | ||
| 4 | /IWCOR/IF_REST_REQUEST | REST Request | 20120305 |
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | /IWCOR/CL_REST_MESSAGE_BUILDER | 20120813 | REST message builder |
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Protected | Object reference (TYPE REF TO) | /IWCOR/IF_REST_ENTITY | Allow Method Override | 20120305 | |||
| 2 | Instance attribute | Protected | Object reference (TYPE REF TO) | IF_HTTP_REQUEST | 20120305 | ||||
| 3 | Instance attribute | Protected | Type reference (TYPE) | TIHTTPNVP | 20120410 | ||||
| 4 | Instance attribute | Private | See coding | 20120410 | |||||
| 5 | Instance attribute | Protected | Type reference (TYPE) | TIHTTPNVP | 20120410 | ||||
| 6 | Instance attribute | Protected | Type reference (TYPE) | TIHTTPNVP | 20120410 | ||||
| 7 | Instance attribute | Protected | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Allow method override | 20120305 | ||
| 8 | Instance attribute | Protected | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Explicit entity creation | 20120410 | ||
| 9 | Instance attribute | Protected | Type reference (TYPE) | STRING | Fragment | 20120305 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Protected | Constructor | Constructor | 20120305 | |
| 2 | Static method | Private | Method | Create instance | 20120410 | |
| 3 | Instance method | Public | Method | Create Request Entity | 20120305 | |
| 4 | Instance method | Private | Method | Fetch header name | 20120410 | |
| 5 | Static method | Protected | Method | Parse Query | 20120410 | |
| 6 | Static method | Protected | Method | Parse URI | 20120305 | |
| 7 | Instance method | Private | Method | Put header name | 20120410 | |
| 8 | Instance method | Public | Method | Set Header Field | 20120305 | |
| 9 | Instance method | Public | Method | Get Header Fields | 20120305 | |
| 10 | Instance method | Public | Method | Set request method | 20120305 | |
| 11 | Instance method | Public | Method | Set URI | 20120305 | |
| 12 | Instance method | Protected | Method | Wrap entity | 20120410 |
Events
Class /IWCOR/CL_REST_BASE_REQUEST has no event.
Types
Class /IWCOR/CL_REST_BASE_REQUEST has no local type.
Method Signatures
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_REQUEST | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_REQUEST | Request | 20120305 | |||
| 2 | IV_ALLOW_METHOD_OVERRIDE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_UNDEFINED | Allow method override | 20120410 |
Method CONSTRUCTOR on class /IWCOR/CL_REST_BASE_REQUEST has no exception.
Method CREATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_REQUEST | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_REQUEST | HTTP Request | 20120410 | |||
| 2 | IV_ALLOW_METHOD_OVERRIDE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_UNDEFINED | Allow method override | 20120410 | ||
| 3 | RO_REQUEST | Value transfer | Object reference (TYPE REF TO) | /IWCOR/CL_REST_BASE_REQUEST | REST Request | 20120410 |
Method CREATE on class /IWCOR/CL_REST_BASE_REQUEST has no exception.
Method CREATE_REQUEST_ENTITY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_MULTIPART | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Create multipart entity? | 20120305 | ||
| 2 | RO_ENTITY | Value transfer | Object reference (TYPE REF TO) | /IWCOR/IF_REST_ENTITY | REST Representation | 20120305 |
Method CREATE_REQUEST_ENTITY on class /IWCOR/CL_REST_BASE_REQUEST has no exception.
Method FETCH_HEADER_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CV_NAME | Call by reference | Type reference (TYPE) | STRING | Value | 20120410 |
Method FETCH_HEADER_NAME on class /IWCOR/CL_REST_BASE_REQUEST has no exception.
Method PARSE_QUERY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_QUERY_PARAMETER_DECODED | Call by reference | Type reference (TYPE) | TIHTTPNVP | Decoded query parameter | 20120410 | |||
| 2 | ET_QUERY_PARAMETER_ENCODED | Call by reference | Type reference (TYPE) | TIHTTPNVP | Encoded query parameter | 20120410 | |||
| 3 | IV_QUERY_STRING | Call by reference | Type reference (TYPE) | STRING | Query string | 20120410 |
Method PARSE_QUERY on class /IWCOR/CL_REST_BASE_REQUEST has no exception.
Method PARSE_URI Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_FRAGMENT | Call by reference | Type reference (TYPE) | STRING | Fragment | 20120305 | |||
| 2 | EV_PATH | Call by reference | Type reference (TYPE) | STRING | Path | 20120305 | |||
| 3 | EV_PATH_INFO | Call by reference | Type reference (TYPE) | STRING | Path info | 20120305 | |||
| 4 | EV_QUERY | Call by reference | Type reference (TYPE) | STRING | Query | 20120305 | |||
| 5 | EV_SCRIPT_PARAMETER | Call by reference | Type reference (TYPE) | STRING | Script parameter | 20120417 | |||
| 6 | IV_SCRIPT_NAME | Call by reference | Type reference (TYPE) | STRING | Script name | 20120305 | |||
| 7 | IV_URI | Call by reference | Type reference (TYPE) | STRING | Request URI | 20120305 |
Method PARSE_URI on class /IWCOR/CL_REST_BASE_REQUEST has no exception.
Method PUT_HEADER_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_NAME | Call by reference | Type reference (TYPE) | STRING | Name | 20120410 |
Method PUT_HEADER_NAME on class /IWCOR/CL_REST_BASE_REQUEST has no exception.
Method SET_HEADER_FIELD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_NAME | Call by reference | Type reference (TYPE) | STRING | Header Name | 20120305 | |||
| 2 | IV_VALUE | Call by reference | Type reference (TYPE) | STRING | Header Value | 20120305 |
Method SET_HEADER_FIELD on class /IWCOR/CL_REST_BASE_REQUEST has no exception.
Method SET_HEADER_FIELDS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_HEADER_FIELDS | Call by reference | Type reference (TYPE) | TIHTTPNVP | HTTP Framework (iHTTP) Table Name/Value Pairs | 20120305 |
Method SET_HEADER_FIELDS on class /IWCOR/CL_REST_BASE_REQUEST has no exception.
Method SET_METHOD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_METHOD | Call by reference | Type reference (TYPE) | STRING | HTTP Method | 20120305 |
Method SET_METHOD on class /IWCOR/CL_REST_BASE_REQUEST has no exception.
Method SET_URI Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_STATIC_PATH | Call by reference | Type reference (TYPE) | STRING | Static Path part of URI which is not used for REST routing | 20120305 | |||
| 2 | IV_URI | Call by reference | Type reference (TYPE) | STRING | URI | 20120305 |
Method SET_URI on class /IWCOR/CL_REST_BASE_REQUEST has no exception.
Method WRAP_ENTITY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_ENTITY | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_ENTITY | HTTP Entity | 20120410 | |||
| 2 | RO_ENTITY | Value transfer | Object reference (TYPE REF TO) | /IWCOR/CL_REST_BASE_ENTITY | REST Base Entity | 20120410 |
Method WRAP_ENTITY on class /IWCOR/CL_REST_BASE_REQUEST has no exception.
History
| Last changed by/on | SAP | 20131127 |
| SAP Release Created in | 200 |