SAP ABAP Class CACSRO_CL_DOCUMENT_RETENTION (Incentive and Commission Management: Retention Document)
Hierarchy
☛ EA-APPL (Software Component) SAP Enterprise Extension PLM, SCM, Financials
   ⤷ ICM (Application Component) Incentive and Commission Management (ICM)
     ⤷ CACSR1 (Package) ICM: Retention: Transaction Data
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  CACS00_CL_DOCUMENT_SETTLE_ABST ICM: Commission Document (Settlement Data) 20060817
2 Interface implementation (CLASS c. INTERFACES i_ref)  IF_CACS_RET_DOCUMENT Retention Document: Public Methods 20060831
3 Interface implementation (CLASS c. INTERFACES i_ref)  IF_CACS_RI_DOCUMENT Run Administration: Methods for Commission Documents 20070103
Properties
Class CACSRO_CL_DOCUMENT_RETENTION  
Short Description Incentive and Commission Management: Retention Document    
Super Class CACS00_CL_DOCUMENT_SETTLE_ABST ICM: Commission Document (Settlement Data) 
Instantiability of a Class 1  Protected 
Final    
General Data
Message Class    
Program status     
Category 0   
Package CACSR1   ICM: Retention: Transaction Data 
Created 20060817   SAP 
Last change 20100310   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 CL_CACS_RET_CALCULATION Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
Interfaces
# Interface Abstract Final Description Created on
1 IF_CACS_RET_DOCUMENT Retention Document: Public Methods 20060831
2 IF_CACS_RI_DOCUMENT Run Administration: Methods for Commission Documents 20070103
Friends
# Friend Modeled only Created on Description
1 CL_CACS_DOCUMENT_FACTORY 20060817 Commission Document: Factory
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 MT_OFFSET_REM_CHG Instance attribute Protected Type reference (TYPE) CACSRO_TT_RET_COMPRESS Retention: Table Type for Compression 20061109
Methods
# Method Level Visibility Method type Description Created on
1 ADD_NAV_MSG Instance method Protected Method Add Message to Document Navigation 20061102
2 BADI_CHECK_DOCUMENT Instance method Protected Method BAdI: Check Retention Document Before Posting 20060829
3 BADI_ENRICH_DOCHD Instance method Protected Method BAdI: Enrich Document Header (Only Customer Fields) 20061107
4 BADI_ENRICH_DOCSE Instance method Protected Method BAdI: Enrich Settlement Item (Only Customer Fields) 20061107
5 BADI_ENRICH_DOCSEDT Instance method Protected Method BAdI: Enrich Settlement Detail Item (Only Customer Fields) 20061107
6 BUILD_HEADER Instance method Protected Method Create Document Header 20060825
7 BUILD_OFFSET_ITEMS Instance method Protected Method Create Settlement Items for Offsetting 20060825
8 BUILD_SETTLEMENT_ITEMS_REM Instance method Protected Method Create Settlement Item for Remuneration 20060825
9 BUILD_SETTLEMENT_ITEM_GEN Instance method Protected Method Create Settlement Item 20060825
10 BUILD_SETTLEMENT_ITEM_RET Instance method Protected Method Create Settlement Item for Retention 20060825
11 CALC_TOTAL_DUE_CONAMNT Instance method Protected Method Calculate Total of Settlement Items 20061109
12 CALC_TOTAL_RET_AMNT Instance method Protected Method Calculate Total of Planned Change of Retention 20061113
13 CONSTRUCTOR Instance method Public Constructor CONSTRUCTOR 20060817
14 CREATE Static method Protected Method Factory Method: Create New Retention Document 20060817
15 CREATE_TRI_BUSCASE_ID Instance method Protected Method Create Identification of Triggering Business Transaction 20060825
16 GET_LOG Instance method Public Method 20061102
17 GET_RI_DATA Instance method Public Method 20060831
18 LOAD Static method Protected Method Factory Method: Load Retention Document from Database 20060817
19 OFFSET_RETENTION Instance method Public Method Offset Retention 20060831
20 POST_DOCUMENT Instance method Public Method 20060831
21 SAVE_LOG Instance method Protected Method Save Application Log 20061102
22 SET_CURRENCY_FIELDS Instance method Protected Method Set Amount Fields and Currency Fields 20060825
23 SET_IMPORT_DATE Instance method Public Method 20060831
24 SET_TEXT Instance method Public Method 20060831
25 SPLIT_TRI_BUSCASE_ID Instance method Protected Method Split Up Identification of Triggering Business Transaction 20060825
Events
Class CACSRO_CL_DOCUMENT_RETENTION has no event.
Types
Class CACSRO_CL_DOCUMENT_RETENTION has no local type.
Method Signatures

