SAP ABAP Class /RPM/CL_USER_SETTINGS (Class to Persist User Settings)
Hierarchy
☛
CPRXRPM (Software Component) SAP Portfolio and Project Management 6.0
⤷
PPM-PFM (Application Component) Portfolio Management
⤷
/RPM/CORE (Package) xRPM Core Framework
⤷
⤷
Properties
| Class | /RPM/CL_USER_SETTINGS | |
| Short Description | Class to Persist User Settings | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | /RPM/CORE | xRPM Core Framework |
| Created | 20080410 | SAP |
| Last change | 20141109 | |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class /RPM/CL_USER_SETTINGS has no forward declaration.
Interfaces
Class /RPM/CL_USER_SETTINGS has no interface implemented.
Friends
Class /RPM/CL_USER_SETTINGS has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Private | Type reference (TYPE) | SPERS_KEY | '/RPM/USER_FIN_CAP_VIEW_HIER' | Personalization object key | 20090622 | ||
| 2 | Constant | Private | Type reference (TYPE) | SPERS_KEY | '/RPM/USER_OBJECT_CONTEXT' | Personalization Object Key | 20080429 | ||
| 3 | Constant | Private | Type reference (TYPE) | SPERS_KEY | '/RPM/USER_OBJECT_HIER' | Personalization Object Key | 20080729 | ||
| 4 | Static Attribute | Private | Type reference (TYPE) | SPERS_KEY | '/RPM/USER_PORTFOLIO_CONTEXT' | Personalization Object Key | 20080520 | ||
| 5 | Constant | Private | Type reference (TYPE) | SPERS_KEY | '/RPM/USER_PORTFOLIO_HIERARCHY' | Personalization object key | 20090525 | ||
| 6 | Constant | Private | Type reference (TYPE) | SPERS_KEY | '/RPM/USER_SCOPE_CONTEXT' | Personalization Object Key | 20080429 | ||
| 7 | Constant | Private | Type reference (TYPE) | SPERS_KEY | '/RPM/USER_VIEW_CONTEXT' | Personalization Object Key | 20080429 | ||
| 8 | Static Attribute | Private | Type reference (TYPE) | SPERS_KEY | '/RPM/USER_SEETING_FIN_CAP_DEC' | Personalization Object Key | 20090316 | ||
| 9 | Static Attribute | Private | Type reference (TYPE) | TS_OBJ_CTX_PER_USER | 20080429 | ||||
| 10 | Static Attribute | Private | Type reference (TYPE) | TS_OBJ_HIER_PER_USER | 20080729 | ||||
| 11 | Static Attribute | Private | Type reference (TYPE) | TS_PORT_CTX_PER_USER | 20080520 | ||||
| 12 | Static Attribute | Private | Type reference (TYPE) | TS_PORT_CTX_PER_USER | 20080617 | ||||
| 13 | Static Attribute | Private | Type reference (TYPE) | TS_PORT_HIER_PER_USER | 20090525 | ||||
| 14 | Static Attribute | Private | Type reference (TYPE) | TS_SCOPE_CTX_PER_USER | 20080429 | ||||
| 15 | Static Attribute | Private | Type reference (TYPE) | TS_VIEW_CTX_PER_USER | 20080429 | ||||
| 16 | Static Attribute | Private | Type reference (TYPE) | TT_OBJ_CTX_PER_USER | 20080429 | ||||
| 17 | Static Attribute | Private | Type reference (TYPE) | TT_OBJ_HIER_PER_USER | 20080729 | ||||
| 18 | Static Attribute | Private | Type reference (TYPE) | TT_PORT_CTX_PER_USER | 20080520 | ||||
| 19 | Static Attribute | Private | Type reference (TYPE) | TT_PORT_CTX_PER_USER | 20080617 | ||||
| 20 | Static Attribute | Private | Type reference (TYPE) | TT_PORT_HIER_PER_USER | 20090525 | ||||
| 21 | Static Attribute | Private | Type reference (TYPE) | TT_SCOPE_CTX_PER_USER | 20080429 | ||||
| 22 | Static Attribute | Private | Type reference (TYPE) | TT_VIEW_CTX_PER_USER | 20080429 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | Get User Object Context | 20080416 | |
| 2 | Static method | Public | Method | Get User Object Hierarchy | 20080729 | |
| 3 | Static method | Public | Method | Get User Portfolio Context | 20080520 | |
| 4 | Static method | Public | Method | Get User Portfolio Hierarchy | 20090525 | |
| 5 | Static method | Public | Method | Get User Scope Context | 20080416 | |
| 6 | Static method | Public | Method | Gets the User Settings from Personalization | 20090304 | |
| 7 | Static method | Public | Method | Get User View Context | 20080416 | |
| 8 | Static method | Public | Method | Saves the User Object Context to Personalization | 20080429 | |
| 9 | Static method | Public | Method | Saves the User Object Hierarchy to Personalization | 20080729 | |
| 10 | Static method | Public | Method | Saves the User Portfolio Context to Personalization | 20080520 | |
| 11 | Static method | Public | Method | Saves the User Portfolio Hierarchy | 20090525 | |
| 12 | Static method | Public | Method | Saves the User Scope Context to Personalization | 20080429 | |
| 13 | Static method | Public | Method | Saves the User View Context to Personalization | 20080429 | |
| 14 | Static method | Public | Method | Set User Object Context | 20080416 | |
| 15 | Static method | Public | Method | Set User Object Hierarchy | 20080729 | |
| 16 | Static method | Public | Method | Set User Portfolio Context | 20080520 | |
| 17 | Static method | Public | Method | Set User Portfolio Hierarchy | 20090525 | |
| 18 | Static method | Public | Method | Set User Scope Context | 20080416 | |
| 19 | Static method | Public | Method | Saves the User Settings to Personalization | 20090304 | |
| 20 | Static method | Public | Method | Set User View Context | 20080416 |
Events
Class /RPM/CL_USER_SETTINGS has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TS_FIN_CAP_DEC_PER_USER | Private | See coding | 20090316 | BEGIN OF ts_fin_cap_dec_per_user ,
user_id type xubname,
fin_dec type i,
cap_dec type i,
END OF ts_fin_cap_dec_per_user
|
||
| 2 | TS_OBJ_CTX_PER_USER | Private | See coding | 20080429 | BEGIN OF ts_obj_ctx_per_user,
user_id TYPE xubname,
user_obj_ctx_t TYPE /rpm/tt_user_object_context,
END OF ts_obj_ctx_per_user
|
||
| 3 | TS_OBJ_HIER_PER_USER | Private | See coding | 20080729 | BEGIN OF ts_obj_hier_per_user,
user_id TYPE xubname,
user_obj_hier TYPE inm_ts_nav_object_hier,
END OF ts_obj_hier_per_user
|
||
| 4 | TS_PORT_CTX_PER_USER | Private | See coding | 20080520 | BEGIN OF ts_port_ctx_per_user,
user_id TYPE xubname,
user_port_ctx TYPE /rpm/ts_user_portfolio_context,
END OF ts_port_ctx_per_user
|
||
| 5 | TS_PORT_HIER_PER_USER | Private | See coding | 20090525 | BEGIN OF ts_port_hier_per_user,
user_id TYPE xubname,
user_port_hier_t TYPE /rpm/tt_user_portfolio_hier,
END OF ts_port_hier_per_user
|
||
| 6 | TS_SCOPE_CTX_PER_USER | Private | See coding | 20080429 | BEGIN OF ts_scope_ctx_per_user,
user_id TYPE xubname,
user_scope_ctx_t TYPE /rpm/tt_user_scope_context,
END OF ts_scope_ctx_per_user
|
||
| 7 | TS_VIEW_CTX_PER_USER | Private | See coding | 20080429 | BEGIN OF ts_view_ctx_per_user,
user_id TYPE xubname,
user_view_ctx_t TYPE /rpm/tt_user_view_context,
END OF ts_view_ctx_per_user
|
||
| 8 | TT_OBJ_CTX_PER_USER | Private | See coding | 20080429 | tt_obj_ctx_per_user TYPE HASHED TABLE OF ts_obj_ctx_per_user
WITH UNIQUE KEY user_id
|
||
| 9 | TT_OBJ_HIER_PER_USER | Private | See coding | 20080729 | tt_obj_hier_per_user TYPE HASHED TABLE OF ts_obj_hier_per_user
WITH UNIQUE KEY user_id
|
||
| 10 | TT_PORT_CTX_PER_USER | Private | See coding | 20080520 | tt_port_ctx_per_user TYPE HASHED TABLE OF ts_port_ctx_per_user
WITH UNIQUE KEY user_id
|
||
| 11 | TT_PORT_HIER_PER_USER | Private | See coding | 20090525 | tt_port_hier_per_user TYPE HASHED TABLE OF ts_port_hier_per_user
WITH UNIQUE KEY user_id
|
||
| 12 | TT_SCOPE_CTX_PER_USER | Private | See coding | 20080429 | tt_scope_ctx_per_user TYPE HASHED TABLE OF ts_scope_ctx_per_user
WITH UNIQUE KEY user_id
|
||
| 13 | TT_VIEW_CTX_PER_USER | Private | See coding | 20080429 | tt_view_ctx_per_user TYPE HASHED TABLE OF ts_view_ctx_per_user
WITH UNIQUE KEY user_id
|
Method Signatures
Method GET_OBJECT_CONTEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_PORTFOLIO_GUID | Call by reference | Type reference (TYPE) | /RPM/TV_GUID | Guid for application objects | 20080515 | |||
| 2 | IV_USER_ID | Call by reference | Type reference (TYPE) | XUBNAME | User Name in User Master Record | 20080416 | |||
| 3 | RS_USER_OBJECT_CONTEXT | Value transfer | Type reference (TYPE) | /RPM/TS_USER_OBJECT_CONTEXT | Last User Object Context | 20080416 |
Method GET_OBJECT_CONTEXT on class /RPM/CL_USER_SETTINGS has no exception.
Method GET_OBJECT_HIERARCHY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_USER_ID | Call by reference | Type reference (TYPE) | XUBNAME | User Name in User Master Record | 20080729 | |||
| 2 | RS_USER_OBJECT_HIERARCHY | Value transfer | Type reference (TYPE) | INM_TS_NAV_OBJECT_HIER | Portfolio Hierarchy | 20080729 |
Method GET_OBJECT_HIERARCHY on class /RPM/CL_USER_SETTINGS has no exception.
Method GET_PORTFOLIO_CONTEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_USER_ID | Call by reference | Type reference (TYPE) | XUBNAME | User Name in User Master Record | 20080520 | |||
| 2 | RS_USER_PORTFOLIO_CONTEXT | Value transfer | Type reference (TYPE) | /RPM/TS_USER_PORTFOLIO_CONTEXT | Last User Portfolio Context | 20080520 |
Method GET_PORTFOLIO_CONTEXT on class /RPM/CL_USER_SETTINGS has no exception.
Method GET_PORTFOLIO_HIERARCHY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_PORTFOLIO_GUID | Call by reference | Type reference (TYPE) | /RPM/TV_GUID | Guid for application objects | 20090525 | |||
| 2 | IV_USER_ID | Call by reference | Type reference (TYPE) | XUBNAME | User Name in User Master Record | 20090525 | |||
| 3 | RS_USER_PORTFOLIO_HIER | Value transfer | Type reference (TYPE) | /RPM/TS_USER_PORTFOLIO_HIER | Last User Portfolio Hierarchy | 20090525 |
Method GET_PORTFOLIO_HIERARCHY on class /RPM/CL_USER_SETTINGS has no exception.
Method GET_SCOPE_CONTEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_LPD_ROLE | Call by reference | Type reference (TYPE) | INM_NAV_TV_LPD_ROLE | Report Launchpad Application ID | 20080430 | |||
| 2 | IV_USER_ID | Call by reference | Type reference (TYPE) | XUBNAME | User Name in User Master Record | 20080416 | |||
| 3 | RS_USER_SCOPE_CONTEXT | Value transfer | Type reference (TYPE) | /RPM/TS_USER_SCOPE_CONTEXT | Last User Scope Context | 20080416 |
Method GET_SCOPE_CONTEXT on class /RPM/CL_USER_SETTINGS has no exception.
Method GET_USER_SETTING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_CAP_DEC | Call by reference | Type reference (TYPE) | /RPM/TV_CAP_DECIMAL_PLACES | Number of Decimal Places | 20090316 | |||
| 2 | EV_FIN_CAP_HIER | Call by reference | Type reference (TYPE) | /RPM/TV_HIER_TYPE | Financial / Capacity Planning Hierarchy Type | 20090622 | |||
| 3 | EV_FIN_DEC | Call by reference | Type reference (TYPE) | /RPM/TV_FIN_DECIMAL_PLACES | Number of Decimal Places | 20090316 | |||
| 4 | EV_SHOW_CHANGE_DOC | Call by reference | Type reference (TYPE) | DPR_TV_SHOW_CHANGE_DOCS | Display Change Documents | 20090304 | |||
| 5 | IV_USER_NAME | Call by reference | Type reference (TYPE) | SYUNAME | User Name | 20090304 |
Method GET_USER_SETTING on class /RPM/CL_USER_SETTINGS has no exception.
Method GET_VIEW_CONTEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_FPM_VARIANT | Call by reference | Type reference (TYPE) | INM_NAV_TV_VARIANT_ID | FPM Variant Id | 20080612 | |||
| 2 | IV_USER_ID | Call by reference | Type reference (TYPE) | XUBNAME | User Name in User Master Record | 20080429 | |||
| 3 | RS_USER_VIEW_CONTEXT | Value transfer | Type reference (TYPE) | /RPM/TS_USER_VIEW_CONTEXT | Last User View Context | 20080429 |
Method GET_VIEW_CONTEXT on class /RPM/CL_USER_SETTINGS has no exception.
Method SAVE_OBJECT_CONTEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_USER_ID | Call by reference | Type reference (TYPE) | XUBNAME | User Name in User Master Record | 20080429 |
Method SAVE_OBJECT_CONTEXT on class /RPM/CL_USER_SETTINGS has no exception.
Method SAVE_OBJECT_HIERARCHY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_USER_ID | Call by reference | Type reference (TYPE) | XUBNAME | User Name in User Master Record | 20080729 |
Method SAVE_OBJECT_HIERARCHY on class /RPM/CL_USER_SETTINGS has no exception.
Method SAVE_PORTFOLIO_CONTEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_USER_ID | Call by reference | Type reference (TYPE) | XUBNAME | User Name in User Master Record | 20080520 |
Method SAVE_PORTFOLIO_CONTEXT on class /RPM/CL_USER_SETTINGS has no exception.
Method SAVE_PORTFOLIO_HIERARCHY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_USER_ID | Call by reference | Type reference (TYPE) | XUBNAME | User Name in User Master Record | 20090525 |
Method SAVE_PORTFOLIO_HIERARCHY on class /RPM/CL_USER_SETTINGS has no exception.
Method SAVE_SCOPE_CONTEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_USER_ID | Call by reference | Type reference (TYPE) | XUBNAME | User Name in User Master Record | 20080429 |
Method SAVE_SCOPE_CONTEXT on class /RPM/CL_USER_SETTINGS has no exception.
Method SAVE_VIEW_CONTEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_USER_ID | Call by reference | Type reference (TYPE) | XUBNAME | User Name in User Master Record | 20080429 |
Method SAVE_VIEW_CONTEXT on class /RPM/CL_USER_SETTINGS has no exception.
Method SET_OBJECT_CONTEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_USER_OBJECT_CONTEXT | Call by reference | Type reference (TYPE) | /RPM/TS_USER_OBJECT_CONTEXT | Last User Object Context | 20080416 | |||
| 2 | IV_USER_ID | Call by reference | Type reference (TYPE) | XUBNAME | User Name in User Master Record | 20080416 |
Method SET_OBJECT_CONTEXT on class /RPM/CL_USER_SETTINGS has no exception.
Method SET_OBJECT_HIERARCHY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_USER_OBJECT_HIERARCHY | Call by reference | Type reference (TYPE) | INM_TS_NAV_OBJECT_HIER | Portfolio Hierarchy | 20080729 | |||
| 2 | IV_USER_ID | Call by reference | Type reference (TYPE) | XUBNAME | User Name in User Master Record | 20080729 |
Method SET_OBJECT_HIERARCHY on class /RPM/CL_USER_SETTINGS has no exception.
Method SET_PORTFOLIO_CONTEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_USER_PORTFOLIO_CONTEXT | Call by reference | Type reference (TYPE) | /RPM/TS_USER_PORTFOLIO_CONTEXT | Last User Portfolio Context | 20080520 | |||
| 2 | IV_USER_ID | Call by reference | Type reference (TYPE) | XUBNAME | User Name in User Master Record | 20080520 |
Method SET_PORTFOLIO_CONTEXT on class /RPM/CL_USER_SETTINGS has no exception.
Method SET_PORTFOLIO_HIERARCHY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_USER_PORTFOLIO_HIER | Call by reference | Type reference (TYPE) | /RPM/TS_USER_PORTFOLIO_HIER | Last User Portfolio Hierarchy | 20090525 | |||
| 2 | IV_USER_ID | Call by reference | Type reference (TYPE) | XUBNAME | User Name in User Master Record | 20090525 |
Method SET_PORTFOLIO_HIERARCHY on class /RPM/CL_USER_SETTINGS has no exception.
Method SET_SCOPE_CONTEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_USER_SCOPE_CONTEXT | Call by reference | Type reference (TYPE) | /RPM/TS_USER_SCOPE_CONTEXT | Last User Scope Context | 20080416 | |||
| 2 | IV_USER_ID | Call by reference | Type reference (TYPE) | XUBNAME | User Name in User Master Record | 20080416 |
Method SET_SCOPE_CONTEXT on class /RPM/CL_USER_SETTINGS has no exception.
Method SET_USER_SETTING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MSG | Call by reference | Type reference (TYPE) | /RPM/TT_MESSAGES | Messages | 20090316 | |||
| 2 | EV_RC | Call by reference | Type reference (TYPE) | I | Return Code | 20090316 | |||
| 3 | IV_CAP_DEC | Call by reference | Type reference (TYPE) | /RPM/TV_CAP_DECIMAL_PLACES | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20090304 | |||
| 4 | IV_FIN_CAP_HIER | Call by reference | Type reference (TYPE) | /RPM/TV_HIER_TYPE | Financial / Capacity Planning Hierarchy Type | 20090622 | |||
| 5 | IV_FIN_DEC | Call by reference | Type reference (TYPE) | /RPM/TV_FIN_DECIMAL_PLACES | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20090316 | |||
| 6 | IV_SHOW_CHANGE_DOC | Call by reference | Type reference (TYPE) | DPR_TV_SHOW_CHANGE_DOCS | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20090304 | |||
| 7 | IV_USER_NAME | Call by reference | Type reference (TYPE) | SYUNAME | User Name | 20090304 |
Method SET_USER_SETTING on class /RPM/CL_USER_SETTINGS has no exception.
Method SET_VIEW_CONTEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_USER_VIEW_CONTEXT | Call by reference | Type reference (TYPE) | /RPM/TS_USER_VIEW_CONTEXT | Last User View Context | 20080429 | |||
| 2 | IV_USER_ID | Call by reference | Type reference (TYPE) | XUBNAME | User Name in User Master Record | 20080429 |
Method SET_VIEW_CONTEXT on class /RPM/CL_USER_SETTINGS has no exception.
History
| Last changed by/on | SAP | 20141109 |
| SAP Release Created in | 500_701 |