SAP ABAP Class CL_RSL_AO_AINX_HANDLER (AINX Handler)

Hierarchy

☛ SAP_BW (Software Component) SAP Business Warehouse
   ⤷ BW-BEX-OT-WSP (Application Component) BW Workspace
     ⤷ RSL_AO (Package) BW Workspace - Analysis for MS Excel - Interface

Properties

Class	CL_RSL_AO_AINX_HANDLER
Short Description	AINX Handler
Super Class
Instantiability of a Class	1	Protected
Final	☑

General Data

Message Class
Program status
Category	0
Package	RSL_AO	BW Workspace - Analysis for MS Excel - Interface
Created	20130128	SAP
Last change	20140121	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_RSL_AO_AINX_CREATOR	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	CL_RSL_AO_AINX_HANDLER	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	IF_RSL_UI_DEFINITIONS	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
4	IF_WDR_ACF_HNDL	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
5	RS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_RSL_AO_AINX_HANDLER has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_RSL_AO_FACADE	☐	20130130	AO Interface Facade Class

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	N_CS_FILETYPE	Constant	Public	☐	See coding				20130613
2	N_CS_PROV_ROLE	Constant	Public	☐	See coding				20130204
3	P_CHKFL_DATA	Instance attribute	Private	☐	Type reference (TYPE)	RS_BOOL		Data Set?	20130619
4	P_CHKFL_NAME	Instance attribute	Private	☐	Type reference (TYPE)	RS_BOOL		Name Set?	20130619
5	P_EMPTY	Instance attribute	Private	☐	Type reference (TYPE)	RS_BOOL		Provider will have no data	20130611
6	P_R_ASSIST	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_RSLUI_PROVIDER_ASSIST		Assist Class for Provider Upload	20130128
7	P_R_WSP	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_RSL_WSP		BWA Workspaces	20130128

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Protected	Constructor	Constructor	20130128
2	CREATE_AND_LOAD	Instance method	Public	Method	Create the AINX and load the data into the index	20130128
3	DELETE_AINX	Instance method	Public	Method	Delete an AINX from the current Workspace	20130702
4	DEQUEUE_WORKSPACE	Instance method	Protected	Method	Dequeue the Workspace	20130625
5	DETERMINE_COLUMNS	Instance method	Public	Method	Determine the column definitions	20130128
6	DETERMINE_INFOOBJECTS	Instance method	Public	Method	Determine the available InfoObjects (used in this WSP)	20130201
7	GET_AVAILABLE_DATA_TYPES	Static method	Public	Method	Returns all valid datatypes which are supported by the WSPs	20130128
8	GET_CLEANSING_STAT_PARTS	Static method	Public	Method	Return all statistic parts which will be gathered	20130625
9	GET_DEFAULT_ALVL_NAME	Instance method	Public	Method	Determine the name of the generated ALVL	20130809
10	GET_PERFORMED_CLEANSING	Instance method	Public	Method	Returns all performed cleansing actions in detail	20130625
11	IS_NEW_NAME_VALID	Static method	Public	Method	Checks the name and proposes a new one, if needed	20130128
12	LOAD_AINX_FOR_RELOAD	Instance method	Public	Method	Load an AINX (to perform a reload for example)	20130128
13	PREPARE_WORKSPACE	Instance method	Protected	Method	Prepare the Workspace => Enqueue	20130625
14	RESET	Instance method	Public	Method	Reset all previously made settings to start over again.	20130128
15	SET_AINX_INPUTABLE	Instance method	Public	Method	Sets inputable flag of AINX for planning	20130529
16	SET_AUDITACTIVE	Instance method	Public	Method	Set Audit to active on planable AINX	20130925
17	SET_AUDITMODE	Instance method	Public	Method	Set Audit Mode on planable AINX.	20130925
18	SET_DATA_SETTINGS	Instance method	Public	Method	File: Set the data settings	20130128
19	SET_NAME_DESCR	Instance method	Public	Method	Define the name and the description of the AINX	20130128
20	TRANSFER_DATA	Instance method	Public	Method	File: Transfer the data	20130128
21	TRANSFER_XLS_FORMAT	Instance method	Public	Method	File: XLS - Transfer the format and int. properties	20130613
22	UPDATE_COLUMNS	Instance method	Public	Method	Update the columns with the users input	20130128

Events

Class CL_RSL_AO_AINX_HANDLER has no event.

Types