Method ADD_NAV_MSG Signature

Method ADD_NAV_MSG on class CACSRO_CL_DOCUMENT_RETENTION has no parameter.
# Exception Resumable Description Created on
1 CX_CACS_BAL_EX CACS: Application log exceptions 20061102

Method BADI_CHECK_DOCUMENT Signature

Method BADI_CHECK_DOCUMENT on class CACSRO_CL_DOCUMENT_RETENTION has no parameter.
# Exception Resumable Description Created on
1 CX_CACS_DOCUMENT_ROOT Provisionsbeleg: Ausnahmebehandlung 20060829

Method BADI_ENRICH_DOCHD Signature

Method BADI_ENRICH_DOCHD on class CACSRO_CL_DOCUMENT_RETENTION has no parameter.
# Exception Resumable Description Created on
1 CX_CACS_BAL_EX CACS: Application log exceptions 20061108
2 CX_CACS_DOCUMENT_ROOT Einbehaltung: Basisklasse Ausnahmebehandlung 20061107

Method BADI_ENRICH_DOCSE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CS_DOCSEM Call by reference Type reference (TYPE) CACS00_S_DOCSEM Provisionsbeleg, Abrechnung (Metaobjekt) 20061107
# Exception Resumable Description Created on
1 CX_CACS_BAL_EX CACS: Application log exceptions 20061108
2 CX_CACS_DOCUMENT_ROOT Einbehaltung: Basisklasse Ausnahmebehandlung 20061107

Method BADI_ENRICH_DOCSEDT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CS_DOCSEDT Call by reference Type reference (TYPE) CACS00_DOCSEDT Abrechnungspositionsdetails 20061107
# Exception Resumable Description Created on
1 CX_CACS_BAL_EX CACS: Application log exceptions 20061108
2 CX_CACS_DOCUMENT_ROOT Einbehaltung: Basisklasse Ausnahmebehandlung 20061107

Method BUILD_HEADER 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 20060825
2 Importing ID_RETAGR_ID Call by reference Type reference (TYPE) CACSRETAGRID Nummer der Einbehaltungsvereinbarung 20060825
3 Importing ID_RETRU_ID Call by reference Type reference (TYPE) CACSRETRUID Identifikation der Einbehaltungsregel 20060825
# Exception Resumable Description Created on
1 CX_CACS_BAL_EX CACS: Application log exceptions 20061108
2 CX_CACS_DOCUMENT_ROOT Provisionsbeleg: Basisklasse Ausnahmebehandlung 20061107

Method BUILD_OFFSET_ITEMS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ID_GPART Call by reference Type reference (TYPE) CACS_GPART Nummer des Provisionsvertragspartners 20060825
2 Importing ID_INDCTR_CURR Call by reference Type reference (TYPE) CACSCONCURR Vertragswährungsschlüssel 20060825
3 Importing ID_INDCTR_ID Call by reference Type reference (TYPE) CACS_CTRTBU_ID Nummer des Provisionsvertrags 20060826
4 Importing ID_RETRU_ID Call by reference Type reference (TYPE) CACSRETRUID Identifikation der Einbehaltungsregel 20060825
# Exception Resumable Description Created on
1 CX_CACS_BAL_EX CACS: Application log exceptions 20061102
2 CX_CACS_DOCUMENT_ROOT Einbehaltungsbeleg: Ausnahmebehandlung 20060829
3 CX_CACS_NUMBER_HELPER Hilfsklasse: Nummernverwaltung: Ausnahmebehandlung 20060825

Method BUILD_SETTLEMENT_ITEMS_REM Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ID_GPART Call by reference Type reference (TYPE) CACS_GPART Nummer des Provisionsvertragspartners 20060825
2 Importing ID_INDCTR_ID Call by reference Type reference (TYPE) CACS_CTRTBU_ID Nummer des Provisionsvertrags 20060826
# Exception Resumable Description Created on
1 CX_CACS_BAL_EX CACS: Application log exceptions 20061102
2 CX_CACS_DOCUMENT_ROOT Provisionsbeleg: Basisklasse Ausnahmebehandlung 20060830
3 CX_CACS_NUMBER_HELPER Hilfsklasse: Nummernverwaltung: Ausnahmebehandlung 20060825

