SAP ABAP Class CL_CACS_RET_DB_ITF (Retention: Database Interface)

Hierarchy

☛ EA-APPL (Software Component) SAP Enterprise Extension PLM, SCM, Financials
   ⤷ ICM (Application Component) Incentive and Commission Management (ICM)
     ⤷ CACSR5 (Package) ICM: Retention: DDIC + APIs for DDIC

Properties

Class	CL_CACS_RET_DB_ITF
Short Description	Retention: Database Interface
Super Class
Instantiability of a Class	1	Protected
Final	☑

General Data

Message Class
Program status
Category	0
Package	CACSR5	ICM: Retention: DDIC + APIs for DDIC
Created	20060804	SAP
Last change	20100310	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_CACS_RET_DB_ITF has no forward declaration.

Interfaces

Class CL_CACS_RET_DB_ITF has no interface implemented.

Friends

Class CL_CACS_RET_DB_ITF has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_APPL	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_CACS_APPLICATION		ICM Application	20060822
2	MTS_PRC_ATIME_DB	Instance attribute	Protected	☐	Type reference (TYPE)	CACS_TS_RET_ATIME		Tab.Type (Sorted) Retention: Last Access Time-Spot in Proc.	20070219
3	SO_RET_DB_ITF	Static Attribute	Protected	☐	Object reference (TYPE REF TO)	CL_CACS_RET_DB_ITF		Retention: Database Interface	20060804

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20060804
2	CREATE	Static method	Public	Method	Factory Method: Generate Database Interface	20060804
3	CREATE_TABNAME_DOCHD	Instance method	Protected	Method	Create Table Name for DOCHD	20060829
4	CREATE_TABNAME_DOCSE	Instance method	Protected	Method	Create Table Name for DOCSE	20060822
5	EXTRACT_DOC_KEY	Instance method	Protected	Method	Extract Document Key	20060829
6	READ_EXCESS	Instance method	Public	Method	Read Excess Earnings for Retention Rule	20070309
7	READ_OFFSETTING_BASIS	Instance method	Public	Method	Read Settlement Items (Assigned Remuneration Types)	20061206
8	READ_PRC_ATIME	Instance method	Public	Method	Read Last Access Time-Spot in Process	20070219
9	READ_RETAGR_FOR_INDCTR	Instance method	Public	Method	Read Individ. Retention Agreements of Contract	20060817
10	READ_RETAINED_REMUNERATIONS	Instance method	Public	Method	Read Retained Remunerations for Retention Rule	20060829
11	READ_RETENTION_CURRENT	Instance method	Public	Method	Read Current Retention	20070220
12	READ_RETENTION_ORPHANED	Instance method	Public	Method	Read Retention Without Agreement Assignment	20070104
13	READ_RETRU_DESCR	Instance method	Public	Method	Read Name of One Retention Rule	20060804
14	READ_RETRU_DESCR_MULTIPLE	Instance method	Public	Method	Read Names of More than One Retention Rule	20060818
15	READ_STRETRU_DESCR	Instance method	Public	Method	Read Name of Characteristic Attributes of Retention Rule	20060830
16	SETUP_RETRU_ID_RANGE	Instance method	Protected	Method	Create Range Table	20070220

Events

Class CL_CACS_RET_DB_ITF has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TT_DOC_KEY	Protected	See coding			20060829	TT_DOC_KEY type STANDARD TABLE OF CACS00_S_DOCHD_K

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_APPL	Call by reference	☐	Type reference (TYPE)	CACSAPPL		Identifikation der Provisionsanwendung	20060804

#	Exception	Resumable	Description	Created on
1	CX_CACS_RET_ROOT	☐	Einbehaltung: Basisklasse Ausnahmebehandlung	20060804

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_APPL	Call by reference	☐	Type reference (TYPE)	CACSAPPL		Identifikation der Provisionsanwendung	20060804
2	Returning	RO_RET_DB_ITF	Value transfer	☐	Object reference (TYPE REF TO)	CL_CACS_RET_DB_ITF		Einbehaltung: Datenbankinterface	20060804

#	Exception	Resumable	Description	Created on
1	CX_CACS_RET_ROOT	☐	Einbehaltung: Basisklasse Ausnahmebehandlung	20060804

Method CREATE_TABNAME_DOCHD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RD_TABNAME	Value transfer	☐	Type reference (TYPE)	TABNAME		Tabellenname	20060829

#	Exception	Resumable	Description	Created on
1	CX_CACS_RET_ROOT	☐	Einbehaltung: Basisklasse Ausnahmebehandlung	20060829

