SAP ABAP Class CL_REST_BASE_REQUEST (REST Base Request)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-MID-RST (Application Component) REST-based Protocols
     ⤷ SREST_CORE (Package) REST Core

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_REST_DESTROYABLE	REST destroyable object	20120309
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_REST_ENVIRONMENT	REST environment	20120307
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_REST_MESSAGE	REST Messages	20120302
4	Interface implementation (CLASS c. INTERFACES i_ref)	IF_REST_REQUEST	REST Request	20120302

Properties

Class	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	SREST_CORE	REST Core
Created	20120302	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_REST_DESTROYABLE	☐	☐	REST destroyable object	20120309
2	IF_REST_ENVIRONMENT	☐	☐	REST environment	20120307
3	IF_REST_MESSAGE	☐	☐	REST Messages	20120302
4	IF_REST_REQUEST	☐	☐	REST Request	20120302

Friends

#	Friend	Modeled only	Created on	Description
1	CL_REST_MESSAGE_BUILDER	☐	20120314	REST message builder

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_ENTITY	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_REST_ENTITY		Allow Method Override	20120302
2	MO_REQUEST	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_HTTP_REQUEST			20120304
3	MT_ATTRIBUTES	Instance attribute	Protected	☐	Type reference (TYPE)	TIHTTPNVP			20120307
4	MT_HEADER_NAME	Instance attribute	Private	☐	See coding				20120309
5	MT_QUERY_PARAMETER_DECODED	Instance attribute	Protected	☐	Type reference (TYPE)	TIHTTPNVP			20120307
6	MT_QUERY_PARAMETER_ENCODED	Instance attribute	Protected	☐	Type reference (TYPE)	TIHTTPNVP			20120307
7	MV_ALLOW_METHOD_OVERRIDE	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Allow method override	20120302
8	MV_EXPLICIT_ENTITY_CREATION	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Explicit entity creation	20120312
9	MV_FRAGMENT	Instance attribute	Protected	☐	Type reference (TYPE)	STRING		Fragment	20120303

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Protected	Constructor	Constructor	20120302
2	CREATE	Static method	Private	Method	Create instance	20120308
3	CREATE_REQUEST_ENTITY	Instance method	Public	Method	Create Request Entity	20120302
4	FETCH_HEADER_NAME	Instance method	Private	Method	Fetch header name	20120309
5	PARSE_QUERY	Static method	Protected	Method	Parse Query	20120308
6	PARSE_URI	Static method	Protected	Method	Parse URI	20120302
7	PUT_HEADER_NAME	Instance method	Private	Method	Put header name	20120309
8	SET_HEADER_FIELD	Instance method	Public	Method	Set Header Field	20120302
9	SET_HEADER_FIELDS	Instance method	Public	Method	Get Header Fields	20120302
10	SET_METHOD	Instance method	Public	Method	Set request method	20120302
11	SET_URI	Instance method	Public	Method	Set URI	20120302
12	WRAP_ENTITY	Instance method	Protected	Method	Wrap entity	20120308

Events

Class CL_REST_BASE_REQUEST has no event.

Types

Class 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	Importing	IO_REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_REQUEST		Request	20120304
2	Importing	IV_ALLOW_METHOD_OVERRIDE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_UNDEFINED	Allow method override	20120308

Method CONSTRUCTOR on class 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	Importing	IO_REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_REQUEST		HTTP Request	20120308
2	Importing	IV_ALLOW_METHOD_OVERRIDE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_UNDEFINED	Allow method override	20120308
3	Returning	RO_REQUEST	Value transfer	☐	Object reference (TYPE REF TO)	CL_REST_BASE_REQUEST		REST Request	20120308

Method CREATE on class 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	Importing	IV_MULTIPART	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Create multipart entity?	20120302
2	Returning	RO_ENTITY	Value transfer	☐	Object reference (TYPE REF TO)	IF_REST_ENTITY		REST Representation	20120302

Method CREATE_REQUEST_ENTITY on class 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	Changing	CV_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Value	20120309

Method FETCH_HEADER_NAME on class 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	Exporting	ET_QUERY_PARAMETER_DECODED	Call by reference	☐	Type reference (TYPE)	TIHTTPNVP		Decoded query parameter	20120308
2	Exporting	ET_QUERY_PARAMETER_ENCODED	Call by reference	☐	Type reference (TYPE)	TIHTTPNVP		Encoded query parameter	20120308
3	Importing	IV_QUERY_STRING	Call by reference	☐	Type reference (TYPE)	STRING		Query string	20120308

Method PARSE_QUERY on class 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	Exporting	EV_FRAGMENT	Call by reference	☐	Type reference (TYPE)	STRING		Fragment	20120302
2	Exporting	EV_PATH	Call by reference	☐	Type reference (TYPE)	STRING		Path	20120302
3	Exporting	EV_PATH_INFO	Call by reference	☐	Type reference (TYPE)	STRING		Path info	20120302
4	Exporting	EV_QUERY	Call by reference	☐	Type reference (TYPE)	STRING		Query	20120302
5	Exporting	EV_SCRIPT_PARAMETER	Call by reference	☐	Type reference (TYPE)	STRING		Script parameter	20120416
6	Importing	IV_SCRIPT_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Script name	20120302
7	Importing	IV_URI	Call by reference	☐	Type reference (TYPE)	STRING		Request URI	20120302

Method PARSE_URI on class 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	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name	20120309

Method PUT_HEADER_NAME on class 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	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Header Name	20120302
2	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	STRING		Header Value	20120302

Method SET_HEADER_FIELD on class 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	Importing	IT_HEADER_FIELDS	Call by reference	☐	Type reference (TYPE)	TIHTTPNVP		HTTP Framework (iHTTP) Table Name/Value Pairs	20120302

Method SET_HEADER_FIELDS on class 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	Importing	IV_METHOD	Call by reference	☐	Type reference (TYPE)	STRING		HTTP Method	20120302

Method SET_METHOD on class 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	Importing	IV_STATIC_PATH	Call by reference	☑	Type reference (TYPE)	STRING		Static Path part of URI which is not used for REST routing	20120302
2	Importing	IV_URI	Call by reference	☐	Type reference (TYPE)	STRING		URI	20120302

Method SET_URI on class 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	Importing	IO_ENTITY	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_ENTITY		HTTP Entity	20120308
2	Returning	RO_ENTITY	Value transfer	☐	Object reference (TYPE REF TO)	CL_REST_BASE_ENTITY		REST Base Entity	20120308

Method WRAP_ENTITY on class CL_REST_BASE_REQUEST has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	804