Method BUILD_SETTLEMENT_ITEM_GEN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CS_DOCSEM Call by reference Type reference (TYPE) CACS00_S_DOCSEM Provisionsbeleg, Abrechnung (Metaobjekt) 20060825
2 Importing ID_GPART Call by reference Type reference (TYPE) CACS_GPART Nummer des Provisionsvertragspartners 20060825
3 Importing ID_INDCTR_ID Call by reference Type reference (TYPE) CACS_CTRTBU_ID Nummer des Provisionsvertrags 20060826
# Exception Resumable Description Created on
1 CX_CACS_NUMBER_HELPER Hilfsklasse: Nummernverwaltung: Ausnahmebehandlung 20060825

Method BUILD_SETTLEMENT_ITEM_RET Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ID_GPART Call by reference Type reference (TYPE) CACS_GPART Nummer des Provisionsvertragspartners 20060825
2 Importing ID_INDCTR_CURR Call by reference Type reference (TYPE) CACSCONCURR Vertragswährungsschlüssel 20060825
3 Importing ID_INDCTR_ID Call by reference Type reference (TYPE) CACS_CTRTBU_ID Nummer des Provisionsvertrags 20060826
4 Importing ID_RETRU_ID Call by reference Type reference (TYPE) CACSRETRUID Identifikation der Einbehaltungsregel 20060825
# Exception Resumable Description Created on
1 CX_CACS_BAL_EX CACS: Application log exceptions 20061102
2 CX_CACS_DOCUMENT_ROOT Einbehaltungsbeleg: Ausnahmebehandlung 20060829
3 CX_CACS_NUMBER_HELPER Hilfsklasse: Nummernverwaltung: Ausnahmebehandlung 20060825

Method CALC_TOTAL_DUE_CONAMNT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RD_TOTAL_AMNT Value transfer Type reference (TYPE) CACSDUECONAMNT Auszahlungsbereiter Vergütungsteilbetrag in Vertragswährung 20061109

Method CALC_TOTAL_DUE_CONAMNT on class CACSRO_CL_DOCUMENT_RETENTION has no exception.

Method CALC_TOTAL_RET_AMNT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RD_TOTAL_AMNT Value transfer Type reference (TYPE) CACSDUECONAMNT Auszahlungsbereiter Vergütungsteilbetrag in Vertragswährung 20061113

Method CALC_TOTAL_RET_AMNT on class CACSRO_CL_DOCUMENT_RETENTION has no exception.

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ID_DOC_ID Call by reference Type reference (TYPE) CACSDOCID Identifikation eines Belegs 20060817
2 Importing ID_POST_YEAR Call by reference Type reference (TYPE) CACSPSTYEAR Zuordnungsjahr des Provisionsfalls/-belegs 20060817
3 Importing IO_LOG Call by reference Object reference (TYPE REF TO) CL_CACS_BAL CACS: Application log 20061208
# Exception Resumable Description Created on
1 CX_CACS_DOCUMENT_ROOT Provisionsbeleg: Ausnahmebehandlung 20060829

Method CREATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ID_BUSITIME Call by reference Type reference (TYPE) CACSBUSITIME Fachl. Gültigkeit (Zeitstempel JJJJ.MM.TT hh:mm:ss) 20060817
2 Importing ID_POST_DATE Call by reference Type reference (TYPE) CACSPSTDAT Buchungsdatum im ProvFall/-Beleg (Kenntnisgabe) 20060817
3 Importing ID_PRD_NUMBER Call by reference Type reference (TYPE) CACSPRDNUMBER Periodennummer 20060817
4 Importing ID_PRD_RULE Call by reference Type reference (TYPE) CACSPRDRULE Periodenregel 20060817
5 Importing ID_RUN_ID Call by reference Type reference (TYPE) CACS_RUNID Laufnummer für Laufverwaltung 20060817
6 Importing ID_TECHTIME Call by reference Type reference (TYPE) CACSTECHTIME Techn. Gültigkeit (Zeitstempel: JJJJ.MM.TT hh:mm:ss) 20060817
7 Importing IO_LOG Call by reference Object reference (TYPE REF TO) CL_CACS_BAL CACS: Application log 20061208
8 Returning RO_INSTANCE Value transfer Object reference (TYPE REF TO) CACSRO_CL_DOCUMENT_RETENTION Provisionsmanagement: Einbehaltungsbeleg 20060817
# Exception Resumable Description Created on
1 CX_CACS_DOCUMENT_ROOT Provisionsbeleg: Ausnahmebehandlung 20060829

