SAP ABAP Class CL_PLANNER (Appointment Management: Planning Interface)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-GBT-CAL (Application Component) Appointment Calendar
     ⤷ SZTK (Package) R/3 Central Basis Development: Appointment Calendar

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_PLANNING_FREE_BUSY_READER	Appointment Management: Data Collection for Planning Control	20000209

Properties

Class	CL_PLANNER
Short Description	Appointment Management: Planning Interface
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SZTK	R/3 Central Basis Development: Appointment Calendar
Created	20000209	SAP
Last change	20090618	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CNTL	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	SCCON	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
3	SCSTP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_PLANNING_FREE_BUSY_READER	☐	☐	Appointment Management: Data Collection for Planning Control	20000209

Friends

Class CL_PLANNER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	APPT_DURATION	Instance attribute	Private	☐	Type reference (TYPE)	SCSTP_TIMEDIFF		Duration of Appointment in Seconds	20000209
2	BACKGROUND_COLOR	Instance attribute	Private	☐	Type reference (TYPE)	LVC_COL		ALV control: Color	20000313
3	CONTAINER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Container for Planning Control	20000209
4	DAILY_TIME_FROM	Instance attribute	Private	☐	Type reference (TYPE)	TIMS		Display Days From Time	20000225
5	DAILY_TIME_TO	Instance attribute	Private	☐	Type reference (TYPE)	TIMS		Display Days To Time	20000225
6	DATE_FROM	Instance attribute	Private	☐	Type reference (TYPE)	SC_DATEFRO		Start Date of Selection Interval	20000209
7	DATE_TO	Instance attribute	Private	☐	Type reference (TYPE)	SC_DATETO		End Date of Selection Interval	20000209
8	DISPLAY_MODE	Instance attribute	Private	☐	Type reference (TYPE)	SC_FLAG		Display Mode, Events Are Still Sent	20000810
9	EVT_PARTICIPANT_ADDED	Constant	Public	☐	Type reference (TYPE)	I	3	Add Participants	20000814
10	EVT_PARTICIPANT_DELETED	Constant	Public	☐	Type reference (TYPE)	I	2	Delete Participants	20000810
11	EVT_PARTICIPANT_SELECTED	Constant	Public	☐	Type reference (TYPE)	I	1	Double-Click on a Participant	20000808
12	FBPART_CNTL_MAP_TAB	Instance attribute	Private	☐	Type reference (TYPE)	TTP_FBPART_CNTL_MAP_TAB		Mapping Table for Participant ID in Control	20000811
13	INCLUDE_ORG_APPOINTMENTS	Instance attribute	Private	☐	Type reference (TYPE)	FLAG		Also Select Appts. from Associated Org. Units for Particips.	20010125
14	MEETING_TIMES_COUNTER	Instance attribute	Private	☐	Type reference (TYPE)	I		Number of Appointment Proposals to Find	20000209
15	MEETING_TSTFRAMES	Instance attribute	Private	☐	Type reference (TYPE)	SCSTSTFRMTAB		Times Without Appointments	20000229
16	NO_AUTHORIZATION_CHECK	Instance attribute	Private	☐	Type reference (TYPE)	FLAG		Authorization Check Not Performed	20010124
17	NO_CONDENSED_DATA	Instance attribute	Private	☐	Type reference (TYPE)	FLAG		Do Not Display Condensed Line for All Participants	20000222
18	NO_MEETING_TIMES	Instance attribute	Private	☐	Type reference (TYPE)	FLAG		No Appointment Proposals	20000313
19	ORIGINAL_APPT_ID	Instance attribute	Private	☐	Type reference (TYPE)	SC_APPTID		General appointment ID	20060203
20	ORIGINAL_GENAPPT_ID	Instance attribute	Private	☐	Type reference (TYPE)	SC_GENAPPT		Generated appointment ID	20060203
21	PLANNING_CONTROL	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_PLANNING_CONTROL		Planning Control Interface	20000209
22	REGISTERED_EVENTS	Instance attribute	Private	☐	Type reference (TYPE)	SCSTP_EVENT_TAB		Results table	20000808
23	SEARCH_DATE_FROM	Instance attribute	Private	☐	Type reference (TYPE)	DATS		Start Date for Appointment Search	20000901
24	SEARCH_INTERVAL	Instance attribute	Private	☐	Type reference (TYPE)	SCSTP_TIMEDIFF		Display Interval	20000901
25	SEARCH_TIME_FROM	Instance attribute	Private	☐	Type reference (TYPE)	TIMS		Start Time for Appointment Search	20000901
26	SELECT_INPUT	Instance attribute	Private	☐	See coding			References to Free/Busy Participants	20000209
27	SHIFT_PLAN_AVAILABLE	Instance attribute	Private	☐	Type reference (TYPE)	SC_FLAG		Indicator	20000605
28	TIMEZONE	Instance attribute	Private	☐	Type reference (TYPE)	TIMEZONE		Time Zone Used for the Display	20000209
29	TIME_FROM	Instance attribute	Private	☐	Type reference (TYPE)	SC_TIMEFRO		Start Time of Selection Interval	20000210
30	TIME_TO	Instance attribute	Private	☐	Type reference (TYPE)	SC_TIMETO		End Time of Selection Interval	20000210
31	TITLE	Instance attribute	Private	☐	Type reference (TYPE)	CHAR80		Title	20000313
32	TST_FROM	Instance attribute	Private	☐	Type reference (TYPE)	TIMESTAMP		Start Time Stamp of Selection Interval	20000209
33	TST_TO	Instance attribute	Private	☐	Type reference (TYPE)	TIMESTAMP		End Time Stamp of Selection Interval	20000209

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_PARTICIPANTS	Instance method	Public	Method	Add Participants	20000814
2	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20000209
3	CONVERT_COND_DATA_TO_CNTL_FB	Instance method	Private	Method	Transform Condensed Time Stream in Control Structure	20000811
4	CONVERT_FB_TO_CNTL_FB	Instance method	Private	Method	Transform Free/Busy Data in Control Structure	20000210
5	CONVERT_MEET_TO_CNTL_MEET	Instance method	Private	Method	Transform Times Without Appointments in Control Structure	20000229
6	FIND_FREE_PARTICIPANTS	Instance method	Private	Method	Find Free Participants for Specified Time Period	20010126
7	FIND_FREE_TIMEFRAMES	Instance method	Private	Method	Find Time Without Appointments	20000225
8	FIND_MEETING_TIMES	Instance method	Public	Method	Returns Times Without Appointments, Without Dialog	20001107
9	GET_FREE_BUSY_DATA	Instance method	Public	Method	Returns Free/Busy Data, Without Dialog	20010125
10	GET_FREE_PARTICIPANTS	Instance method	Public	Method	Gets Free Participants for a Specified Time Period	20010126
11	GET_SELECTED_MEETING_TIMES	Instance method	Public	Method	Returns Times Without Appointments Selected in Dialog	20001107
12	MODIFY_MEMORY	Instance method	Private	Method	Modify Internal Memory	20000815
13	MODIFY_PARTICIPANTS	Instance method	Public	Method	Change Participants	20000814
14	ON_PART_DELETED	Instance method	Private	Event handling method	Handler for Deleting a Participant	20000810
15	ON_PART_INSERTED	Instance method	Private	Event handling method	Handler for Adding a Participant	20000814
16	ON_PART_SELECTED	Instance method	Private	Event handling method	Handler for Selecting a Participant	20000808
17	READ_FREE_BUSY_DATA	Instance method	Private	Method	Read Free/Busy Data and Adapt Selection Interval	20000210
18	REFRESH_DISPLAY	Instance method	Public	Method	Refresh display	20000811
19	REMOVE_PARTICIPANTS	Instance method	Public	Method	Delete Participants	20000810
20	SELECT_FREE_BUSY_DATA	Instance method	Public	Method	Set Parameters for selection of Free/Busy Data	20000209
21	SET_NO_MEETING_TIMES	Instance method	Public	Method	Sets NO_MEETING_TIMES Flag	20060629
22	SET_REGISTERED_EVENTS	Instance method	Public	Method	Activate Events	20000808
23	SHOW	Instance method	Public	Method	Display of Selected Free/Busy Data	20000209

