SAP ABAP Class CL_INM_BOE_CONNECTION (BOE Connection)

Hierarchy

☛ CPRXRPM (Software Component) SAP Portfolio and Project Management 6.0
   ⤷ PPM-CF (Application Component) Common Functions
     ⤷ INM_SHARED (Package) PPM Cross Application UI Objects

Properties

Class	CL_INM_BOE_CONNECTION
Short Description	BOE Connection
Super Class
Instantiability of a Class	0	Private
Final	☐

General Data

Message Class
Program status
Category	0
Package	INM_SHARED	PPM Cross Application UI Objects
Created	20100624	SAP
Last change	20141109
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)
2	CL_INM_BOE_CONSTANTS	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_INM_BOE_CONNECTION has no interface implemented.

Friends

Class CL_INM_BOE_CONNECTION has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MR_BADI_BOE_CONNECTION	Instance attribute	Private	☐	Object reference (TYPE REF TO)	INM_BOE_CONNECTION		Interface for BAdI: INM_BOE_CONNECTION	20110809
2	MR_CONVERTER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ABAP_CONV_IN_CE		Code Page and Endian Conversion (External -> System Format)	20110809
3	MR_CONV_OUT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ABAP_CONV_OUT_CE		Code Page and Endian Conversion (System Format -> External)	20110809
4	MR_HTTP_CLIENT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_HTTP_CLIENT		HTTP Client Abstraction	20100624
5	MV_AUTH_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20110816
6	MV_BOE_PORT	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20110831
7	MV_BOE_SERVER	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20110831
8	MV_CMS	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20110816
9	MV_CMS_SERVER	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20110831
10	MV_CONNECTION_TARGET	Instance attribute	Private	☐	Type reference (TYPE)	RFCDEST		Logical Destination (Specified in Function Call)	20100706
11	MV_COOKIE_VALUE	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Cookie Value	20110520
12	MV_EXPLORER_EXT	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20110831
13	MV_EXPLORER_URL	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20110816
14	MV_HTTP_PROTOCOL	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20110831
15	MV_LOGON_TOKEN	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20110809
16	MV_ON_PREMISE	Instance attribute	Private	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20110809
17	MV_PASSWORD	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Password	20100709
18	MV_PROTOCOL	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20110816
19	MV_USER_NAME	Instance attribute	Private	☐	Type reference (TYPE)	STRING		User Id	20100709
20	SR_INSTANCE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_INM_BOE_CONNECTION		BOE Connection	20100624

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_ALV_FIELDCATALOG	Instance method	Public	Method	Build an ALV based fieldcatalog	20110520
2	BUILD_FIELDCATALOG	Instance method	Public	Method	Build a fieldcatalog	20100624
3	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20110809
4	CREATE_CONNECTION	Static method	Public	Method	Create connection object	20100624
5	CREATE_NEW_DATASET	Instance method	Public	Method	Create a new dataset	20100624
6	DISCONNECT	Instance method	Public	Method	Terminate the http connection	20100624
7	FREE	Instance method	Public	Method	Free the instance	20100709
8	GET_ALL_DATASETS	Instance method	Public	Method	Return a list of all datasets for the user	20100624
9	GET_DATASET_POLESTAR_URL	Instance method	Public	Method	Return the URL for a dataset	20100706
10	_CONVERT_TO_STRING	Instance method	Private	Method	Convert the data to string representation	20100624
11	_CREATE_XML_DATASET	Instance method	Private	Method	Create a new dataset based on fieldcatalog	20100624
12	_CREATE_XML_INFOSPACE	Instance method	Private	Method	Create a new dataset for infospace based on fieldcatalog	20110816
13	_GET_CONVERSION_EXIT	Instance method	Private	Method	Determine conversion exit to use	20100624
14	_GET_CURRENCY_DECIMALS	Instance method	Private	Method	Determine the number of decimals for a numeric field	20100624
15	_GET_INFOSPACE_URL	Instance method	Private	Method		20110825
16	_GET_METADATA	Instance method	Private	Method	Determine the metadata for a type	20100624
17	_LOOKUP_DATA_TYPE	Instance method	Private	Method	Provide data type information	20100624
18	_PARSE_DATASETS_RESPONSE	Instance method	Private	Method	Parse a response XML and generate datasets structure	20100624
19	_PARSE_DATE_TIME_FIELD	Instance method	Private	Method	parse a combinded date and time field into it's parts	20100624
20	_REFRESH_REQUEST	Instance method	Private	Method	Refresh the request	20100624
21	_REPLACE_SPECIAL_CHARS	Instance method	Private	Method	Replace the special characters	20100625
22	_REQUEST_COOKIE_ONP	Instance method	Private	Method	Request cookie: On premise scenario	20110816
23	_REQUEST_SINGLE_TOKEN	Instance method	Private	Method	Request Single use token	20110810
24	_SET_REUSEABLE_HEADERS	Instance method	Private	Method	set header fields for request type	20100624

Events

Class CL_INM_BOE_CONNECTION has no event.

Types

Class CL_INM_BOE_CONNECTION has no local type.

Method Signatures

