SAP ABAP Class CL_USER_DEFAULTS (User Settings)
Hierarchy
☛
SAP_ABA (Software Component) Cross-Application Component
⤷
CA-GTF-TS-BRHF (Application Component) Basis-Related Help Functions, Appl. Log, Formula Intepreter
⤷
BALV_ADDON (Package) Additional Functions with ALV Grid
SAP_ABA (Software Component) Cross-Application Component⤷
CA-GTF-TS-BRHF (Application Component) Basis-Related Help Functions, Appl. Log, Formula Intepreter⤷
BALV_ADDON (Package) Additional Functions with ALV GridProperties
| Class | CL_USER_DEFAULTS | |
| Short Description | User Settings | |
| Super Class | ||
| Instantiability of a Class | 1 | Protected |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | BALV_ADDON | Additional Functions with ALV Grid |
| Created | 20030425 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  SLIS |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_USER_DEFAULTS has no interface implemented.
Friends
Class CL_USER_DEFAULTS has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CO_X |
Constant | Protected | Type reference (TYPE) | XFELD | 'X' | Constant 'X' | 20030425 | |
| 2 | DEFAULTS_BUFFER |
Instance attribute | Private | Type reference (TYPE) | USRDFLT_ITAB | User Settings - Buffer | 20030425 | ||
| 3 | DEFAULTS_DB |
Instance attribute | Private | Type reference (TYPE) | USRDFLT_ITAB | User Settings - DB Status | 20030425 | ||
| 4 | GC_FCODE_CLOSE |
Constant | Public | Type reference (TYPE) | SY-UCOMM | 'UD_CLOSE_DFLT_GRID' | Close ALV Grid | 20030507 | |
| 5 | INST_LN |
Static Attribute | Private | Type reference (TYPE) | TY_INST_LN | Line of Instance Table | 20030425 | ||
| 6 | INST_TAB |
Static Attribute | Private | Type reference (TYPE) | TY_INST_TAB | Instance Table | 20030425 | ||
| 7 | KEY |
Instance attribute | Public | Type reference (TYPE) | USRDFLT_KEY | Key for User Settings | 20030425 | ||
| 8 | PERS_KEY |
Instance attribute | Public | Type reference (TYPE) | SPERS_KEY | Key for Personalization | 20030425 | ||
| 9 | UNAME |
Instance attribute | Public | Type reference (TYPE) | SY-UNAME | ABAP System, User Logon Name | 20030425 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CHANGE |
Static method | Public | Method | Change User Settings | 20030502 |
| 2 | CONSTRUCTOR |
Instance method | Public | Constructor | Constructor | 20030425 |
| 3 | DISPLAY |
Static method | Public | Method | Display User Settings | 20030502 |
| 4 | GET |
Instance method | Public | Method | Provide All User Settings | 20030425 |
| 5 | GET_ALL |
Static method | Private | Method | Provide All Default Values for User | 20030425 |
| 6 | GET_INSTANCE |
Static method | Public | Method | Provide Object Instance | 20030425 |
| 7 | GET_SINGLE_VALUE |
Instance method | Public | Method | Provide Individual User Setting | 20030425 |
| 8 | GET_STRUCTURE_VALUES |
Instance method | Public | Method | Provide User Settings in Structural Form | 20030428 |
| 9 | RAISE_EVENT |
Static method | Private | Method | Trigger Events | 20030505 |
| 10 | SAVE |
Instance method | Public | Method | Write Settings in the Buffer to the Database | 20030425 |
| 11 | SAVE_ALL |
Static method | Public | Method | Write Settings of All Instances to the Database | 20030507 |
| 12 | SET_SINGLE_VALUE |
Instance method | Public | Method | Write Individual User Setting to the Buffer | 20030425 |
| 13 | SET_STRUCTURE_VALUES |
Instance method | Public | Method | Write Values of a Structure to the Buffer | 20030428 |
Events
| # | Event | Type | Visibility | Description | Created on |
|---|---|---|---|---|---|
| 1 | CHANGE_REQUESTED | Static Event (1) |
Public (2) |
Change to User Settings Requested | 20030505 |
| 2 | DISPLAY_REQUESTED | Static Event (1) |
Public (2) |
Display of User Settings Requested | 20030505 |
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_INST_LN | Private | See coding | Line of Instance Administration Table | 20030425 | begin of ty_inst_ln,
report type programm,
handle type slis_handl,
uname type sy-uname,
pers_key type spers_key,
objref type ref to cl_user_defaults,
end of ty_inst_ln
|
|
| 2 | TY_INST_TAB | Private | See coding | Instance Administration Table | 20030425 | ty_inst_tab type hashed table of ty_inst_ln
with unique key report handle uname pers_key
|
Method Signatures
Method CHANGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IO_CONTAINER | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | Contaiener fuer Anzeige des Controls | 20030507 | ||
| 2 | Importing |
IV_PERS_KEY | Call by reference | Type reference (TYPE) | SPERS_KEY | 'USER_DEFAULTS_GEN' | Schluessel fuer Personalisierung | 20030502 | |
| 3 | Importing |
IV_STRUCTURE_NAME | Call by reference | Type reference (TYPE) | USRDFLT_STRUCTURE_NAME | Strukturname der Personalisierungsdaten | 20030502 | ||
| 4 | Importing |
IV_USER_ID | Call by reference | Type reference (TYPE) | SY-UNAME | SY-UNAME | R/3-System, Anmeldename des Benutzers | 20030502 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_USER_DEFAULTS |
Ausnahmen für Benutzereinstellungen | 20030520 |
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_CALLING_PROGRAM | Call by reference | Type reference (TYPE) | PROGRAMM | ABAP-Programmname | 20030429 | ||
| 2 | Importing |
IV_HANDLE | Call by reference | Type reference (TYPE) | SLIS_HANDL | VerwaltungsID für Mehrfachaufrufe aus dem selben Programm | 20030429 | ||
| 3 | Importing |
IV_PERS_KEY | Call by reference | Type reference (TYPE) | SPERS_KEY | 'USER_DEFAULTS_GEN' | Schluessel fuer Personalisierung | 20030429 | |
| 4 | Importing |
IV_USER_ID | Call by reference | Type reference (TYPE) | SY-UNAME | SY-UNAME | R/3-System, Anmeldename des Benutzers | 20030429 |
Method CONSTRUCTOR on class CL_USER_DEFAULTS has no exception.
Method DISPLAY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_CONTAINER | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | Container fuer Anzeige des Controls | 20030507 | ||
| 2 | Importing |
IV_PERS_KEY | Call by reference | Type reference (TYPE) | SPERS_KEY | 'USER_DEFAULTS_GEN' | Schluessel fuer Personalisierung | 20030502 | |
| 3 | Importing |
IV_STRUCTURE_NAME | Call by reference | Type reference (TYPE) | USRDFLT_STRUCTURE_NAME | Strukturname der Personalisierungsdaten | 20030502 | ||
| 4 | Importing |
IV_USER_ID | Call by reference | Type reference (TYPE) | SY-UNAME | SY-UNAME | R/3-System, Anmeldename des Benutzers | 20030502 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_USER_DEFAULTS |
Ausnahmen für Benutzereinstellungen | 20030520 |
Method GET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
RT_DEFAULTS | Value transfer | Type reference (TYPE) | USRDFLT_ITAB | Benutzereinstellungen | 20030429 |
Method GET on class CL_USER_DEFAULTS has no exception.
Method GET_ALL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_PERS_KEY | Call by reference | Type reference (TYPE) | SPERS_KEY | Schluessel fuer Personalisierung | 20030502 | ||
| 2 | Importing |
IV_UNAME | Call by reference | Type reference (TYPE) | SY-UNAME | Benutzer | 20030502 | ||
| 3 | Returning |
RT_DEFAULTS | Value transfer | Type reference (TYPE) | USRDFLT_PERS_ITAB | Benutzereinstellungen | 20030429 |
Method GET_ALL on class CL_USER_DEFAULTS has no exception.
Method GET_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_CALLING_PROGRAM | Call by reference | Type reference (TYPE) | PROGRAMM | ABAP-Programmname | 20030429 | ||
| 2 | Importing |
IV_HANDLE | Call by reference | Type reference (TYPE) | SLIS_HANDL | VerwaltungsID für Mehrfachaufrufe aus dem selben Programm | 20030429 | ||
| 3 | Importing |
IV_PERS_KEY | Call by reference | Type reference (TYPE) | SPERS_KEY | 'USER_DEFAULTS_GEN' | Schluessel fuer Personalisierung | 20030429 | |
| 4 | Importing |
IV_USER_ID | Call by reference | Type reference (TYPE) | SY-UNAME | SY-UNAME | R/3-System, Anmeldename des Benutzers | 20030429 | |
| 5 | Returning |
RO_OBJREF | Value transfer | Object reference (TYPE REF TO) | CL_USER_DEFAULTS | Instanz der Benutzereinstellungen | 20030429 |
Method GET_INSTANCE on class CL_USER_DEFAULTS has no exception.
Method GET_SINGLE_VALUE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
EV_VALUE | Call by reference | Type reference (TYPE) | ANY | Inhalt des Vorschlagswertes | 20030429 | ||
| 2 | Importing |
IV_FIELD_NAME | Call by reference | Type reference (TYPE) | ANY | Name des Vorschlagswertes | 20030429 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | FAILED |
Keine Vorschlagswerte zu diesem Feld vorhanden | 20030425 |
Method GET_STRUCTURE_VALUES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ES_VALUES | Call by reference | Type reference (TYPE) | ANY | Strukturwerte | 20030429 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | STRUCTURE_INVALID |
Parameter es_values zeigt nicht auf eine Struktur | 20030428 |
Method RAISE_EVENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_ALV_GRID | Call by reference | Object reference (TYPE REF TO) | CL_GUI_ALV_GRID | Referenz auf ALV Grid | 20030505 | ||
| 2 | Importing |
IR_DEFAULTS | Call by reference | Object reference (TYPE REF TO) | USRDFLT_PERS_ALV_ITAB | Benutzereinstellungen | 20030508 | ||
| 3 | Importing |
IR_FIELDCAT | Call by reference | Object reference (TYPE REF TO) | LVC_T_FCAT | ALV Feldkatalog | 20030508 | ||
| 4 | Importing |
IR_LAYOUT | Call by reference | Object reference (TYPE REF TO) | LVC_S_LAYO | ALV Layout | 20030508 | ||
| 5 | Importing |
IR_SORTCAT | Call by reference | Object reference (TYPE REF TO) | LVC_T_SORT | ALV Sortierkatalog | 20030508 | ||
| 6 | Importing |
IV_EVENT_ID | Call by reference | Type reference (TYPE) | C | '01' | 01 = Aendern '02' = Anzeigen requested | 20030505 | |
| 7 | Importing |
IV_PERS_KEY | Call by reference | Type reference (TYPE) | SPERS_KEY | Schluessel fuer Personalisierung | 20030508 | ||
| 8 | Importing |
IV_USER_ID | Call by reference | Type reference (TYPE) | SY-UNAME | Benutzername | 20030508 |
Method RAISE_EVENT on class CL_USER_DEFAULTS has no exception.
Method SAVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_DEFAULTS_TO_DELETE | Call by reference | Type reference (TYPE) | USRDFLT_ITAB | Zu loeschende Benutzereinstellungen | 20030429 |
Method SAVE on class CL_USER_DEFAULTS has no exception.
Method SAVE_ALL Signature
Method SAVE_ALL on class CL_USER_DEFAULTS has no parameter.
Method SAVE_ALL on class CL_USER_DEFAULTS has no exception.
Method SET_SINGLE_VALUE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_FIELD_NAME | Call by reference | Type reference (TYPE) | ANY | Name des Vorschlagswertes | 20030429 | ||
| 2 | Importing |
IV_VALUE | Call by reference | Type reference (TYPE) | ANY | Inhalt des Vorschlagswertes | 20030429 |
Method SET_SINGLE_VALUE on class CL_USER_DEFAULTS has no exception.
Method SET_STRUCTURE_VALUES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_VALUES | Call by reference | Type reference (TYPE) | ANY | Strukturwerte | 20030429 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | STRUCTURE_INVALID |
Parameter is_values zeigt nicht auf eine Struktur | 20030428 |
Event Signatures
Event CHANGE_REQUESTED Signature
| # | Parameter | Type | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EO_ALV_GRID | Exporting | Value transfer | Object reference (TYPE REF TO) | CL_GUI_ALV_GRID | Referenz auf ALV Grid | 20030505 | ||
| 2 | ER_DEFAULTS | Exporting | Value transfer | Object reference (TYPE REF TO) | USRDFLT_PERS_ALV_ITAB | Benutzereinstellungen | 20030508 | ||
| 3 | ER_FIELDCAT | Exporting | Value transfer | Object reference (TYPE REF TO) | LVC_T_FCAT | ALV Feldkatalog | 20030508 | ||
| 4 | ER_LAYOUT | Exporting | Value transfer | Object reference (TYPE REF TO) | LVC_S_LAYO | ALV Layout | 20030508 | ||
| 5 | ER_SORTCAT | Exporting | Value transfer | Object reference (TYPE REF TO) | LVC_T_SORT | ALV Sortierkriterien | 20030508 | ||
| 6 | EV_PERS_KEY | Exporting | Value transfer | Type reference (TYPE) | SPERS_KEY | Schluessel fuer Personalisierung | 20030508 | ||
| 7 | EV_USER_ID | Exporting | Value transfer | Type reference (TYPE) | SY-UNAME | Benutzername | 20030508 |
Event DISPLAY_REQUESTED Signature
| # | Parameter | Type | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EO_ALV_GRID | Exporting | Value transfer | Object reference (TYPE REF TO) | CL_GUI_ALV_GRID | Referenz auf ALV Grid | 20030505 | ||
| 2 | ER_DEFAULTS | Exporting | Value transfer | Object reference (TYPE REF TO) | USRDFLT_PERS_ALV_ITAB | Benutzereinstellungen | 20030508 | ||
| 3 | ER_FIELDCAT | Exporting | Value transfer | Object reference (TYPE REF TO) | LVC_T_FCAT | ALV Feldkatalog | 20030508 | ||
| 4 | ER_LAYOUT | Exporting | Value transfer | Object reference (TYPE REF TO) | LVC_S_LAYO | ALV Layout | 20030508 | ||
| 5 | ER_SORTCAT | Exporting | Value transfer | Object reference (TYPE REF TO) | LVC_T_SORT | ALV Sortierkriterien | 20030508 | ||
| 6 | EV_PERS_KEY | Exporting | Value transfer | Type reference (TYPE) | SPERS_KEY | Schluessel fuer Personalisierung | 20030508 | ||
| 7 | EV_USER_ID | Exporting | Value transfer | Type reference (TYPE) | SY-UNAME | Benutzername | 20030508 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 640 |