Events

#	Event	Type	Visibility	Description	Created on
1	PART_ADDED	Instance Event (0)	Public (2)	Participant Added	20000814
2	PART_DELETED	Instance Event (0)	Public (2)	Participant Deleted	20000810
3	PART_SELECTED	Instance Event (0)	Public (2)	Participant Selected	20000808

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	STP_FBPART	Private	Object reference (TYPE REF TO)	CL_FREE_BUSY		20000811
2	STP_FBPART_CNTL_MAP_TAB	Private	See coding		STP_FBPART_CNTL_MAP_TAB	20000811
3	TTP_FBPART	Private	See coding		TTP_FBPART	20000811
4	TTP_FBPART_CNTL_MAP_TAB	Private	See coding		TTP_FBPART_CNTL_MAP_TAB	20000811

Method Signatures

Method ADD_PARTICIPANTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_SUCCESSOR	Call by reference	☑	Type reference (TYPE)	SCSFBPART		Teilnehmer vor dem eingefügt werden soll	20000814
2	Importing	IT_PARTICIPANTS	Call by reference	☐	Type reference (TYPE)	SCSFBPARTTAB		Terminverwaltung: Parameter zur Free/Busy Analyse	20000814

Method ADD_PARTICIPANTS on class CL_PLANNER has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	APPT_DURATION	Call by reference	☑	Type reference (TYPE)	SC_INTERVA		Dauer des Termins in Minuten	20000209
2	Importing	APPT_DURATION_2	Call by reference	☑	Type reference (TYPE)	SC_DURNUMC		Dauer eines Termins	20030108
3	Importing	CONTAINER	Call by reference	☑	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Container für die Anzeige	20000209
4	Importing	DISPLAY_MODE	Call by reference	☐	Type reference (TYPE)	SC_FLAG	SPACE	Display Modus, Events werden trotzdem gesendet	20000810
5	Importing	INCLUDE_ORG_APPOINTMENTS	Call by reference	☐	Type reference (TYPE)	FLAG	SCCON_NO	Selektiere auch Termine von zugeh. Org. Einheiten für Termin	20010125
6	Importing	NO_AUTHORIZATION_CHECK	Call by reference	☐	Type reference (TYPE)	FLAG	SCCON_NO	Berechtigungsprüfung wird nicht durchgeführt	20010124
7	Importing	NO_CONDENSED_DATA	Call by reference	☐	Type reference (TYPE)	FLAG	SCCON_NO	Verdichteten Zeitstrahl für alle Teilnehmer nicht anzeigen	20000313
8	Importing	NO_MEETING_TIMES	Call by reference	☐	Type reference (TYPE)	FLAG	SCCON_NO	Keine Terminvorschläge	20000313
9	Importing	ORIGINAL_APPT_ID	Call by reference	☑	Type reference (TYPE)	SC_APPTID		ID eines allgemeinen Termins	20060203
10	Importing	ORIGINAL_GENAPPT_ID	Call by reference	☑	Type reference (TYPE)	SC_GENAPPT		ID eines generierten Termins	20060203
11	Importing	SEARCH_SETTINGS	Call by reference	☑	Type reference (TYPE)	SCSTP_PLANNER_SEARCH_SETTINGS		Einstellungen für die Terminsuche	20000904
12	Importing	TIMEZONE	Call by reference	☑	Type reference (TYPE)	TIMEZONE		Zeitzone, in der die Anzeige dargestellt wird	20000210
13	Importing	VIEW_SETTINGS	Call by reference	☐	Type reference (TYPE)	SCSTP_PLANNER_SETTINGS		Einstellungen der Ansicht	20000209

