SAP ABAP Class CL_ILM_SPOOL_PAR (ILM Spool Settings)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ILM-RSE (Application Component) Technical reuse
     ⤷ S_ARC_ILM_GENERAL (Package) General ILM Functions and Objects

Properties

Class	CL_ILM_SPOOL_PAR
Short Description	ILM Spool Settings
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ARC_ILM_GENERAL	General ILM Functions and Objects
Created	20130131	SAP
Last change	20140121	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_ILM_SPOOL_PAR has no forward declaration.

Interfaces

Class CL_ILM_SPOOL_PAR has no interface implemented.

Friends

Class CL_ILM_SPOOL_PAR has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_OBJ_KIND_ARCHIVING_OBJECT	Constant	Public	☐	Type reference (TYPE)	ILM_OBJECT_KIND	'A'	Archiving Object	20130131
2	GC_OBJ_KIND_DATA_DESTR_OBJECT	Constant	Public	☐	Type reference (TYPE)	ILM_OBJECT_KIND	'D'		20130131

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_OBJECT	Static method	Private	Method		20130131
2	DELETE_ILM_SPOOL_CUSTOMIZING	Static method	Public	Method	Delete ILM Customizing Record	20130131
3	GET_COMPONENTS	Static method	Private	Method		20130131
4	GET_ILM_SPOOL_CUSTOMIZING	Static method	Public	Method	Read ILM Customizing Record	20130131
5	GET_ILM_SPOOL_DEFAULT	Static method	Public	Method	Read Current ILM Default	20130201
6	GET_ILM_SPOOL_PARAMETERS	Static method	Public	Method	Read Spool Parameter for Print Job	20130131
7	GET_OBJECT_TEXT	Static method	Private	Method	Read ILM Customizing Record	20130201
8	PARAMS_CONVERT_STRUC_2_TAB	Static method	Public	Method	Spool Parameter Conversion: Spool Format -> ILM Format	20130131
9	PARAMS_CONVERT_TAB_2_STRUC	Static method	Private	Method	Spool Parameter Conversion: ILM Format -> Spool Format	20130131
10	RAISE_EXCEPTION	Static method	Private	Method		20130131
11	SET_ILM_SPOOL_CUSTOMIZING	Static method	Public	Method	Set ILM Customizing Record	20130131
12	SET_ILM_SPOOL_PARAM	Static method	Private	Method	Set Spool Parameters	20130131

Events

Class CL_ILM_SPOOL_PAR has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_S_SPOOL_PAR	Public	See coding			20130131	BEGIN OF ty_s_spool_par, pri TYPE pri_params, arc TYPE arc_params, END OF ty_s_spool_par
2	TY_S_SPOOL_PARAM	Public	See coding			20130131	BEGIN OF ty_s_spool_param, name TYPE ilm_spool_param_name, value TYPE ilm_spool_param_value, END OF ty_s_spool_param
3	TY_S_SPOOL_PARAM_SET	Public	See coding			20130131	BEGIN OF ty_s_spool_param_set, object_name TYPE ilm_object_name, object_kind TYPE ilm_object_kind, params TYPE ty_t_spool_param, END OF ty_s_spool_param_set
4	TY_T_SPOOL_PARAM	Public	See coding			20130131	ty_t_spool_param TYPE SORTED TABLE OF ty_s_spool_param WITH UNIQUE KEY name

Method Signatures

Method CHECK_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_OBJECT_KIND	Call by reference	☐	Type reference (TYPE)	ILM_OBJECT_KIND		Objektart	20130131
2	Importing	IV_OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	ILM_OBJECT_NAME		Objektname	20130131

#	Exception	Resumable	Description	Created on
1	CX_ILM_T100	☐	ILM#	20130201

Method DELETE_ILM_SPOOL_CUSTOMIZING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_OBJECT_KIND	Call by reference	☐	Type reference (TYPE)	ILM_OBJECT_KIND		Objektart	20130131
2	Importing	IV_OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	ILM_OBJECT_NAME		Objektname	20130131
3	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	TY_T_SPOOL_PARAM		Spool-Parameter	20130131

Method DELETE_ILM_SPOOL_CUSTOMIZING on class CL_ILM_SPOOL_PAR has no exception.

Method GET_COMPONENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_STRUCTDESCR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR		Run Time Type Services	20130131
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_COMPONENT_TAB			20130131

