SAP ABAP Class CL_CRM_PORTAL_APPL_CONTROLLER (Portal Application Controller Class)
Hierarchy
☛
WEBCUIF (Software Component) SAP Web UI Framework
⤷
CA-WUI-EP (Application Component) UI Portal Integration
⤷
CRM_BSP_UI_FRAME_PORTAL (Package) Application Frame for CRM in Enterprise Portal
WEBCUIF (Software Component) SAP Web UI Framework⤷
CA-WUI-EP (Application Component) UI Portal Integration⤷
CRM_BSP_UI_FRAME_PORTAL (Package) Application Frame for CRM in Enterprise PortalMeta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_CRM_UI_CORE_APPL_CONTROLLER | 20070709 |
Properties
| Class | CL_CRM_PORTAL_APPL_CONTROLLER | |
| Short Description | Portal Application Controller Class | |
| Super Class | CL_CRM_UI_CORE_APPL_CONTROLLER | |
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | CRM_BSP_UI_FRAME_PORTAL | Application Frame for CRM in Enterprise Portal |
| Created | 20070709 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  ABAP |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_CRM_PORTAL_APPL_CONTROLLER has no interface implemented.
Friends
Class CL_CRM_PORTAL_APPL_CONTROLLER has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_BO_CRMLINKNAV |
Constant | Protected | Type reference (TYPE) | STRING | 'CRMLinkNav' | BO CRMLinkNav for OBN | 20070717 | |
| 2 | GC_EXTREQT_BREADCRUMB_RESTORE |
Constant | Public | Type reference (TYPE) | CRMT_UIF_EXT_REQUEST_TYPE | 'B' | Restore of Old Bread Crumb State | 20070802 | |
| 3 | GC_EXTREQT_DATA_LOSS |
Constant | Public | Type reference (TYPE) | CRMT_UIF_EXT_REQUEST_TYPE | 'D' | Data Loss Request | 20070710 | |
| 4 | GC_EXTREQT_DIRECT_LINK_GROUP |
Constant | Public | Type reference (TYPE) | CRMT_UIF_EXT_REQUEST_TYPE | 'G' | Direct Link Group Request | 20070723 | |
| 5 | GC_EXTREQT_HIGHLIGHTING |
Constant | Public | Type reference (TYPE) | CRMT_UIF_EXT_REQUEST_TYPE | 'H' | Highlighting Request | 20070822 | |
| 6 | GC_EXTREQT_LOGICAL_LINK |
Constant | Public | Type reference (TYPE) | CRMT_UIF_EXT_REQUEST_TYPE | 'L' | Logical Link Request | 20070710 | |
| 7 | GC_EXTREQT_OBJECT_BASED |
Constant | Public | Type reference (TYPE) | CRMT_UIF_EXT_REQUEST_TYPE | 'O' | OBN Request | 20070710 | |
| 8 | GC_INTERNAL_DATA_LOSS_CANCEL |
Constant | Protected | Type reference (TYPE) | STRING | 'CANCEL' | Portal data loss cancel | 20070816 | |
| 9 | GC_INTERNAL_DATA_LOSS_REVERT |
Constant | Protected | Type reference (TYPE) | STRING | 'DESKTOP' | Portal data loss revert | 20070816 | |
| 10 | GC_LOGICAL_PORT_NAME |
Constant | Protected | Type reference (TYPE) | PRX_LOGICAL_PORT_NAME | 'CRM_EP_DEST' | name of logical port for OBN web service | 20070926 | |
| 11 | GC_SYSTEM_ALIAS |
Constant | Public | Type reference (TYPE) | STRING | 'SAP_CRM_UI' | CRM System Alias | 20070718 | |
| 12 | GC_URL_DATA_LOSS |
Static Attribute | Protected | Type reference (TYPE) | STRING | 'crm-data-loss' | URL parameter to indicate data loss check | 20070709 | |
| 13 | GC_URL_DQUERY_ADVANCED |
Constant | Protected | Type reference (TYPE) | STRING | 'crm-dquery-advanced' | URL parameter for dQuery advanced | 20071107 | |
| 14 | GC_URL_DQUERY_BOL_TYPE |
Constant | Protected | Type reference (TYPE) | STRING | 'crm-dquery-type' | Url Parameter for dQuery Bol Type | 20070712 | |
| 15 | GC_URL_DQUERY_PARAM_NAME |
Constant | Protected | Type reference (TYPE) | STRING | 'crm-dquery-name' | URL parameter for dQuery param name | 20070713 | |
| 16 | GC_URL_DQUERY_PARAM_OP |
Constant | Protected | Type reference (TYPE) | STRING | 'crm-dquery-op' | URL parameter for dQuery param option | 20070713 | |
| 17 | GC_URL_DQUERY_PARAM_SIGN |
Constant | Protected | Type reference (TYPE) | STRING | 'crm-dquery-sign' | URL parameter for dQuery param sign | 20070713 | |
| 18 | GC_URL_DQUERY_PARAM_VALUE |
Constant | Protected | Type reference (TYPE) | STRING | 'crm-dquery-value' | URL parameter for dQuery param value | 20070713 | |
| 19 | GC_URL_LOGICAL_LINK |
Constant | Protected | Type reference (TYPE) | STRING | 'crm-logical-link' | 20070709 | ||
| 20 | GC_URL_NODEPRTEVENT |
Constant | Protected | Type reference (TYPE) | STRING | 'nodeprtevent' | URL parameter for nodeprtevent (used only internally) | 20070719 | |
| 21 | GC_URL_PORTAL_ROLE |
Constant | Protected | Type reference (TYPE) | STRING | 'crm-portal-role' | Url Parameter for portal role | 20070724 | |
| 22 | GC_URL_PORTAL_THEME |
Constant | Public | Type reference (TYPE) | STRING | 'crm-portal-theme' | Url Parameter for portal theme | 20070717 | |
| 23 | GC_URL_ROOT_BOL_KEY |
Constant | Protected | Type reference (TYPE) | STRING | 'crm-root-key' | URL parameter for BOL root object name | 20070717 | |
| 24 | GC_URL_ROOT_BOL_TYPE |
Constant | Protected | Type reference (TYPE) | STRING | 'crm-root-type' | URL parameter for BOL root object name | 20070717 | |
| 25 | GR_OBN |
Instance attribute | Protected | Object reference (TYPE REF TO) | CL_WDR_PORTAL_OBNWEB_SERVICE | Portal OBN Web Service | 20070919 | ||
| 26 | GS_DEBUG_SUPPORT |
Instance attribute | Public | Type reference (TYPE) | CRMT_UIF_DEBUG | Activate Debugging Of Special UI Framework Parts | 20070824 | ||
| 27 | GT_GENERIC_OP_MAP |
Instance attribute | Protected | Type reference (TYPE) | CRMT_UI_CMP_MAP | generic op mapping | 20070811 | ||
| 28 | GT_HISTORY_STATE |
Instance attribute | Public | Type reference (TYPE) | CRMTT_UIF_HISTORY_STATE | Changed History States | 20070809 | ||
| 29 | GT_OBN_TARGETS |
Instance attribute | Protected | Type reference (TYPE) | WDR_TARGET_STRUCT_TAB | targets for BO CRMLinkNav | 20070926 | ||
| 30 | GV_ALTERNATIVE_RESPONSE |
Instance attribute | Public | Type reference (TYPE) | STRING | Alternative response | 20070712 | ||
| 31 | GV_BREADCRUMB_NAVIGATION_ALLOW |
Instance attribute | Protected | Type reference (TYPE) | ABAP_BOOL | False if brdcrmb navigation is forbidden due to mand fields | 20080702 | ||
| 32 | GV_DETERMINATION |
Instance attribute | Protected | Object reference (TYPE REF TO) | CL_CRM_UI_PROFILE_DETERM | Profile determination | 20070710 | ||
| 33 | GV_DLG |
Instance attribute | Protected | Type reference (TYPE) | STRING | direct link group link | 20070904 | ||
| 34 | GV_EPCM_CORE_URL |
Instance attribute | Public | Type reference (TYPE) | STRING | url for epcm core | 20070723 | ||
| 35 | GV_EPCM_INIT_URL |
Instance attribute | Public | Type reference (TYPE) | STRING | url for epcm init | 20070723 | ||
| 36 | GV_EXTERNAL_REQUEST_TYPE |
Instance attribute | Public | Type reference (TYPE) | CRMT_UIF_EXT_REQUEST_TYPE | Type Of External Request Into UI Framework | 20070710 | ||
| 37 | GV_INTERNAL_DATA_LOSS_RESULT |
Instance attribute | Protected | Type reference (TYPE) | STRING | Result of portal data loss when used internally | 20070816 | ||
| 38 | GV_PORTAL_DATA_LOSS_REQUIRED |
Instance attribute | Protected | Type reference (TYPE) | ABAP_BOOL | True if portal data loss is required | 20070709 | ||
| 39 | GV_PORTAL_SCRIPT_URL |
Instance attribute | Public | Type reference (TYPE) | STRING | url for portal_oo.js script | 20070712 | ||
| 40 | GV_URL_PORTAL_ROLE |
Instance attribute | Protected | Type reference (TYPE) | STRING | portal role | 20070724 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | GET_HISTORY_IS_CREATE_PENDING |
Instance method | Public | Method | Get Info Whether A Corresponding State Creation Is Pending | 20080206 |
| 2 | GET_HISTORY_IS_RESTORE_PENDING |
Instance method | Public | Method | Get Info Whether A State Restore Is Pending | 20070828 |
| 3 | GET_HISTORY_STATE |
Instance method | Public | Method | Get State of History Manager | 20070723 |
| 4 | GET_HISTORY_URL_PARAMS |
Instance method | Protected | Method | Get Portal History Parameters | 20070905 |
| 5 | GET_OBN_TARGET_IVIEW |
Instance method | Protected | Method | Returns iview name for target if existing | 20070710 |
| 6 | GET_SCRIPT_AFP_MASTHEAD |
Instance method | Public | Method | Get js to insert CRM masthead links into portal AFP masthead | 20090831 |
| 7 | GET_SCRIPT_FOR_OBN |
Instance method | Protected | Method | Gets the script for triggering OBN navigation | 20070712 |
| 8 | IS_WORKPROTECT_REQUIRED |
Instance method | Public | Method | Simulates a data loss for an appl. comp | 20090925 |
| 9 | PREPARE_CENTRAL_SEARCH |
Instance method | Protected | Method | Sets the central search parameters from URL parameters | 20070713 |
| 10 | PROFILE_DETERMINATION |
Instance method | Protected | Method | Analysis of URL parameter saprole, will load business role | 20070709 |
| 11 | RENDER_DATALOSS_SCRIPT |
Instance method | Public | Method | renders javascript to invoke data loss if request | 20070816 |
| 12 | RENDER_RESTART_SCRIPT |
Instance method | Public | Method | renders javascript to invoke immediate restart if request | 20080519 |
| 13 | SET_DATA_FOR_DATALOSS_CHECK |
Instance method | Public | Method | 20080207 | |
| 14 | SET_EXTERNAL_REQUEST_TYPE |
Instance method | Public | Method | 20080207 | |
| 15 | SET_HISTORY_DEBUG_SUPPORT |
Instance method | Protected | Method | Set History Debug Support To Active | 20070824 |
Events
Class CL_CRM_PORTAL_APPL_CONTROLLER has no event.
Types
Class CL_CRM_PORTAL_APPL_CONTROLLER has no local type.
Method Signatures
Method GET_HISTORY_IS_CREATE_PENDING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IT_HISTORY_STATE | Call by reference | Type reference (TYPE) | CRMTT_UIF_HISTORY_STATE | History State Info (UI Framework In Context of Portal) | 20080206 | ||
| 2 | Importing |
IV_STATE_ID | Call by reference | Type reference (TYPE) | IHTTPNAM | Breadcrumb State ID | 20080206 | ||
| 3 | Importing |
IV_TABIX | Call by reference | Type reference (TYPE) | SYTABIX | Index of Internal Tables | 20080206 | ||
| 4 |  Returning |
RV_RESULT | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20080206 |
Method GET_HISTORY_IS_CREATE_PENDING on class CL_CRM_PORTAL_APPL_CONTROLLER has no exception.
Method GET_HISTORY_IS_RESTORE_PENDING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_HISTORY_STATE | Call by reference | Type reference (TYPE) | CRMTT_UIF_HISTORY_STATE | History State Info (UI Framework In Context of Portal) | 20070828 | ||
| 2 | Importing |
IV_TABIX | Call by reference | Type reference (TYPE) | SYTABIX | Index of Internal Tables | 20070828 | ||
| 3 | Returning |
RV_RESULT | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20070828 |
Method GET_HISTORY_IS_RESTORE_PENDING on class CL_CRM_PORTAL_APPL_CONTROLLER has no exception.
Method GET_HISTORY_STATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_CURRENT_ID | Value transfer | Type reference (TYPE) | IHTTPNAM | HTTP Framework (iHTTP) HTTP Name | 20070905 |
Method GET_HISTORY_STATE on class CL_CRM_PORTAL_APPL_CONTROLLER has no exception.
Method GET_HISTORY_URL_PARAMS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
EV_SESSION_ID | Call by reference | Type reference (TYPE) | STRING | 20070905 | |||
| 2 | Exporting |
EV_STATE_ID | Call by reference | Type reference (TYPE) | IHTTPNAM | HTTP Framework (iHTTP) HTTP Name | 20070905 |
Method GET_HISTORY_URL_PARAMS on class CL_CRM_PORTAL_APPL_CONTROLLER has no exception.
Method GET_OBN_TARGET_IVIEW Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
IVIEW_NAME | Value transfer | Type reference (TYPE) | STRING | 20070710 | |||
| 2 | Importing |
OBJECT_NAME | Call by reference | Type reference (TYPE) | STRING | 20070710 | |||
| 3 | Importing |
OPERATION | Call by reference | Type reference (TYPE) | STRING | 20070710 |
Method GET_OBN_TARGET_IVIEW on class CL_CRM_PORTAL_APPL_CONTROLLER has no exception.
Method GET_SCRIPT_AFP_MASTHEAD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_SCRIPT | Value transfer | Type reference (TYPE) | STRING | 20090831 |
Method GET_SCRIPT_AFP_MASTHEAD on class CL_CRM_PORTAL_APPL_CONTROLLER has no exception.
Method GET_SCRIPT_FOR_OBN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
EV_SCRIPT | Value transfer | Type reference (TYPE) | STRING | java script | 20070712 | ||
| 2 | Importing |
IV_IVIEW_NAME | Call by reference | Type reference (TYPE) | STRING | iview name | 20070806 | ||
| 3 | Importing |
IV_OBJECT_ACTION | Call by reference | Type reference (TYPE) | STRING | UI Object Action | 20070712 | ||
| 4 | Importing |
IV_OBJECT_TYPE | Call by reference | Type reference (TYPE) | STRING | UI Object Type | 20070712 | ||
| 5 | Importing |
IV_OBJECT_VALUE | Call by reference | Type reference (TYPE) | STRING | UI Object Navigation Parameters | 20070716 |
Method GET_SCRIPT_FOR_OBN on class CL_CRM_PORTAL_APPL_CONTROLLER has no exception.
Method IS_WORKPROTECT_REQUIRED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_CLEAR | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Clear data loss handler after query | 20090925 | |
| 2 | Returning |
RV_RESULT | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20090925 |
Method IS_WORKPROTECT_REQUIRED on class CL_CRM_PORTAL_APPL_CONTROLLER has no exception.
Method PREPARE_CENTRAL_SEARCH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_FIELDS | Call by reference | Type reference (TYPE) | TIHTTPNVP | HTTP Framework (iHTTP) Table Name/Value Pairs | 20070713 | ||
| 2 | Returning |
RV_QUERY_OBJECT | Value transfer | Object reference (TYPE REF TO) | IF_BOL_BO_PROPERTY_ACCESS | Dynamic Query | 20070713 |
Method PREPARE_CENTRAL_SEARCH on class CL_CRM_PORTAL_APPL_CONTROLLER has no exception.
Method PROFILE_DETERMINATION Signature
Method PROFILE_DETERMINATION on class CL_CRM_PORTAL_APPL_CONTROLLER has no parameter.
Method PROFILE_DETERMINATION on class CL_CRM_PORTAL_APPL_CONTROLLER has no exception.
Method RENDER_DATALOSS_SCRIPT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_SCRIPT | Value transfer | Type reference (TYPE) | STRING | Script to invoke portal data loss or nothing | 20070816 |
Method RENDER_DATALOSS_SCRIPT on class CL_CRM_PORTAL_APPL_CONTROLLER has no exception.
Method RENDER_RESTART_SCRIPT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_SCRIPT | Value transfer | Type reference (TYPE) | STRING | 20080519 |
Method RENDER_RESTART_SCRIPT on class CL_CRM_PORTAL_APPL_CONTROLLER has no exception.
Method SET_DATA_FOR_DATALOSS_CHECK Signature
Method SET_DATA_FOR_DATALOSS_CHECK on class CL_CRM_PORTAL_APPL_CONTROLLER has no parameter.
Method SET_DATA_FOR_DATALOSS_CHECK on class CL_CRM_PORTAL_APPL_CONTROLLER has no exception.
Method SET_EXTERNAL_REQUEST_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_EXTERNAL_REQUEST_TYPE | Call by reference | Type reference (TYPE) | CRMT_UIF_EXT_REQUEST_TYPE | Type of External Request into UI Framework | 20080207 |
Method SET_EXTERNAL_REQUEST_TYPE on class CL_CRM_PORTAL_APPL_CONTROLLER has no exception.
Method SET_HISTORY_DEBUG_SUPPORT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_RESULT | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20070824 |
Method SET_HISTORY_DEBUG_SUPPORT on class CL_CRM_PORTAL_APPL_CONTROLLER has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 700 |