Method CREATE_TABNAME_DOCSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RD_TABNAME	Value transfer	☐	Type reference (TYPE)	TABNAME		Tabellenname	20060822

#	Exception	Resumable	Description	Created on
1	CX_CACS_RET_ROOT	☐	Einbehaltung: Basisklasse Ausnahmebehandlung	20060822

Method EXTRACT_DOC_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DOC_KEY	Call by reference	☐	Type reference (TYPE)	TT_DOC_KEY			20060829
2	Importing	IR_DATA	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20060829

Method EXTRACT_DOC_KEY on class CL_CACS_RET_DB_ITF has no exception.

Method READ_EXCESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_INDCTR_ID	Call by reference	☐	Type reference (TYPE)	CACS_CTRTBU_ID		Nummer des Provisionsvertrags	20070309
2	Importing	ID_RETRU_ID	Call by reference	☐	Type reference (TYPE)	CACSRETRUID		Identifikation der Einbehaltungsregel	20070309
3	Returning	RR_DATA	Value transfer	☐	Object reference (TYPE REF TO)	DATA			20070309

#	Exception	Resumable	Description	Created on
1	CX_CACS_RET_ROOT	☐	Einbehaltung: Basisklasse Ausnahmebehandlung	20070309

Method READ_OFFSETTING_BASIS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_DUE_DATE_HIGH	Call by reference	☐	Type reference (TYPE)	DATUM		Datum	20061206
2	Importing	ID_DUE_DATE_LOW	Call by reference	☐	Type reference (TYPE)	DATUM		Datum	20061206
3	Importing	ID_INDCTR_ID	Call by reference	☐	Type reference (TYPE)	CACS_CTRTBU_ID		Nummer des Provisionsvertrags	20061206
4	Importing	ID_PRC_AKEYDATE	Call by reference	☐	Type reference (TYPE)	CACSTIMESTAMP		Letztes Abgrenzungszeitpunkt	20070827
5	Importing	ID_PRC_ATIME	Call by reference	☐	Type reference (TYPE)	CACSTIMESTAMP		Letzter Zugriffszeitpunkt	20070219
6	Importing	IT_RETREM	Call by reference	☐	Type reference (TYPE)	CACS_TT_RETREM		Zuordnung Vergütungsart zu Ausprägung der Einbehaltungsregel	20061206
7	Returning	RR_DATA	Value transfer	☐	Object reference (TYPE REF TO)	DATA			20061206

#	Exception	Resumable	Description	Created on
1	CX_CACS_RET_ROOT	☐	Einbehaltung: Basisklasse Ausnahmebehandlung	20061206

Method READ_PRC_ATIME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ED_AKEYDATE	Value transfer	☐	Type reference (TYPE)	CACSTIMESTAMP		Letztes Abgrenzungsdatum (JJJJ.MM.TT hh:mm:ss)	20070827
2	Exporting	ED_ATIME	Value transfer	☐	Type reference (TYPE)	CACSTIMESTAMP		Letzter Zugriffszeitpunkt (JJJJ.MM.TT hh:mm:ss)	20070827
3	Importing	ID_INDCTR_ID	Call by reference	☐	Type reference (TYPE)	CACS_CTRTBU_ID		Nummer des Provisionsvertrags	20070219
4	Importing	ID_RETAGR_ID	Call by reference	☐	Type reference (TYPE)	CACSRETAGRID		Nummer der Einbehaltungsvereinbarung	20070827
5	Importing	ID_RETRU_ID	Call by reference	☐	Type reference (TYPE)	CACSRETRUID		Identifikation der Einbehaltungsregel	20070219

#	Exception	Resumable	Description	Created on
1	CX_CACS_RET_ROOT	☐	Einbehaltung: Basisklasse Ausnahmebehandlung	20070219

Method READ_RETAGR_FOR_INDCTR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_INDCTR_ID	Call by reference	☐	Type reference (TYPE)	CACS_CTRTBU_ID		Nummer des Provisionsvertrags	20060817
2	Importing	IT_RANGE_RETRU_ID	Call by reference	☑	Type reference (TYPE)	CACS_TT_RETRU_ID_RANGE		Tabellentyp Einbehaltungsregel (Range)	20060817
3	Returning	RT_RETAGR	Value transfer	☐	Type reference (TYPE)	CACS_TT_RETAGR		Individuelle Einbehaltungsvereinbarung im Provisionsvertrag	20060817

#	Exception	Resumable	Description	Created on
1	CX_CACS_RET_ROOT	☐	Einbehaltung: Basisklasse Ausnahmebehandlung	20060818