Method GET_COMPONENTS on class CL_ILM_SPOOL_PAR has no exception.

Method GET_ILM_SPOOL_CUSTOMIZING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_OBJECT_KIND	Call by reference	☐	Type reference (TYPE)	ILM_OBJECT_KIND		Objektart	20130131
2	Importing	IV_OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	ILM_OBJECT_NAME		Objektname	20130131
3	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	TY_T_SPOOL_PARAM		Spool-Parameter	20130131

Method GET_ILM_SPOOL_CUSTOMIZING on class CL_ILM_SPOOL_PAR has no exception.

Method GET_ILM_SPOOL_DEFAULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_OBJECT_KIND	Call by reference	☐	Type reference (TYPE)	ILM_OBJECT_KIND		Objektart	20130201
2	Importing	IV_OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	ILM_OBJECT_NAME		Objektname	20130201
3	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	TY_T_SPOOL_PARAM			20130201

Method GET_ILM_SPOOL_DEFAULT on class CL_ILM_SPOOL_PAR has no exception.

Method GET_ILM_SPOOL_PARAMETERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_ARCHIVE_PARAMETERS	Call by reference	☐	Type reference (TYPE)	ARC_PARAMS		Struktur zur Übergabe von Archivierungsparametern	20130131
2	Exporting	ES_PRINT_PARAMETERS	Call by reference	☐	Type reference (TYPE)	PRI_PARAMS		Struktur zur Übergabe von Archivierungsparametern	20130131
3	Importing	IT_SPOOL_PARAMETERS	Call by reference	☑	Type reference (TYPE)	TY_T_SPOOL_PARAM		Spool-Parameter	20130131
4	Importing	IV_OBJECT_KIND	Call by reference	☐	Type reference (TYPE)	ILM_OBJECT_KIND		Objektart	20130131
5	Importing	IV_OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	ILM_OBJECT_NAME		Objektname	20130131
6	Importing	IV_REPORT	Call by reference	☑	Type reference (TYPE)	SYREPID		ABAP-Programm	20130131
7	Importing	IV_USER	Call by reference	☑	Type reference (TYPE)	SYST_UNAME		ABAP-Systemfeld: Name des aktuellen Benutzers	20130415

#	Exception	Resumable	Description	Created on
1	CX_ILM_T100	☐	ILM#	20130201

Method GET_OBJECT_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_OBJECT_KIND	Call by reference	☐	Type reference (TYPE)	ILM_OBJECT_KIND		Objektart	20130201
2	Importing	IV_OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	ILM_OBJECT_NAME		Objektname	20130201
3	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	STRING			20130201

Method GET_OBJECT_TEXT on class CL_ILM_SPOOL_PAR has no exception.

Method PARAMS_CONVERT_STRUC_2_TAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_PARAM	Call by reference	☐	Type reference (TYPE)	TY_S_SPOOL_PAR			20130131
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	TY_T_SPOOL_PARAM			20130131

Method PARAMS_CONVERT_STRUC_2_TAB on class CL_ILM_SPOOL_PAR has no exception.

Method PARAMS_CONVERT_TAB_2_STRUC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_PARAM	Call by reference	☐	Type reference (TYPE)	TY_T_SPOOL_PARAM			20130131
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	TY_S_SPOOL_PAR			20130131

Method PARAMS_CONVERT_TAB_2_STRUC on class CL_ILM_SPOOL_PAR has no exception.

Method RAISE_EXCEPTION Signature

Method RAISE_EXCEPTION on class CL_ILM_SPOOL_PAR has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_ILM_T100	☐	ILM#	20130201

Method SET_ILM_SPOOL_CUSTOMIZING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_SPOOL_PARAMETER_SET	Call by reference	☐	Type reference (TYPE)	TY_S_SPOOL_PARAM_SET			20130131

Method SET_ILM_SPOOL_CUSTOMIZING on class CL_ILM_SPOOL_PAR has no exception.

Method SET_ILM_SPOOL_PARAM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_SPOOL_PARAMETER	Call by reference	☐	Type reference (TYPE)	ILM_T_SPOOL_PAR		ILM Spool-Parameter	20130131

Method SET_ILM_SPOOL_PARAM on class CL_ILM_SPOOL_PAR has no exception.

History

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