SAP ABAP Class CL_PAL_SERVICES (Services for PAL)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-CCM-PRN (Application Component) Print and Output Management
     ⤷ SPCPC (Package) Central Printer Configuration

Properties

Class	CL_PAL_SERVICES
Short Description	Services for PAL
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SPCPC	Central Printer Configuration
Created	20100531	SAP
Last change	20130531	SAP
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

Class CL_PAL_SERVICES has no interface implemented.

Friends

Class CL_PAL_SERVICES has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_DB_WCARD	Constant	Public	☐	Type reference (TYPE)	C	'%'	Wildcard for DB	20100608
2	CO_ERROR_AUTHORITY_FAILED	Constant	Public	☐	Type reference (TYPE)	I	3076		20100813
3	CO_ERROR_CANNOT_ACCESS_DB	Constant	Public	☐	Type reference (TYPE)	I	3063		20100722
4	CO_ERROR_CANNOT_ADD_TSG_FAV	Constant	Public	☐	Type reference (TYPE)	I	3053		20100709
5	CO_ERROR_CANNOT_DELETE_TS	Constant	Public	☐	Type reference (TYPE)	I	3033		20100816
6	CO_ERROR_CANNOT_DEL_TSG_FAV	Constant	Public	☐	Type reference (TYPE)	I	3083		20100709
7	CO_ERROR_CANNOT_LOCK	Constant	Public	☐	Type reference (TYPE)	I	3060		20100707
8	CO_ERROR_CANNOT_LOCK_FOREIGN	Constant	Public	☐	Type reference (TYPE)	I	3061		20100707
9	CO_ERROR_CANNOT_LOCK_SYSTEM	Constant	Public	☐	Type reference (TYPE)	I	3062		20100707
10	CO_ERROR_CANNOT_UNLOCK	Constant	Public	☐	Type reference (TYPE)	I	3065		20100709
11	CO_ERROR_CANNOT_UNLOCK_FOREIGN	Constant	Public	☐	Type reference (TYPE)	I	3066		20100709
12	CO_ERROR_CANNOT_UNLOCK_SYSTEM	Constant	Public	☐	Type reference (TYPE)	I	3067		20100709
13	CO_ERROR_COMMUNICATION	Constant	Public	☐	Type reference (TYPE)	I	3077		20100813
14	CO_ERROR_IN_USE_TS	Constant	Public	☐	Type reference (TYPE)	I	3023		20100816
15	CO_ERROR_NOT_EXIST_PG	Constant	Public	☐	Type reference (TYPE)	I	3012		20100707
16	CO_ERROR_NOT_EXIST_TS	Constant	Public	☐	Type reference (TYPE)	I	3013		20100816
17	CO_ERROR_NOT_EXIST_TSG	Constant	Public	☐	Type reference (TYPE)	I	3014		20100716
18	CO_PRINTER_TO_BE_DISTRIBUTED	Constant	Public	☐	Type reference (TYPE)	I	1000		20100706
19	CO_RC_OK	Constant	Public	☐	Type reference (TYPE)	I	0		20100706
20	CO_RFC_ERROR	Constant	Private	☐	Type reference (TYPE)	I	3093		20100816
21	CO_STATUS_DIST_FAILURE	Constant	Public	☐	Type reference (TYPE)	I	2	Status codes used in table TSPCPCDSE	20100531
22	CO_STATUS_DIST_SUCCESSFUL	Constant	Public	☐	Type reference (TYPE)	I	1	Status codes used in table TSPCPCDSE	20100531
23	CO_STATUS_REMOVE_FAILED	Constant	Public	☐	Type reference (TYPE)	I	4	Status codes used in table TSPCPCDSE	20100531
24	CO_STATUS_TO_BE_DISTRIBUTED	Constant	Public	☐	Type reference (TYPE)	I	0	Status codes used in table TSPCPCDSE	20100531
25	CO_STATUS_TO_BE_REMOVED	Constant	Public	☐	Type reference (TYPE)	I	3	Status codes used in table TSPCPCDSE	20100531
26	CO_STATUS_TO_BE_UPDATED	Constant	Public	☐	Type reference (TYPE)	I	5	Status codes used in table TSPCPCDSE	20100531
27	CO_UI_WCARD	Constant	Public	☐	Type reference (TYPE)	C	'*'	Wildcard for DB	20100712
28	GT_PRINTER_STATUS	Static Attribute	Private	☐	Type reference (TYPE)	TY_PRINTER_STATUS_TAB			20100606
29	GT_PRINTER_TSPCPCPGC	Static Attribute	Private	☐	Type reference (TYPE)	TY_PRINTER_TSPCPCPGC_TAB			20100606
30	GT_TS_STATUS	Static Attribute	Private	☐	Type reference (TYPE)	TY_TS_STATUS_TAB			20100607
31	GT_TS_TSPCPCTSGC	Static Attribute	Private	☐	Type reference (TYPE)	TY_TS_TSPCPCTSGC_TAB			20100607

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_RFC_STATUS	Static method	Public	Method	Check status of RFC connection	20100816
2	CHECK_TS	Static method	Public	Method	Check whether the Target System can be deleted	20100816
3	COMPARE_FIELDS_CONTENT	Static method	Public	Method	Filter internal table	20100713
4	DELETE_TS	Static method	Public	Method	Delete Target System without checking	20100816
5	DOES_PG_EXIST	Static method	Public	Method	Does Printer Group exist	20100708
6	DOES_TSG_EXIST	Static method	Public	Method	Does Printer Group exist	20100716
7	GET_ACC_METHOD_BY_PRINTER	Static method	Public	Method	Get Access Method of Printer	20100707
8	GET_PRINTER_BY_PRG	Static method	Public	Method	Get members of Printer Group from TSPCPCPGC	20100706
9	GET_TS_BY_TSG	Static method	Public	Method	Get members of Target System Group from TSPCPCTSGC	20100706
10	IS_PRINTER_DISTRIBUTED	Static method	Public	Method	Has Printer been distributed	20100531
11	IS_PRINTER_IN_GROUP	Static method	Public	Method	Is Printer a member of any Printer Group	20100531
12	IS_PRINTER_IN_USE	Static method	Public	Method	Is Printer a member of any PRG or has been distributed	20100616
13	IS_TS_IN_DIST	Static method	Public	Method	Is Target System found in distribution status	20100616
14	IS_TS_IN_GROUP	Static method	Public	Method	Is Target System a member of any Target System Group	20100531
15	IS_TS_IN_USE	Static method	Public	Method	Is Target System a member of any TSG or in distribution	20100616
16	LOCK_DB	Static method	Public	Method	Lock DB	20100707
17	MODIFY_PG	Static method	Public	Method	MOdify Printer Group	20100720
18	UNLOCK_DB	Static method	Public	Method	Unlock DB	20100709
19	WRITE_TRACE	Static method	Private	Method	write trace entry with trace level 2	20120309