Method READ_RETAINED_REMUNERATIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_INDCTR_ID	Call by reference	☐	Type reference (TYPE)	CACS_CTRTBU_ID		Nummer des Provisionsvertrags	20060829
2	Importing	ID_RETRU_ID	Call by reference	☐	Type reference (TYPE)	CACSRETRUID		Identifikation der Einbehaltungsregel	20060829
3	Returning	RR_DATA	Value transfer	☐	Object reference (TYPE REF TO)	DATA			20060829

#	Exception	Resumable	Description	Created on
1	CX_CACS_RET_ROOT	☐	Einbehaltung: Basisklasse Ausnahmebehandlung	20060829

Method READ_RETENTION_CURRENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_INDCTR_ID	Call by reference	☐	Type reference (TYPE)	CACS_CTRTBU_ID		Nummer des Provisionsvertrags	20070220
2	Importing	ID_RETRU_ID	Call by reference	☐	Type reference (TYPE)	CACSRETRUID		Identifikation der Einbehaltungsregel	20070220
3	Returning	RR_DATA	Value transfer	☐	Object reference (TYPE REF TO)	DATA			20070220

#	Exception	Resumable	Description	Created on
1	CX_CACS_RET_ROOT	☐	Einbehaltung: Basisklasse Ausnahmebehandlung	20070220

Method READ_RETENTION_ORPHANED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_INDCTR_ID	Call by reference	☐	Type reference (TYPE)	CACS_CTRTBU_ID			20070104
2	Importing	IT_RETRU_ID_KNOWN	Call by reference	☐	Type reference (TYPE)	CACS_TT_RETRU_KEY		Tabellentyp: Einbehaltungsregel (Schlüssel)	20070104
3	Returning	RR_DATA	Value transfer	☐	Object reference (TYPE REF TO)	DATA			20070104

#	Exception	Resumable	Description	Created on
1	CX_CACS_RET_ROOT	☐	Einbehaltung: Basisklasse Ausnahmebehandlung	20070104

Method READ_RETRU_DESCR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_RETRU_ID	Call by reference	☐	Type reference (TYPE)	CACSRETRUID		Einbehaltungsregel	20060804
2	Returning	RD_RETRU_DESCR	Value transfer	☐	Type reference (TYPE)	CACSRETRUTEXT		Bezeichnung der Einbehaltungsregel	20060804

#	Exception	Resumable	Description	Created on
1	CX_CACS_RET_ROOT	☐	Einbehaltung: Basisklasse Ausnahmebehandlung	20060804

Method READ_RETRU_DESCR_MULTIPLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_RETRU	Call by reference	☑	Type reference (TYPE)	CACS_TT_RETRU_KEY		Tabellentyp: Einbehaltungsregel (Schlüssel)	20060818
2	Returning	RT_RETRUT	Value transfer	☐	Type reference (TYPE)	CACS_TT_RETRUT		Tabellentyp: Bezeichnung der Einbehaltungsregel	20060818

#	Exception	Resumable	Description	Created on
1	CX_CACS_RET_ROOT	☐	Einbehaltung: Basisklasse Ausnahmebehandlung	20060818

Method READ_STRETRU_DESCR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_AGR_TYP	Call by reference	☐	Type reference (TYPE)	CACS_AGR_TYP		Vereinbarungsart	20060830
2	Importing	ID_RETRU_ID	Call by reference	☐	Type reference (TYPE)	CACSRETRUID		Identifikation der Einbehaltungsregel	20060830
3	Importing	ID_STCAGR_ID	Call by reference	☐	Type reference (TYPE)	CACS_STCAGR_ID		Nummer der Standard-Vereinbarung	20060830
4	Returning	RD_STRETRU_DESCR	Value transfer	☐	Type reference (TYPE)	CACSSTRETRUTEXT		Bezeichnung der Ausprägung der Einbehaltungsregel	20060830

#	Exception	Resumable	Description	Created on
1	CX_CACS_RET_ROOT	☐	Einbehaltung: Basisklasse Ausnahmebehandlung	20060830

Method SETUP_RETRU_ID_RANGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_RETRU_ID_KNOWN	Call by reference	☐	Type reference (TYPE)	CACS_TT_RETRU_KEY		Tabellentyp: Einbehaltungsregel (Schlüssel)	20070220
2	Returning	RT_RETRU_ID_RANGE	Value transfer	☐	Type reference (TYPE)	CACS_TT_RETRU_ID_RANGE		Tabellentyp Einbehaltungsregel (Range)	20070220

Method SETUP_RETRU_ID_RANGE on class CL_CACS_RET_DB_ITF has no exception.

History

Last changed by/on	SAP	20100310
SAP Release Created in	700