Method CONSTRUCTOR on class CL_PLANNER has no exception.

Method CONVERT_COND_DATA_TO_CNTL_FB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_CONDENSED_DATA	Call by reference	☐	Type reference (TYPE)	SZTG_TFB		Tabelle zur Datenübergabe zw. Kalenderframework und Planner	20000811
2	Importing	IM_FB_PARTICIPANT	Call by reference	☐	Type reference (TYPE)	TTP_FBPART		Verdichtung über diese Teilnehmer	20000811

Method CONVERT_COND_DATA_TO_CNTL_FB on class CL_PLANNER has no exception.

Method CONVERT_FB_TO_CNTL_FB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_CONTROL_FBPART	Call by reference	☐	Type reference (TYPE)	SZTG_TFB		Tabelle zur Datenübergabe zw. Kalenderframework und Planner	20000811
2	Importing	IM_FB_PARTICIPANT	Call by reference	☐	Type reference (TYPE)	TTP_FBPART		Referenzen auf Free/Busy Teilnehmer	20000811

Method CONVERT_FB_TO_CNTL_FB on class CL_PLANNER has no exception.

Method CONVERT_MEET_TO_CNTL_MEET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_CONTROL_MEETING_TIMES	Value transfer	☐	Type reference (TYPE)	SZTG_FBDATTAB		Terminfreie Zeiten im Control Format	20000229

