SAP ABAP Class CL_SMI_ODATA_SRV_HELPER (Social Media Integration Odata service helper class)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ CA-UI2-AR-SM (Application Component) SAP UI Integration - Social Media Collaboration Enablement
     ⤷ AR_702_SM_SERVICES (Package) UI AR - Social Media Data Provider Impl. (Rel. Dependent)

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SMI_ODATA_SRV_HELPER	SMI OData Service helper	20130515

Properties

Class	CL_SMI_ODATA_SRV_HELPER
Short Description	Social Media Integration Odata service helper class
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	AR_702_SM_SERVICES	UI AR - Social Media Data Provider Impl. (Rel. Dependent)
Created	20130515	SAP
Last change	20131127	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_SMI_ODATA_SRV_HELPER has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SMI_ODATA_SRV_HELPER	☐	☐	SMI OData Service helper	20130515

Friends

Class CL_SMI_ODATA_SRV_HELPER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_BIZ_OBJ_HANDLER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SMI_BIZ_OBJ_HANDLER			20130603
2	MO_COLLAB_HOST_HANDLER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SMI_COLLAB_HOST_HANDLER			20130621
3	MO_CONFIGURATION_HANDLER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SMI_CONFIGURATION_HANDLER		SMI System Configuration handler	20130621
4	MO_INT2EXT_BO_MAPPER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SMI_INT2EXT_BO_MAPPER		Maps internal BO OData info to its external OData info	20140410
5	MO_ODATA_EXT_OBJ_UTILITY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SMI_ODATA_EXT_OBJ_UTILITY		A utility class for Jam OData ExternalObjects.	20140410
6	MO_XML_BUILDER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SMI_ODATA_PAYLOAD_BUILDER			20130603
7	MO_XML_CONVERTER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SMI_ODATA_XML_CONVERTER			20130603
8	MV_SERVICE_PATH	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20130603

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20130603
2	CREATE_GROUP	Instance method	Private	Method	Request to create a Jam group. Returns the group if created.	20130603
3	DOWNLOAD_CONTENT_ITEM	Instance method	Private	Method	dowload the file from a server	20140526
4	ENCODE_URL_FOR_CONTENT_ITEM	Instance method	Private	Method	Encodes the folder path and file name	20140523
5	GET_INTERNAL_URL	Instance method	Private	Method	Contructs the internal OData URL from a relative path.	20131106
6	INTERNAL_TO_EXTERNAL_URL	Instance method	Private	Method	Maps an internal OData URL to it external form.	20131106
7	IS_GROUP_ID_ASSIGNED	Instance method	Private	Method	True if group id is in the table. False otherwise.	20130710
8	URL_CONTAINS_PREFIX	Instance method	Private	Method	Check if a url already contains prefix (http://server:port)	20131119

Events

Class CL_SMI_ODATA_SRV_HELPER has no event.

Types

Class CL_SMI_ODATA_SRV_HELPER has no local type.

Method Signatures

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_SMI_ODATA_SRV_HELPER has no parameter.

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_BUSI_EXCEPTION	☐	Business Exception	20130603
2	/IWBEP/CX_MGW_TECH_EXCEPTION	☐	Technical Exception	20130603

Method CREATE_GROUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_GROUP	Call by reference	☐	Type reference (TYPE)	CL_SM_INTEGRATION_MPC_EXT=>TS_GROUP		Details of Group entity to create.	20130603
2	Returning	RS_GROUP	Value transfer	☐	Type reference (TYPE)	CL_SM_INTEGRATION_MPC_EXT=>TS_GROUP		Full details of Group entity if creation was successful.	20130603

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_BUSI_EXCEPTION	☐		20130603
2	/IWBEP/CX_MGW_TECH_EXCEPTION	☐		20130603

Method DOWNLOAD_CONTENT_ITEM 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			20140526
2	Returning	RV_RESPONSE	Value transfer	☐	Object reference (TYPE REF TO)	IF_HTTP_RESPONSE		HTTP Framework (iHTTP) HTTP Response	20140526

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_BUSI_EXCEPTION	☐	Business Exception	20140526
2	/IWBEP/CX_MGW_TECH_EXCEPTION	☐	Technical Exception	20140526

Method ENCODE_URL_FOR_CONTENT_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_URL	Call by reference	☐	Type reference (TYPE)	STRING		url of the file	20140523

Method ENCODE_URL_FOR_CONTENT_ITEM on class CL_SMI_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		Relative path to construct an internal URL from.	20131106
2	Returning	RV_INTERNAL_URL	Value transfer	☐	Type reference (TYPE)	STRING		Internal URL constructed from the relative path.	20131106

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_BUSI_EXCEPTION	☐	Business Exception	20131106
2	/IWBEP/CX_MGW_TECH_EXCEPTION	☐	Technical Exception	20131106

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		Internal OData URL to convert into its external form.	20131106
2	Returning	RV_EXTERNAL_URL	Value transfer	☐	Type reference (TYPE)	STRING		External version of the OData internal URL.	20131106

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_BUSI_EXCEPTION	☐	Business Exception	20131106
2	/IWBEP/CX_MGW_TECH_EXCEPTION	☐	Technical Exception	20131106

Method IS_GROUP_ID_ASSIGNED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ASSIGNED_GROUP_IDS	Call by reference	☐	Type reference (TYPE)	IF_SMI_ODATA_SRV_HELPER=>TT_SORTED_INTEGERS		Table of assigned group ids.	20130710
2	Importing	IV_GROUP_ID	Call by reference	☐	Type reference (TYPE)	I		Group id to check.	20130710
3	Returning	RV_IS_GROUP_ID_ASSIGNED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		True if group id is in the table. False otherwise.	20130710

Method IS_GROUP_ID_ASSIGNED on class CL_SMI_ODATA_SRV_HELPER has no exception.

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		A url	20131119
2	Returning	RV_PREFIX	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		if containing prefix, return true	20131119

Method URL_CONTAINS_PREFIX on class CL_SMI_ODATA_SRV_HELPER has no exception.

History

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