SAP ABAP Class CL_REST_REQUEST (REST 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_MESSAGE	REST Messages	20120325
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_REST_REQUEST	REST Request	20120325

Properties

Class	CL_REST_REQUEST
Short Description	REST Request
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SREST_CORE	REST Core
Created	20100602	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_MESSAGE	☐	☐	REST Messages	20120325
2	IF_REST_REQUEST	☐	☐	REST Request	20120325

Friends

Class CL_REST_REQUEST has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_REQUEST	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_REST_REQUEST			20120325

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BASE_REQUEST	Instance method	Private	Method		20120325
2	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20100602
3	CREATE_REQUEST_ENTITY	Instance method	Public	Method	Create Request Entity	20120325
4	SET_HEADER_FIELD	Instance method	Public	Method	Set Header Field	20120325
5	SET_HEADER_FIELDS	Instance method	Public	Method	Get Header Fields	20120325
6	SET_METHOD	Instance method	Public	Method	Set Request Method	20120325
7	SET_URI	Instance method	Public	Method	Set URI	20120325

Events

Class CL_REST_REQUEST has no event.

Types

Class CL_REST_REQUEST has no local type.

Method Signatures

Method BASE_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_REQUEST	Value transfer	☐	Object reference (TYPE REF TO)	CL_REST_BASE_REQUEST			20120325

Method BASE_REQUEST on class CL_REST_REQUEST has no exception.

Method CONSTRUCTOR 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		Header Fields	20100618
2	Importing	IV_ALLOW_METHOD_OVERRIDE	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL		Method Override allowed?	20100623
3	Importing	IV_MESSAGE_BODY	Call by reference	☑	Type reference (TYPE)	XSTRING		Application Data	20100617
4	Importing	IV_METHOD	Call by reference	☑	Type reference (TYPE)	STRING		HTTP Method (e.g. GET)	20100602
5	Importing	IV_STATIC_PATH	Call by reference	☑	Type reference (TYPE)	STRING		Part of URI Path which is not used for REST routing	20100614
6	Importing	IV_URI	Call by reference	☑	Type reference (TYPE)	STRING		URI	20100602

Method CONSTRUCTOR on class CL_REST_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?	20120325
2	Returning	RO_ENTITY	Value transfer	☐	Object reference (TYPE REF TO)	IF_REST_ENTITY		REST Representation	20120325

Method CREATE_REQUEST_ENTITY on class CL_REST_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	20120325
2	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	STRING		Header Value	20120325

Method SET_HEADER_FIELD on class CL_REST_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	20120325

Method SET_HEADER_FIELDS on class CL_REST_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	20120325

Method SET_METHOD on class CL_REST_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	20120325
2	Importing	IV_URI	Call by reference	☐	Type reference (TYPE)	STRING		URI	20120325

Method SET_URI on class CL_REST_REQUEST has no exception.

History

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