Events

Class CL_PAL_SERVICES has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_PRINTER_STATUS	Public	See coding			20100606	BEGIN OF TY_PRINTER_STATUS, pname TYPE SPCPCPNAME, DIST_STATUS TYPE TSPCPCDSE-dist_status, END OF ty_printer_status
2	TY_PRINTER_STATUS_TAB	Public	See coding			20100606	TY_PRINTER_STATUS_TAB TYPE HASHED TABLE OF ty_printer_status WITH UNIQUE KEY pname dist_status WITH NON-UNIQUE SORTED KEY k1 COMPONENTS pname
3	TY_PRINTER_TSPCPCPGC	Public	See coding			20100606	BEGIN OF TY_PRINTER_TSPCPCPGC, pname TYPE SPCPCPNAME, END OF TY_PRINTER_TSPCPCPGC
4	TY_PRINTER_TSPCPCPGC_TAB	Public	See coding			20100606	TY_PRINTER_TSPCPCPGC_TAB TYPE HASHED TABLE OF TY_PRINTER_TSPCPCPGC WITH UNIQUE KEY pname
5	TY_TS_STATUS	Public	See coding			20100607	BEGIN OF TY_TS_STATUS, tsname TYPE SPCPCTSNAME, DIST_STATUS TYPE TSPCPCDSE-dist_status, END OF TY_TS_STATUS
6	TY_TS_STATUS_TAB	Public	See coding			20100607	TY_TS_STATUS_TAB TYPE HASHED TABLE OF ty_ts_status WITH UNIQUE KEY tsname dist_status WITH NON-UNIQUE SORTED KEY k1 COMPONENTS tsname
7	TY_TS_TSPCPCTSGC	Public	See coding			20100607	BEGIN OF TY_TS_TSPCPCTSGC, tsname TYPE SPCPCTSNAME, END OF TY_TS_TSPCPCTSGC
8	TY_TS_TSPCPCTSGC_TAB	Public	See coding			20100607	TY_TS_TSPCPCTSGC_TAB TYPE HASHED TABLE OF TY_TS_TSPCPCTSGC WITH UNIQUE KEY tsname