Method BUILD_ALV_FIELDCATALOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_ALV_MODEL	Call by reference	☐	Object reference (TYPE REF TO)	CL_SALV_WD_CONFIG_TABLE		Configuration of the ALV Output	20110520
2	Importing	IR_DATA	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20110520
3	Importing	IV_ONLY_VISIBLE	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ABAP_TRUE	Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20110520
4	Returning	RT_FIELD_CATALOG	Value transfer	☐	Type reference (TYPE)	INM_BOE_TT_FIELDCATALOG		BOE Field Catalog	20110520

Method BUILD_ALV_FIELDCATALOG on class CL_INM_BOE_CONNECTION has no exception.

Method BUILD_FIELDCATALOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_DATA	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20100625
2	Returning	RT_FIELD_CATALOG	Value transfer	☐	Type reference (TYPE)	INM_BOE_TT_FIELDCATALOG		BOE Field Catalog	20100625

Method BUILD_FIELDCATALOG on class CL_INM_BOE_CONNECTION has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_INM_BOE_CONNECTION has no parameter.
Method CONSTRUCTOR on class CL_INM_BOE_CONNECTION has no exception.

Method CREATE_CONNECTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PASSWORD	Call by reference	☑	Type reference (TYPE)	STRING		Password	20100709
2	Importing	IV_TARGET	Call by reference	☑	Type reference (TYPE)	RFC_DEST		SAPOSCOL destination	20100624
3	Importing	IV_USER_NAME	Call by reference	☑	Type reference (TYPE)	STRING		User name	20100709
4	Returning	RR_CONNECTION	Value transfer	☐	Object reference (TYPE REF TO)	CL_INM_BOE_CONNECTION		BOE Connection	20100624

#	Exception	Resumable	Description	Created on
1	CX_INM_BOE_AUTH	☐	BOE Authorization Exception	20100625
2	CX_INM_BOE_CONNECTION	☐	BOE Exception Class	20100625

Method CREATE_NEW_DATASET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_OPTIONS	Call by reference	☑	Type reference (TYPE)	INM_BOE_TS_DS_CREATE		BOE Dataset Create Options	20100625
2	Importing	IT_DATA	Call by reference	☐	Object reference (TYPE REF TO)	DATA		data source as internal table	20100625
3	Importing	IT_FIELD_CATALOG	Call by reference	☐	Type reference (TYPE)	INM_BOE_TT_FIELDCATALOG		field catalog for export	20100625
4	Importing	IV_UPDATE_SESSION_ID	Call by reference	☑	Type reference (TYPE)	STRING		Update instead of create	20100625
5	Returning	RV_SESSION_ID	Value transfer	☐	Type reference (TYPE)	STRING		Session ID	20100625

#	Exception	Resumable	Description	Created on
1	CX_INM_BOE_CONNECTION	☐	BOE Exception Class	20100713

Method DISCONNECT Signature

Method DISCONNECT on class CL_INM_BOE_CONNECTION has no parameter.
Method DISCONNECT on class CL_INM_BOE_CONNECTION has no exception.

Method FREE Signature

Method FREE on class CL_INM_BOE_CONNECTION has no parameter.
Method FREE on class CL_INM_BOE_CONNECTION has no exception.

Method GET_ALL_DATASETS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_BOE_DATASETS	Call by reference	☐	Type reference (TYPE)	INM_BOE_TT_DATASETS		BOE Datasets	20110520
2	Exporting	EV_RC	Call by reference	☐	Type reference (TYPE)	I			20100709
3	Importing	IV_PAGE	Call by reference	☐	Type reference (TYPE)	I	1		20100624
4	Importing	IV_SORT_ORDER	Call by reference	☐	Type reference (TYPE)	STRING	CL_INM_BOE_CONSTANTS=>SC_SORT_MOST_VIEWS		20100624
5	Importing	IV_TIME_FILTER	Call by reference	☐	Type reference (TYPE)	STRING	CL_INM_BOE_CONSTANTS=>SC_TFILTER_ANYTIME		20100624

#	Exception	Resumable	Description	Created on
1	CX_INM_BOE_CONNECTION	☐	BOE Exception Class	20100701

Method GET_DATASET_POLESTAR_URL Signature

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

#	Exception	Resumable	Description	Created on
1	CX_INM_BOE_CONNECTION	☐	BOE Exception Class	20110810

Method _CONVERT_TO_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_DATA	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20100625
2	Importing	IS_FIELD_CATALOG	Call by reference	☐	Type reference (TYPE)	INM_BOE_TS_FIELDCATALOG		BOE Field Catalog	20100625
3	Returning	RV_STRING_DATA	Value transfer	☐	Type reference (TYPE)	STRING			20100625

Method _CONVERT_TO_STRING on class CL_INM_BOE_CONNECTION has no exception.

Method _CREATE_XML_DATASET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_OPTIONS	Call by reference	☐	Type reference (TYPE)	INM_BOE_TS_DS_CREATE		BOE Dataset Create Options	20100625
2	Importing	IT_DATA	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Table Data	20100625
3	Importing	IT_FIELD_CATALOG	Call by reference	☐	Type reference (TYPE)	INM_BOE_TT_FIELDCATALOG		BOE Field Catalog	20100625
4	Returning	RV_XML_DATA	Value transfer	☐	Type reference (TYPE)	XSTRING			20100625