Method CONVERT_MEET_TO_CNTL_MEET on class CL_PLANNER has no exception.

Method FIND_FREE_PARTICIPANTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_PARTICIPANTS	Call by reference	☐	Type reference (TYPE)	SCSFBPARTTAB		Terminverwaltung: Parameter zur Free/Busy Analyse	20010126
2	Importing	IM_TIMEFRAME_DURATION	Call by reference	☐	Type reference (TYPE)	SCSTP_TIMEDIFF		Länge der terminfreien Zeit	20010126
3	Importing	IM_TST_FROM	Call by reference	☐	Type reference (TYPE)	TIMESTAMP		von Zeitstempel	20010126

Method FIND_FREE_PARTICIPANTS on class CL_PLANNER has no exception.

Method FIND_FREE_TIMEFRAMES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DAILY_TIME_FROM	Call by reference	☐	Type reference (TYPE)	TIMS	SCCON_00	täglich innerhalb von	20001107
2	Importing	IM_DAILY_TIME_TO	Call by reference	☐	Type reference (TYPE)	TIMS	SCCON_24	täglich innerhalb bis	20001107
3	Importing	IM_TIMEFRAMES_COUNTER	Call by reference	☑	Type reference (TYPE)	I		Anzahl der zu findenden Terminvorschläge	20001107
4	Importing	IM_TIMEFRAME_DURATION	Call by reference	☐	Type reference (TYPE)	SCSTP_TIMEDIFF		Länge der terminfreien Zeit	20000906
5	Importing	IM_TST_FROM	Call by reference	☐	Type reference (TYPE)	TIMESTAMP		von Zeitstempel	20000229
6	Importing	IM_TST_TO	Call by reference	☐	Type reference (TYPE)	TIMESTAMP		bis Zeitstempel	20000229

Method FIND_FREE_TIMEFRAMES on class CL_PLANNER has no exception.

Method FIND_MEETING_TIMES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_MEETING_TIMES	Call by reference	☐	Type reference (TYPE)	SCSTIMEFRMTAB		Tabelle terminfreier Zeiten	20001107

Method FIND_MEETING_TIMES on class CL_PLANNER has no exception.

Method GET_FREE_BUSY_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_PARTICIPANTS	Call by reference	☐	Type reference (TYPE)	SCSFBPARTTAB		Terminverwaltung: Parameter zur Free/Busy Analyse	20010125

Method GET_FREE_BUSY_DATA on class CL_PLANNER has no exception.

Method GET_FREE_PARTICIPANTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_PARTICIPANTS	Call by reference	☐	Type reference (TYPE)	SCSFBPARTTAB		Terminverwaltung: Parameter zur Free/Busy Analyse	20010126

Method GET_FREE_PARTICIPANTS on class CL_PLANNER has no exception.

Method GET_SELECTED_MEETING_TIMES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_MEETING_TIMES	Call by reference	☐	Type reference (TYPE)	SCSTIMEFRMTAB		Tabelle terminfreier Zeiten	20001107

Method GET_SELECTED_MEETING_TIMES on class CL_PLANNER has no exception.