Method Signatures

Method CHECK_RFC_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_RFC_DEST	Call by reference	☐	Type reference (TYPE)	RFCDEST		Logical Destination (Specified in Function Call)	20100816
2	Returning	RV_RETURN_CODE	Value transfer	☐	Type reference (TYPE)	SPCPC_RETURN_CODE		Return Code	20100816

Method CHECK_RFC_STATUS on class CL_PAL_SERVICES has no exception.

Method CHECK_TS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TS_ID	Call by reference	☐	Type reference (TYPE)	SPCPC_TS_ID		ID of CPC target system	20100816
2	Returning	RV_RETURN_CODE	Value transfer	☐	Type reference (TYPE)	SPCPC_RETURN_CODE		Return Code	20100816

Method CHECK_TS on class CL_PAL_SERVICES has no exception.

Method COMPARE_FIELDS_CONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_DFIES	Call by reference	☐	Type reference (TYPE)	DDFIELDS		DD: Field List	20100713
2	Importing	IV_COMPARE	Call by reference	☐	Type reference (TYPE)	ANY			20100713
3	Importing	IV_SOURCE	Call by reference	☐	Type reference (TYPE)	ANY			20100713
4	Returning	RV_CONTAIN	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20100713

Method COMPARE_FIELDS_CONTENT on class CL_PAL_SERVICES has no exception.

Method DELETE_TS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TS_ID	Call by reference	☐	Type reference (TYPE)	SPCPC_TS_ID		ID of CPC target system	20100816
2	Returning	RV_RETURN_CODE	Value transfer	☐	Type reference (TYPE)	SPCPC_RETURN_CODE		Return Code	20100816

Method DELETE_TS on class CL_PAL_SERVICES has no exception.

Method DOES_PG_EXIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PG_NAME	Call by reference	☐	Type reference (TYPE)	SPCPCPGNAME		Printer group name	20100708
2	Returning	RV_EXIST	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20100708

Method DOES_PG_EXIST on class CL_PAL_SERVICES has no exception.

Method DOES_TSG_EXIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TSG_NAME	Call by reference	☐	Type reference (TYPE)	SPCPCTSGNAME		Printer group name	20100716
2	Returning	RV_EXIST	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20100716

Method DOES_TSG_EXIST on class CL_PAL_SERVICES has no exception.

Method GET_ACC_METHOD_BY_PRINTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PRINTER	Call by reference	☐	Type reference (TYPE)	SPCPCPNAME		Printer name for CPC printer	20100707
2	Returning	RV_ACC_METHOD	Value transfer	☐	Type reference (TYPE)	RSPOPAMETH		Spool: Host spool system access method	20100707

Method GET_ACC_METHOD_BY_PRINTER on class CL_PAL_SERVICES has no exception.

Method GET_PRINTER_BY_PRG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PG_NAME	Call by reference	☐	Type reference (TYPE)	SPCPCPGNAME		Printer group name	20100708
2	Returning	RT_PRINTER	Value transfer	☐	Type reference (TYPE)	SPCPC_PRINTER_GRP_CONFIG_TABLE		Table type of printer group configuration	20100706

#	Exception	Resumable	Description	Created on
1	CX_PAL_CONFIG	☐	Exception for PAL	20100706

