SAP ABAP Class CL_APPOINTMENT_RULE (Appointment Rule)

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

Properties

Class	CL_APPOINTMENT_RULE
Short Description	Appointment Rule
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	20000106	SAP
Last change	20050105	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	SO	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_APPOINTMENT_RULE has no interface implemented.

Friends

Class CL_APPOINTMENT_RULE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_RULE_TEMPLATE	Constant	Private	☐	Type reference (TYPE)	CHAR3	'05_'	ID of Rule Template	20000107
2	INTERNAL_ID	Instance attribute	Public	☑	Type reference (TYPE)	SC_RULEID		Internal Rule ID	20000106
3	REFERENCE	Instance attribute	Private	☐	Type reference (TYPE)	SCSRULREF		Application Reference	20000107
4	RULE	Instance attribute	Private	☐	Type reference (TYPE)	RULE_TAB		Rule Table	20000106

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_DATE	Instance method	Public	Method	Add an Extra Appointment	20000106
2	COMPUTE	Instance method	Public	Method	Calculate Appointments from this Rule	20000106
3	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20000106
4	COPY	Instance method	Public	Method	Returns a Copy of a Rule (if no Template Exists)	20000107
5	EDIT	Instance method	Public	Method	Change or Create Rule	20000106
6	EXCLUDE_DATE	Instance method	Public	Method	Add an Extra Appointment	20000106
7	FREE	Instance method	Public	Method	Releases Reference to Rule	20000107
8	GET_ID	Instance method	Public	Method	Returns Internal or Own ID	20000107
9	GET_RULE	Instance method	Public	Method	Returns Rule Table	20000106
10	GET_TEXT	Instance method	Public	Method	Returns Rule Text	20000106
11	GET_TIME_FRAME	Instance method	Public	Method	Read Validity Period	20000106
12	RULE_FREE	Instance method	Private	Method	Releases Reference to Rule	20000107
13	RULE_SAVE	Instance method	Private	Method	Saves Rule in Database	20000107
14	SET_TIME_FRAME	Instance method	Public	Method	Read Validity Period	20000106

Events

Class CL_APPOINTMENT_RULE has no event.

Types

Class CL_APPOINTMENT_RULE has no local type.

Method Signatures

Method ADD_DATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ALLOW_DATE_OUTSIDE	Call by reference	☐	Type reference (TYPE)	SC_FLAG	'X'	Zusätzlicher Tag darf außerhalb des Periodenzeitraums liegen	20000106
2	Importing	DATE_FROM	Call by reference	☐	Type reference (TYPE)	DATS		Anfangsdatum des zusätzlichen Tages	20000106
3	Importing	DATE_TO	Call by reference	☐	Type reference (TYPE)	DATS		Endedatum des zusätzlicher Tag (default = DATE_FROM)	20000106
4	Importing	TIMEZONE	Call by reference	☐	Type reference (TYPE)	TIMEZONE		Zeitzone	20000106
5	Importing	TIME_FROM	Call by reference	☐	Type reference (TYPE)	TIMS		Start-Uhrzeit	20000106
6	Importing	TIME_TO	Call by reference	☐	Type reference (TYPE)	TIMS		Ende-Uhrzeit	20000106

#	Exception	Resumable	Description	Created on
1	DATE_OUTSIDE	☐	Datum liegt außerhalb des Periodenzeitraums	20000106