Class CL_RSL_AO_AINX_HANDLER 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	I_CREATING_CLIENT	Call by reference	☑	Type reference (TYPE)	STRING		Name of the creating client	20130613
2	Importing	I_EMPTY_PROV	Call by reference	☑	Type reference (TYPE)	RS_BOOL		Empty Provider	20130611
3	Importing	I_FORMAT_TYPE	Call by reference	☐	Type reference (TYPE)	STRING	CL_RSL_AO_AINX_HANDLER=>N_CS_FILETYPE-EXCEL	See CL_RSL_AO_AINX_HANDLER=>N_CS_FILETYPE	20130613
4	Importing	I_R_WSP	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSL_WSP		BWA Workspaces	20130128

Method CONSTRUCTOR on class CL_RSL_AO_AINX_HANDLER has no exception.

Method CREATE_AND_LOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	RS_BOOL		Boolean	20130128
2	Exporting	E_S_STATISTICS	Call by reference	☐	Type reference (TYPE)	RSL_UI_S_WSP_FILE_CLEANS_STAT		Workspace: File Upload - Cleansing Statistics	20130625
3	Exporting	E_T_MSG	Call by reference	☐	Type reference (TYPE)	RSL_T_RETMSG		Message Table TLOGO Framework	20130128
4	Exporting	E_WSP_LOCKED	Call by reference	☐	Type reference (TYPE)	RS_BOOL		Workspace is currently locked	20130625

Method CREATE_AND_LOAD on class CL_RSL_AO_AINX_HANDLER has no exception.

Method DELETE_AINX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	RS_BOOL		Error occured?	20130702
2	Exporting	E_T_MSG	Call by reference	☐	Type reference (TYPE)	RSL_T_RETMSG		Message Table TLOGO Framework	20130702
3	Importing	I_AINX_NAME	Call by reference	☐	Type reference (TYPE)	RSLTIPNAME		TransientProvider	20130702
4	Importing	I_COMMIT_WORK	Call by reference	☑	Type reference (TYPE)	RS_BOOL		Perform a COMMIT WORK	20130702

Method DELETE_AINX on class CL_RSL_AO_AINX_HANDLER has no exception.

Method DEQUEUE_WORKSPACE Signature

Method DEQUEUE_WORKSPACE on class CL_RSL_AO_AINX_HANDLER has no parameter.
Method DEQUEUE_WORKSPACE on class CL_RSL_AO_AINX_HANDLER has no exception.

Method DETERMINE_COLUMNS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	RS_BOOL			20130130
2	Exporting	E_T_COLUMNS	Call by reference	☐	Type reference (TYPE)	RSL_UI_T_PROVIDER_COLUMNS		Properties of Columns When Creating a Provider	20130128
3	Exporting	E_T_MSG	Call by reference	☐	Type reference (TYPE)	RSL_T_RETMSG			20130130
4	Importing	I_REDETERMINE	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_FALSE	Boolean	20130619

Method DETERMINE_COLUMNS on class CL_RSL_AO_AINX_HANDLER has no exception.

Method DETERMINE_INFOOBJECTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	RS_BOOL		Boolean	20130204
2	Exporting	E_T_INFOOBJECTS	Call by reference	☐	Type reference (TYPE)	RSL_T_AO_INFOOBJECTS		InfoObjects to be used by AO	20130204
3	Exporting	E_T_MSG	Call by reference	☐	Type reference (TYPE)	RSL_T_RETMSG		Message Table TLOGO Framework	20130204
4	Importing	I_PROV_ROLE	Call by reference	☐	Type reference (TYPE)	STRING		Provider Role (Central, Composite or Local)	20130204

Method DETERMINE_INFOOBJECTS on class CL_RSL_AO_AINX_HANDLER has no exception.

Method GET_AVAILABLE_DATA_TYPES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	RS_BOOL			20130130
2	Exporting	E_T_DATATYPES	Call by reference	☐	Type reference (TYPE)	RSL_T_AO_DATATYPES		Datatypes supported by BW Workspaces	20130131
3	Exporting	E_T_MSG	Call by reference	☐	Type reference (TYPE)	RSL_T_RETMSG			20130130

Method GET_AVAILABLE_DATA_TYPES on class CL_RSL_AO_AINX_HANDLER has no exception.

Method GET_CLEANSING_STAT_PARTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	RS_BOOL			20130625
2	Exporting	E_T_MSG	Call by reference	☐	Type reference (TYPE)	RSL_T_RETMSG			20130625
3	Exporting	E_T_PARTS	Call by reference	☐	Type reference (TYPE)	RSL_T_AO_CLEANS_STAT_PARTS		Statistical Parts supported by BW Workspaces	20130625

Method GET_CLEANSING_STAT_PARTS on class CL_RSL_AO_AINX_HANDLER has no exception.