Method GET_TS_BY_TSG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TSG_NAME	Call by reference	☐	Type reference (TYPE)	SPCPCTSGNAME		Target system name	20100706
2	Returning	RT_TS	Value transfer	☐	Type reference (TYPE)	SPCPC_TSG_CONFIG_TABLE		Table type of target system group configuration	20100706

Method GET_TS_BY_TSG on class CL_PAL_SERVICES has no exception.

Method IS_PRINTER_DISTRIBUTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CACHE_ALL_PRINTER	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20100606
2	Importing	IV_DELETE_CACHE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20110222
3	Importing	IV_PRINTER	Call by reference	☐	Type reference (TYPE)	SPCPCPNAME		Printer name for CPC printer	20100531
4	Returning	RV_IN_DIST_STATUS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Return Value of ABAP Statements	20100531

Method IS_PRINTER_DISTRIBUTED on class CL_PAL_SERVICES has no exception.

Method IS_PRINTER_IN_GROUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CACHE_ALL_PRINTER	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20100606
2	Importing	IV_DELETE_CACHE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20110222
3	Importing	IV_PRINTER	Call by reference	☐	Type reference (TYPE)	SPCPCPNAME		Printer name for CPC printer	20100531
4	Returning	RV_IN_GROUP	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Return Value of ABAP Statements	20100531

Method IS_PRINTER_IN_GROUP on class CL_PAL_SERVICES has no exception.

Method IS_PRINTER_IN_USE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CACHE_ALL_PRINTER	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20100616
2	Importing	IV_DELETE_CACHE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20110222
3	Importing	IV_PRINTER	Call by reference	☐	Type reference (TYPE)	SPCPCPNAME		Printer name for CPC printer	20100616
4	Returning	RV_IN_USE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20100616

Method IS_PRINTER_IN_USE on class CL_PAL_SERVICES has no exception.

Method IS_TS_IN_DIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CACHE_ALL_TS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20100616
2	Importing	IV_DELETE_CACHE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20110222
3	Importing	IV_TS_NAME	Call by reference	☐	Type reference (TYPE)	SPCPCTSNAME		Target system name	20100616
4	Returning	RV_IN_DIST_STATUS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Return Value of ABAP Statements	20100616

Method IS_TS_IN_DIST on class CL_PAL_SERVICES has no exception.

Method IS_TS_IN_GROUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CACHE_ALL_TS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20100607
2	Importing	IV_DELETE_CACHE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20110222
3	Importing	IV_TS_NAME	Call by reference	☐	Type reference (TYPE)	SPCPCTSNAME		Target system name	20100531
4	Returning	RV_IN_GROUP	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Return Value of ABAP Statements	20100531

Method IS_TS_IN_GROUP on class CL_PAL_SERVICES has no exception.

Method IS_TS_IN_USE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CACHE_ALL_TS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20100616
2	Importing	IV_DELETE_CACHE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20110222
3	Importing	IV_TS_NAME	Call by reference	☐	Type reference (TYPE)	SPCPCTSNAME		Target system name	20100616
4	Returning	RV_IN_USE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20100616

Method IS_TS_IN_USE on class CL_PAL_SERVICES has no exception.

Method LOCK_DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RETURN_CODE	Value transfer	☐	Type reference (TYPE)	SPCPC_RETURN_CODE		Return Code	20100707

Method LOCK_DB on class CL_PAL_SERVICES has no exception.

Method MODIFY_PG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PG_NAME	Call by reference	☐	Type reference (TYPE)	SPCPCPGNAME		Printer group name	20100720
2	Returning	RV_RETURN_CODE	Value transfer	☐	Type reference (TYPE)	SPCPC_RETURN_CODE		Return Code	20100720

Method MODIFY_PG on class CL_PAL_SERVICES has no exception.

Method UNLOCK_DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RETURN_CODE	Value transfer	☐	Type reference (TYPE)	SPCPC_RETURN_CODE		Return Code	20100709

Method UNLOCK_DB on class CL_PAL_SERVICES has no exception.

Method WRITE_TRACE Signature

Method WRITE_TRACE on class CL_PAL_SERVICES has no parameter.
Method WRITE_TRACE on class CL_PAL_SERVICES has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	703