Method COMPUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	APPOINTMENTS	Call by reference	☐	Type reference (TYPE)	SCSAPPTTAB		Errechnete Termine	20000106
2	Importing	APPT_TEMPLATE	Call by reference	☑	Type reference (TYPE)	SCSAPPT		Vorschalgswerte für die Termine	20000106
3	Importing	FROM_DATE	Value transfer	☑	Type reference (TYPE)	DATUM		Anfangszeitpunkt der Berechnungsperiode (falls leer wird die	20000106
4	Importing	TO_DATE	Value transfer	☑	Type reference (TYPE)	DATUM		Endezeitpunkt der Berechnungsperiode (falls leer wird die de	20000106

#	Exception	Resumable	Description	Created on
1	INVALID_RULE	☐	Regeltabelle ist falsch	20000106
2	RULE_NOT_EXIST	☐	falsche Regel Id	20000106

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INTERNAL_ID	Value transfer	☑	Type reference (TYPE)	SC_RULEID		Interne Regel_id	20000106
2	Importing	REFERENCE	Value transfer	☑	Type reference (TYPE)	SCSRULREF		Regelrefernz für neue Regel	20000106
3	Importing	RULE	Value transfer	☑	Type reference (TYPE)	RULE_TAB		neue Terminregel	20000106

#	Exception	Resumable	Description	Created on
1	INVALID_RULE	☐	Inkonsistente neue Regel	20000106
2	NO_INSERT	☐	Neue Regel konnte nicht angelegt werden (interner Fehler)	20000106
3	NO_REFERENCE	☐	Keine Referenz für neue Regel mitgegeben	20000106
4	NO_RULE	☐	Keine Regel und keine Id mitgegeben	20000106

Method COPY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	NEW_RULE	Value transfer	☐	Object reference (TYPE REF TO)	CL_APPOINTMENT_RULE		Neue, kopierte Regel	20000107

Method COPY on class CL_APPOINTMENT_RULE has no exception.

Method EDIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ACTION	Value transfer	☐	Type reference (TYPE)	SYUCOMM		TKOV=Übernehmen,ECAN=Abbrechen,CONF=Konflikte	20000106
2	Importing	DISPLAY_MODE	Value transfer	☑	Type reference (TYPE)	SYINPUT		Bearbeitungsart	20000106
3	Importing	FACTORY_CALENDAR	Value transfer	☐	Type reference (TYPE)	WFCID	SPACE	Fabrikkalender-Id (Vorschlag)	20000106
4	Importing	HOLIDAY_CALENDAR	Value transfer	☐	Type reference (TYPE)	HIDENT	SPACE	Feiertagskalender-Id (Vorschlag)	20000106
5	Importing	NAME_OF_RULE_ENTITY	Value transfer	☑	Type reference (TYPE)	TEXT40		Alternative Bezeichnung für "Regel", z.B. "Termine", "Besuch	20000106
6	Importing	NO_PERIOD	Value transfer	☐	Type reference (TYPE)	SC_FLAG	'X'	Kein Zeitraum anzeigen	20000106
7	Importing	OWNER_OF_DEFAULT_SETTINGS	Value transfer	☐	Type reference (TYPE)	SYUNAME	SY-UNAME	Benutzer dessen Einstellungen verwendet werden sollen	20000106
8	Changing	PERIOD_END_DATE	Value transfer	☑	Type reference (TYPE)	SC_DATETO		bis Datum	20000106
9	Changing	PERIOD_START_DATE	Value transfer	☐	Type reference (TYPE)	SC_DATEFRO	SY-DATUM	Anfangsdatum	20000106
10	Importing	RULE_TYPE	Value transfer	☐	Type reference (TYPE)	CHAR2	'W '	Vorschlag für Regel	20000106
11	Importing	TIMEZONE	Value transfer	☑	Type reference (TYPE)	TIMEZONE		Vorschlag für Zeitzone	20000106
12	Importing	TIME_FROM	Value transfer	☑	Type reference (TYPE)	SC_TIMEFRO		Vorschlag für Von-Uhrzeit	20000106
13	Importing	TIME_TO	Value transfer	☑	Type reference (TYPE)	SC_TIMETO		Vorschlag fürt Bis-Uhrzeit	20000106
14	Importing	TITLE_OF_EDITOR	Value transfer	☑	Type reference (TYPE)	TEXT40		Überschrift des Editors	20000106

Method EDIT on class CL_APPOINTMENT_RULE has no exception.

Method EXCLUDE_DATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ALLOW_DATE_OUTSIDE	Call by reference	☐	Type reference (TYPE)	SC_FLAG	'X'	Zusätzlicher Tag darf außerhalb des Periodenzeitraums liegen	20000106
2	Importing	DATE_FROM	Call by reference	☐	Type reference (TYPE)	DATS		Anfangsdatum des zusätzlichen Tages	20000106
3	Importing	DATE_TO	Call by reference	☐	Type reference (TYPE)	DATS		Endedatum des zusätzlicher Tag (default = DATE_FROM)	20000106
4	Importing	TIMEZONE	Call by reference	☐	Type reference (TYPE)	TIMEZONE		Zeitzone	20000106
5	Importing	TIME_FROM	Call by reference	☐	Type reference (TYPE)	TIMS		Start-Uhrzeit	20000106
6	Importing	TIME_TO	Call by reference	☐	Type reference (TYPE)	TIMS		Ende-Uhrzeit	20000106

#	Exception	Resumable	Description	Created on
1	DATE_OUTSIDE	☐	Datum liegt außerhalb des Periodenzeitraums	20000106

Method FREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	REFERENCE	Value transfer	☐	Type reference (TYPE)	SCSRULREF		Anwendungsreferenz	20000107

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Keine Regel und keine Id mitgegeben	20000107
2	REFERENCE_NOT_FOUND	☐	Keine Referenz für neue Regel mitgegeben	20000107

Method GET_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ID	Value transfer	☐	Type reference (TYPE)	SC_RULEID		interne Identifizierung der Regel periodischer Termine	20000107
2	Importing	REFERENCE	Value transfer	☑	Type reference (TYPE)	SCSRULREF		Anwendungsrefenz (mindestens Entw.klasse und Anw.kennung)	20000107

#	Exception	Resumable	Description	Created on
1	INVALID_RULE	☐	Inkonsistente Regel	20000107
2	NO_INSERT	☐	Regel konnte nicht angelegt werden	20000107
3	NO_REFERENCE	☐	Noch keine Referenz vorhanden	20000107
4	NO_RULE	☐	keine Regel angegeben	20000107

Method GET_RULE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RULE	Value transfer	☐	Type reference (TYPE)	RULE_TAB		Regeltabelle	20000106

#	Exception	Resumable	Description	Created on
1	NO_RULE	☐	Regel ist nicht vorhanden	20000106

Method GET_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	TEXT	Value transfer	☐	Type reference (TYPE)	SO_TXTTAB		Regeltext	20000106

#	Exception	Resumable	Description	Created on
1	INVALID_RULE	☐	Inkonsistente Regel	20000106
2	RULE_NOT_EXIST	☐	Falsche Regel-ID	20000106

Method GET_TIME_FRAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	END_DATE	Call by reference	☐	Type reference (TYPE)	SCENDDATE		Endezeitpunkt	20000106
2	Exporting	START_DATE	Call by reference	☐	Type reference (TYPE)	SCSTARTDAT		Anfangszeitpunkt	20000106

#	Exception	Resumable	Description	Created on
1	INVALID_RULE	☐	Inkonsistente Regel	20000106
2	RULE_NOT_FOUND	☐	Falsche Rule-Id	20000106

Method RULE_FREE Signature

Method RULE_FREE on class CL_APPOINTMENT_RULE has no parameter.

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Keine Regel und keine Id mitgegeben	20000107
2	REFERENCE_NOT_FOUND	☐	Keine Referenz für neue Regel mitgegeben	20000107

Method RULE_SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	INTERNAL_ID	Value transfer	☐	Type reference (TYPE)	SC_RULEID		Ermittelte Id	20000107
2	Importing	REFERENCE	Value transfer	☐	Type reference (TYPE)	SCSRULREF		Anwendungsreferenz	20000107

#	Exception	Resumable	Description	Created on
1	INVALID_RULE	☐	Inkonsistente neue Regel	20000107
2	NO_INSERT	☐	Neue Regel konnte nicht angelegt werden (interner Fehler)	20000107
3	NO_REFERENCE	☐	Keine Referenz für neue Regel mitgegeben	20000107
4	NO_RULE	☐	Keine Regel und keine Id mitgegeben	20000107

Method SET_TIME_FRAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	END_DATE	Call by reference	☐	Type reference (TYPE)	SCENDDATE		Endezeitpunkt	20000106
2	Importing	START_DATE	Call by reference	☐	Type reference (TYPE)	SCSTARTDAT		Anfangszeitpunkt	20000106

#	Exception	Resumable	Description	Created on
1	INVALID_RULE	☐	Inkonsistente Regel	20000106

History

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