SAP ABAP Class CL_SMI2_ODATA_SRV_HELPER (CL_SMI2_ODATA_SRV_HELPER)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ CA-UI2-AR-SM (Application Component) SAP UI Integration - Social Media Collaboration Enablement
     ⤷ AR_FND_SM_SERVICES (Package) UI AR: Social Media Model Provider & Data Provider Abstract

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SMI2_ODATA_SRV_HELPER	SMI OData Service Helper	20140716

Properties

Class	CL_SMI2_ODATA_SRV_HELPER
Short Description
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	AR_FND_SM_SERVICES	UI AR: Social Media Model Provider & Data Provider Abstract
Created	20140716	SAP
Last change	20141121
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_SMI2_ODATA_SRV_HELPER	☐	☐	SMI OData Service Helper	20140716

Friends

Class CL_SMI2_ODATA_SRV_HELPER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_INBOUND_DEST_NAME	Constant	Private	☐	Type reference (TYPE)	BGRFC_DEST_NAME_INBOUND	'SMI_FILE_BGRFC'	Name of Destination in Inbound Case	20140808
2	MO_COLLAB_HOST_HANDLER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SMI2_COLLAB_HOST_HANDLER		SMI Collaboration host handler	20140716
3	MO_CONFIGURATION_HANDLER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SMI2_CONFIGURATION_HANDLER		SMI System Configuration Handler	20140716
4	MO_SMI2_CONVERTER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SMI2_CONVERTER		SMI Converter	20140716
5	MV_SERVICE_PATH	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20140716

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_QUEUE_NAME	Instance method	Private	Method	builds a unique queue name from a name	20140808
2	CANONIZE_ODATA_SERVICE_PATH	Instance method	Private	Method	Ensures there's a slash at end of the service URL or path.	20140717
3	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20140716
4	DOWNLOAD_FILE	Instance method	Private	Method	Downloads file	20140716
5	ESCAPE_URL	Instance method	Private	Method	Escape URL	20140716
6	EXTRACT_ERROR_MESSAGE	Instance method	Private	Method	Extract error message from collaboration platform's response	20140716
7	GET_INTERNAL_URL	Instance method	Private	Method	Contructs the internal OData URL from a relative path.	20140716
8	INTERNAL_TO_EXTERNAL_URL	Instance method	Private	Method	Maps an internal OData URL to it external form.	20140716
9	URL_CONTAINS_PREFIX	Instance method	Private	Method	Check if a url already contains prefix (http://server:port)	20140716

Events

Class CL_SMI2_ODATA_SRV_HELPER has no event.

Types

Class CL_SMI2_ODATA_SRV_HELPER has no local type.

Method Signatures

Method BUILD_QUEUE_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			20140808
2	Returning	RV_QUEUE_NAME	Value transfer	☐	Type reference (TYPE)	QRFC_QUEUE_NAME		Queue Name for Background RFC	20140808

Method BUILD_QUEUE_NAME on class CL_SMI2_ODATA_SRV_HELPER has no exception.

Method CANONIZE_ODATA_SERVICE_PATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ODATA_SERVICE_PATH	Call by reference	☐	Type reference (TYPE)	STRING			20140717
2	Returning	RV_ODATA_SERVICE_PATH	Value transfer	☐	Type reference (TYPE)	STRING			20140717

Method CANONIZE_ODATA_SERVICE_PATH on class CL_SMI2_ODATA_SRV_HELPER has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_SMI2_ODATA_SRV_HELPER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SMI2_TECH	☐		20140716

Method DOWNLOAD_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_URL	Call by reference	☐	Type reference (TYPE)	STRING			20140716
2	Returning	RV_FILE	Value transfer	☐	Type reference (TYPE)	XSTRING		HTTP Framework (iHTTP) HTTP Response	20140716

#	Exception	Resumable	Description	Created on
1	CX_SMI2_TECH	☐		20140716

Method ESCAPE_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_URL	Call by reference	☐	Type reference (TYPE)	STRING			20140716
2	Returning	RV_URL	Value transfer	☐	Type reference (TYPE)	STRING			20140716

Method ESCAPE_URL on class CL_SMI2_ODATA_SRV_HELPER has no exception.

Method EXTRACT_ERROR_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_IXML_DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT		IF_IXML_DOCUMENT	20140716
2	Returning	RV_ERROR_MESSAGE	Value transfer	☐	Type reference (TYPE)	STRING			20140716

Method EXTRACT_ERROR_MESSAGE on class CL_SMI2_ODATA_SRV_HELPER has no exception.

Method GET_INTERNAL_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_RELATIVE_PATH	Call by reference	☐	Type reference (TYPE)	STRING			20140716
2	Returning	RV_INTERNAL_URL	Value transfer	☐	Type reference (TYPE)	STRING			20140716

#	Exception	Resumable	Description	Created on
1	CX_SMI2_TECH	☐		20140716

Method INTERNAL_TO_EXTERNAL_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_INTERNAL_URL	Call by reference	☐	Type reference (TYPE)	STRING			20140716
2	Returning	RV_EXTERNAL_URL	Value transfer	☐	Type reference (TYPE)	STRING			20140716

#	Exception	Resumable	Description	Created on
1	CX_SMI2_TECH	☐		20140716

Method URL_CONTAINS_PREFIX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_URL	Call by reference	☐	Type reference (TYPE)	STRING			20140716
2	Returning	RV_PREFIX	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20140716

Method URL_CONTAINS_PREFIX on class CL_SMI2_ODATA_SRV_HELPER has no exception.

History

Last changed by/on	SAP	20141121
SAP Release Created in	100