Method GET_DEFAULT_ALVL_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ALVL_NAME	Call by reference	☐	Type reference (TYPE)	RSPLS_AGGRLEVEL		Planning: Aggregation Level	20130809
2	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	RS_BOOL		Error occured -> E_T_MSG filled	20130809
3	Exporting	E_T_MSG	Call by reference	☐	Type reference (TYPE)	RSL_T_RETMSG		Message Table TLOGO Framework	20130809

Method GET_DEFAULT_ALVL_NAME on class CL_RSL_AO_AINX_HANDLER has no exception.

Method GET_PERFORMED_CLEANSING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	RS_BOOL		Boolean	20130625
2	Exporting	E_T_MSG	Call by reference	☐	Type reference (TYPE)	RSL_T_RETMSG		Message Table TLOGO Framework	20130625
3	Exporting	E_T_PERFORMED_ACTIONS	Call by reference	☐	Type reference (TYPE)	RSL_UI_T_WSP_FILE_CLEANS_ACT_D		Workspace: File Upload - Performed Cleansing Actions	20130625
4	Importing	I_ACTION	Call by reference	☑	Type reference (TYPE)	RSL_UI_CLEANS_STAT_PARTS		Data Cleansing Actions During Upload	20130625

Method GET_PERFORMED_CLEANSING on class CL_RSL_AO_AINX_HANDLER has no exception.

Method IS_NEW_NAME_VALID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	RS_BOOL			20130130
2	Exporting	E_NAMING_PROPOSAL	Call by reference	☐	Type reference (TYPE)	RSLTIPNAME		Proposed name, if I_PROVIDER_NAME already exists	20130128
3	Exporting	E_T_MSG	Call by reference	☐	Type reference (TYPE)	RSL_T_RETMSG			20130130
4	Exporting	E_VALID	Call by reference	☐	Type reference (TYPE)	RS_BOOL		Name is valid	20130128
5	Importing	I_PROVIDER_NAME	Call by reference	☐	Type reference (TYPE)	RSLTIPNAME		TransientProvider	20130128

Method IS_NEW_NAME_VALID on class CL_RSL_AO_AINX_HANDLER has no exception.

Method LOAD_AINX_FOR_RELOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_AINX_LOCKED	Call by reference	☐	Type reference (TYPE)	RS_BOOL		AINX is already locked	20130625
2	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	RS_BOOL		Boolean	20130128
3	Exporting	E_T_MSG	Call by reference	☐	Type reference (TYPE)	RSL_T_RETMSG		Message Table TLOGO Framework	20130128
4	Importing	I_PROVIDER_NAME	Call by reference	☐	Type reference (TYPE)	RSLTIPNAME		TransientProvider	20130128

Method LOAD_AINX_FOR_RELOAD on class CL_RSL_AO_AINX_HANDLER has no exception.

Method PREPARE_WORKSPACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	RS_BOOL		Boolean	20130625
2	Exporting	E_T_MSG	Call by reference	☐	Type reference (TYPE)	RSL_T_RETMSG		Message Table TLOGO Framework	20130625
3	Exporting	E_WSP_ALREADY_LOCKED	Call by reference	☐	Type reference (TYPE)	RS_BOOL		WSP is already locked	20130625

Method PREPARE_WORKSPACE on class CL_RSL_AO_AINX_HANDLER has no exception.

Method RESET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	RS_BOOL		Boolean	20130128
2	Exporting	E_T_MSG	Call by reference	☐	Type reference (TYPE)	RSL_T_RETMSG		Message Table TLOGO Framework	20130128

Method RESET on class CL_RSL_AO_AINX_HANDLER has no exception.

Method SET_AINX_INPUTABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ALVL_NAME	Value transfer	☐	Type reference (TYPE)	RSPLS_AGGRLEVEL		Planning: Aggregation Level	20130620
2	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	RS_BOOL			20130613
3	Exporting	E_QUERY_NAME	Call by reference	☐	Type reference (TYPE)	RSZCOMPID		InfoProvider	20130620
4	Exporting	E_T_MSG	Call by reference	☐	Type reference (TYPE)	RSL_T_RETMSG		Message Table TLOGO Framework	20130612
5	Importing	I_INPUTABLE	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_TRUE	inputable Flag	20130529

Method SET_AINX_INPUTABLE on class CL_RSL_AO_AINX_HANDLER has no exception.

Method SET_AUDITACTIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	RS_BOOL		Boolean	20130925
2	Exporting	E_T_MSG	Call by reference	☐	Type reference (TYPE)	RSL_T_RETMSG		Message Table TLOGO Framework	20130925
3	Importing	I_AUDITACTIVE	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_TRUE	Boolean	20130925