Method _CREATE_XML_DATASET on class CL_INM_BOE_CONNECTION has no exception.

Method _CREATE_XML_INFOSPACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_OPTIONS	Call by reference	☐	Type reference (TYPE)	INM_BOE_TS_DS_CREATE		BOE Dataset Create Options	20110816
2	Importing	IT_DATA	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20110816
3	Importing	IT_FIELD_CATALOG	Call by reference	☐	Type reference (TYPE)	INM_BOE_TT_FIELDCATALOG		BOE Field Catalog	20110816
4	Returning	RV_XML_DATA	Value transfer	☐	Type reference (TYPE)	XSTRING			20110816

Method _CREATE_XML_INFOSPACE on class CL_INM_BOE_CONNECTION has no exception.

Method _GET_CONVERSION_EXIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_DISPLAY_LENGTH	Call by reference	☐	Type reference (TYPE)	I			20100625
2	Exporting	EV_EXIT_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100625
3	Importing	IR_DATA	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20100625
4	Importing	IV_INOUT	Call by reference	☐	Type reference (TYPE)	I			20100625

Method _GET_CONVERSION_EXIT on class CL_INM_BOE_CONNECTION has no exception.

Method _GET_CURRENCY_DECIMALS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CURRENCY	Call by reference	☐	Type reference (TYPE)	STRING			20100625
2	Exporting	EV_DECIMALS	Call by reference	☐	Type reference (TYPE)	I			20100625
3	Exporting	EV_REFERENCE_TYPE	Call by reference	☐	Type reference (TYPE)	C			20100625
4	Importing	IR_DATA	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20100625

Method _GET_CURRENCY_DECIMALS on class CL_INM_BOE_CONNECTION has no exception.

Method _GET_INFOSPACE_URL Signature

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

Method _GET_INFOSPACE_URL on class CL_INM_BOE_CONNECTION has no exception.

Method _GET_METADATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_DATA	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20100625
2	Returning	RR_METADATA	Value transfer	☐	Object reference (TYPE REF TO)	IF_BSP_METADATA		BSP Runtime: Metadata Interface for Model Attributes	20100625

Method _GET_METADATA on class CL_INM_BOE_CONNECTION has no exception.

Method _LOOKUP_DATA_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_FIELDCATALOG	Call by reference	☑	Type reference (TYPE)	INM_BOE_TS_FIELDCATALOG		BOE Field Catalog	20110520
2	Exporting	EV_DATA_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	STRING			20100625
3	Exporting	EV_DATA_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20100625
4	Importing	IR_DATA	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20100625

Method _LOOKUP_DATA_TYPE on class CL_INM_BOE_CONNECTION has no exception.

Method _PARSE_DATASETS_RESPONSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_BOE_DATASETS	Call by reference	☐	Type reference (TYPE)	INM_BOE_TT_DATASETS		BOE Datasets	20110520
2	Importing	IV_DATASETS_XML	Call by reference	☐	Type reference (TYPE)	XSTRING			20100625

Method _PARSE_DATASETS_RESPONSE on class CL_INM_BOE_CONNECTION has no exception.

Method _PARSE_DATE_TIME_FIELD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_DATE	Call by reference	☐	Type reference (TYPE)	DATUM		Date	20100625
2	Exporting	EV_TIME	Call by reference	☐	Type reference (TYPE)	UZEIT		Time	20100625
3	Importing	IV_DATE_TIME	Call by reference	☐	Type reference (TYPE)	STRING			20100625

Method _PARSE_DATE_TIME_FIELD on class CL_INM_BOE_CONNECTION has no exception.

Method _REFRESH_REQUEST Signature

Method _REFRESH_REQUEST on class CL_INM_BOE_CONNECTION has no parameter.
Method _REFRESH_REQUEST on class CL_INM_BOE_CONNECTION has no exception.

Method _REPLACE_SPECIAL_CHARS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_STRING	Call by reference	☐	Type reference (TYPE)	ANY			20100625

Method _REPLACE_SPECIAL_CHARS on class CL_INM_BOE_CONNECTION has no exception.

Method _REQUEST_COOKIE_ONP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_STATUS	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20110816

Method _REQUEST_COOKIE_ONP on class CL_INM_BOE_CONNECTION has no exception.

Method _REQUEST_SINGLE_TOKEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_LOGON_TOKEN	Value transfer	☐	Type reference (TYPE)	STRING			20110810

#	Exception	Resumable	Description	Created on
1	CX_INM_BOE_CONNECTION	☐	BOE Exception Class	20110810

Method _SET_REUSEABLE_HEADERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_REQUEST_METHOD	Call by reference	☐	Type reference (TYPE)	STRING	CL_INM_BOE_CONSTANTS=>SC_REQUEST_METHOD_POST		20100625

Method _SET_REUSEABLE_HEADERS on class CL_INM_BOE_CONNECTION has no exception.

History

Last changed by/on	SAP	20141109
SAP Release Created in	500_702