Method CREATE_TRI_BUSCASE_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ID_RETAGR_ID Call by reference Type reference (TYPE) CACSRETAGRID Nummer der Einbehaltungsvereinbarung 20060825
2 Importing ID_RETRU_ID Call by reference Type reference (TYPE) CACSRETRUID Identifikation der Einbehaltungsregel 20060825
3 Returning RD_TRI_BUSCASE_ID Value transfer Type reference (TYPE) CACSTRIBUSCASEID Identifikation d. auslösenden Geschäftsvorfalls im Vorsystem 20060825

Method CREATE_TRI_BUSCASE_ID on class CACSRO_CL_DOCUMENT_RETENTION has no exception.

Method GET_LOG Signature

Method GET_LOG on class CACSRO_CL_DOCUMENT_RETENTION has no parameter.
Method GET_LOG on class CACSRO_CL_DOCUMENT_RETENTION has no exception.

Method GET_RI_DATA Signature

Method GET_RI_DATA on class CACSRO_CL_DOCUMENT_RETENTION has no parameter.
Method GET_RI_DATA on class CACSRO_CL_DOCUMENT_RETENTION has no exception.

Method LOAD Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ID_DOC_ID Call by reference Type reference (TYPE) CACSDOCID Identifikation eines Belegs 20060817
2 Importing ID_POST_YEAR Call by reference Type reference (TYPE) CACSPSTYEAR Zuordnungsjahr des Provisionsfalls/-belegs 20060817
3 Importing IO_LOG Call by reference Object reference (TYPE REF TO) CL_CACS_BAL CACS: Application log 20061208
4 Returning RO_INSTANCE Value transfer Object reference (TYPE REF TO) CACSRO_CL_DOCUMENT_RETENTION Provisionsmanagement: Einbehaltungsbeleg 20060817
# Exception Resumable Description Created on
1 CX_CACS_DOCUMENT_ROOT Provisionsbeleg: Ausnahmebehandlung 20060829

Method OFFSET_RETENTION Signature

Method OFFSET_RETENTION on class CACSRO_CL_DOCUMENT_RETENTION has no parameter.
Method OFFSET_RETENTION on class CACSRO_CL_DOCUMENT_RETENTION has no exception.

Method POST_DOCUMENT Signature

Method POST_DOCUMENT on class CACSRO_CL_DOCUMENT_RETENTION has no parameter.
Method POST_DOCUMENT on class CACSRO_CL_DOCUMENT_RETENTION has no exception.

Method SAVE_LOG Signature

Method SAVE_LOG on class CACSRO_CL_DOCUMENT_RETENTION has no parameter.
# Exception Resumable Description Created on
1 CX_CACS_DOCUMENT_ROOT Provisionsbeleg: Basisklasse Ausnahmebehandlung 20061102

Method SET_CURRENCY_FIELDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CS_DOCSEM Call by reference Type reference (TYPE) CACS00_S_DOCSEM Provisionsbeleg, Abrechnung (Metaobjekt) 20060825
2 Importing ID_DUE_CONAMNT Call by reference Type reference (TYPE) CACSDUECONAMNT Auszahlungsbereiter Vergütungsteilbetrag in Vertragswährung 20060825
3 Importing ID_INDCTR_CURR Call by reference Type reference (TYPE) CACSCONCURR Vertragswährungsschlüssel 20060825
# Exception Resumable Description Created on
1 CX_CACS_DOCUMENT_ROOT Einbehaltung: Basisklasse Ausnahmebehandlung 20060830

Method SET_IMPORT_DATE Signature

Method SET_IMPORT_DATE on class CACSRO_CL_DOCUMENT_RETENTION has no parameter.
Method SET_IMPORT_DATE on class CACSRO_CL_DOCUMENT_RETENTION has no exception.

Method SET_TEXT Signature

Method SET_TEXT on class CACSRO_CL_DOCUMENT_RETENTION has no parameter.
Method SET_TEXT on class CACSRO_CL_DOCUMENT_RETENTION has no exception.

Method SPLIT_TRI_BUSCASE_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ED_RETAGR_ID Call by reference Type reference (TYPE) CACSRETAGRID Nummer der Einbehaltungsvereinbarung 20060825
2 Exporting ED_RETRU_ID Call by reference Type reference (TYPE) CACSRETRUID Identifikation der Einbehaltungsregel 20060825

Method SPLIT_TRI_BUSCASE_ID on class CACSRO_CL_DOCUMENT_RETENTION has no exception.
History
Last changed by/on SAP  20100310 
SAP Release Created in 700