Method MODIFY_MEMORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_PARTICIPANTS_CREATE	Call by reference	☐	Type reference (TYPE)	TTP_FBPART		Terminverwaltung: Parameter zur Free/Busy Analyse	20000815
2	Exporting	ET_PARTICIPANTS_MODIFY	Call by reference	☐	Type reference (TYPE)	TTP_FBPART		Terminverwaltung: Parameter zur Free/Busy Analyse	20000815
3	Importing	IT_PARTICIPANTS	Value transfer	☐	Type reference (TYPE)	SCSFBPARTTAB		Terminverwaltung: Parameter zur Free/Busy Analyse	20000815

Method MODIFY_MEMORY on class CL_PLANNER has no exception.

Method MODIFY_PARTICIPANTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_PARTICIPANTS	Call by reference	☐	Type reference (TYPE)	SCSFBPARTTAB		Terminverwaltung: Parameter zur Free/Busy Analyse	20000814

Method MODIFY_PARTICIPANTS on class CL_PLANNER has no exception.

Method ON_PART_DELETED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	E_PART_ID	Value transfer	☐	Attribute reference (LIKE)				20000810

Method ON_PART_DELETED on class CL_PLANNER has no exception.

Method ON_PART_INSERTED Signature

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

Method ON_PART_INSERTED on class CL_PLANNER has no exception.

Method ON_PART_SELECTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	E_PART_ID	Value transfer	☐	Attribute reference (LIKE)				20000808

Method ON_PART_SELECTED on class CL_PLANNER has no exception.

Method READ_FREE_BUSY_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_TST_FROM	Call by reference	☐	Type reference (TYPE)	TIMESTAMP		von Zeitstempel	20000210
2	Importing	IM_TST_TO	Call by reference	☐	Type reference (TYPE)	TIMESTAMP		bis Zeitstempel	20000210

Method READ_FREE_BUSY_DATA on class CL_PLANNER has no exception.

Method REFRESH_DISPLAY Signature

Method REFRESH_DISPLAY on class CL_PLANNER has no parameter.
Method REFRESH_DISPLAY on class CL_PLANNER has no exception.

Method REMOVE_PARTICIPANTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_PARTICIPANTS	Call by reference	☐	Type reference (TYPE)	SCSFBPARTTAB		Terminverwaltung: Parameter zur Free/Busy Analyse	20000810

Method REMOVE_PARTICIPANTS on class CL_PLANNER has no exception.

Method SELECT_FREE_BUSY_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FB_PARTICIPANT_LIST	Value transfer	☐	Type reference (TYPE)	SCSFBPARTTAB		Terminverwaltung: Parameter zur Free/Busy Analyse	20000209

Method SELECT_FREE_BUSY_DATA on class CL_PLANNER has no exception.

Method SET_NO_MEETING_TIMES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NO_MEETING_TIMES	Call by reference	☐	Type reference (TYPE)	FLAG		allgemeines flag	20060629

Method SET_NO_MEETING_TIMES on class CL_PLANNER has no exception.

Method SET_REGISTERED_EVENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_REGISTERED_EVENTS	Call by reference	☐	Type reference (TYPE)	SCSTP_EVENT_TAB		Ereignistabelle	20000808

Method SET_REGISTERED_EVENTS on class CL_PLANNER has no exception.

Method SHOW Signature

Method SHOW on class CL_PLANNER has no parameter.

#	Exception	Resumable	Description	Created on
1	EMPTY_CONTAINER	☐	Es wurde kein GUI Container angegeben	20010126

Event Signatures

Event PART_ADDED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	EX_SUCCESSOR	Exporting	Value transfer	☐	Type reference (TYPE)	SCSFBPART		Teilnehmer vor dem eingefügt werden soll	20000814

Event PART_DELETED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	EX_PARTICIPANTS	Exporting	Value transfer	☐	Type reference (TYPE)	SCSFBPARTTAB		gelöschte Teilnehmer	20000810

Event PART_SELECTED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	EX_PARTICIPANT	Exporting	Value transfer	☐	Type reference (TYPE)	SCSFBPART		Selektierter Teilnehmer	20000808

History

Last changed by/on	SAP	20090618
SAP Release Created in	46D