Method SET_AUDITACTIVE on class CL_RSL_AO_AINX_HANDLER has no exception.

Method SET_AUDITMODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	RS_BOOL		Boolean	20130925
2	Exporting	E_T_MSG	Call by reference	☐	Type reference (TYPE)	RSL_T_RETMSG		Message Table TLOGO Framework	20130925
3	Importing	I_AUDITMODE	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_TRUE	Boolean	20130925

Method SET_AUDITMODE on class CL_RSL_AO_AINX_HANDLER has no exception.

Method SET_DATA_SETTINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	RS_BOOL			20130130
2	Exporting	E_T_MSG	Call by reference	☐	Type reference (TYPE)	RSL_T_RETMSG			20130130
3	Importing	I_DATE_FORMAT	Call by reference	☑	Type reference (TYPE)	XUDATFM		Date format	20130128
4	Importing	I_DEC_DELIMITER	Call by reference	☑	Type reference (TYPE)	RSL_UI_DECIMAL_DELIMITER		Decimal Point	20130128
5	Importing	I_DELIMITER	Call by reference	☑	Type reference (TYPE)	CHAR1		Single-Character Flag	20130128
6	Importing	I_ENCODING	Call by reference	☑	Type reference (TYPE)	ABAP_ENCOD		Identifier for Character Format (UTF-8, UCS-2, ...)	20130128
7	Importing	I_FIRST_DATA_ROW	Call by reference	☑	Type reference (TYPE)	I			20130128
8	Importing	I_HEADER_ROW	Call by reference	☑	Type reference (TYPE)	I			20130128
9	Importing	I_SEPARATOR	Call by reference	☑	Type reference (TYPE)	CHAR1		Single-Character Flag	20130128

Method SET_DATA_SETTINGS on class CL_RSL_AO_AINX_HANDLER has no exception.

Method SET_NAME_DESCR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	RS_BOOL		Boolean	20130128
2	Exporting	E_PROPOSAL	Call by reference	☐	Type reference (TYPE)	RSLTIPNAME		TransientProvider	20130128
3	Exporting	E_T_MSG	Call by reference	☐	Type reference (TYPE)	RSL_T_RETMSG		Message Table TLOGO Framework	20130128
4	Importing	I_DESCRIPTION	Call by reference	☑	Type reference (TYPE)	STRING		Description	20130128
5	Importing	I_NAME	Call by reference	☑	Type reference (TYPE)	RSLTIPNAME		TransientProvider	20130128

Method SET_NAME_DESCR on class CL_RSL_AO_AINX_HANDLER has no exception.

Method TRANSFER_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	RS_BOOL		Boolean	20130128
2	Exporting	E_T_MSG	Call by reference	☐	Type reference (TYPE)	RSL_T_RETMSG		Message Table TLOGO Framework	20130128
3	Importing	I_FILEDATA	Call by reference	☐	Type reference (TYPE)	ANY			20130613

Method TRANSFER_DATA on class CL_RSL_AO_AINX_HANDLER has no exception.

Method TRANSFER_XLS_FORMAT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	RS_BOOL		Boolean	20130613
2	Exporting	E_T_MSG	Call by reference	☐	Type reference (TYPE)	RSL_T_RETMSG		Message Table TLOGO Framework	20130613
3	Importing	I_S_INT_PROPS	Call by reference	☐	Type reference (TYPE)	IF_RSL_UI_DEFINITIONS=>GT_S_XLS_INT_PROPS			20130613
4	Importing	I_T_FORMATS	Call by reference	☐	Type reference (TYPE)	IF_WDR_ACF_HNDL=>TT_ACF_TABLE_LINE			20130613
5	Importing	I_T_TYPES	Call by reference	☐	Type reference (TYPE)	IF_WDR_ACF_HNDL=>TT_ACF_TABLE_LINE			20130613

Method TRANSFER_XLS_FORMAT on class CL_RSL_AO_AINX_HANDLER has no exception.

Method UPDATE_COLUMNS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	RS_BOOL		Boolean	20130128
2	Exporting	E_T_MSG	Call by reference	☐	Type reference (TYPE)	RSL_T_RETMSG		Message Table TLOGO Framework	20130128
3	Importing	I_NO_CHECKS	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_FALSE	Overwrite previously determined information	20130619
4	Importing	I_T_COLUMNS	Call by reference	☐	Type reference (TYPE)	RSL_UI_T_PROVIDER_COLUMNS		Properties of Columns When Creating a Provider	20130128

Method UPDATE_COLUMNS on class CL_RSL_AO_AINX_HANDLER has no exception.

History

Last changed by/on	SAP	20140121
SAP Release Created in	740