SAP ABAP Class CL_WDHC_CONFIG (CL_WDHC_CONFIG)
Hierarchy
☛
SAP_UI (Software Component) User Interface Technology
⤷
BC-HLP-ABA (Application Component) Help Infrastructure for ABAP
⤷
SWDP_HELP_CENTER (Package) Help Center ABAP Web Dynpro
⤷
⤷
Properties
| Class | CL_WDHC_CONFIG | |
| Short Description | ||
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SWDP_HELP_CENTER | Help Center ABAP Web Dynpro |
| Created | 20080313 | SAP |
| Last change | 20141120 | |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_WDHC_CONFIG has no interface implemented.
Friends
Class CL_WDHC_CONFIG has no friend class.
Attributes
Class CL_WDHC_CONFIG has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | Settings for the Help Center Areas | 20081028 | |
| 2 | Static method | Public | Method | Settings for the Help Center Areas | 20100708 | |
| 3 | Static method | Private | Method | Texts SAP Areas | 20100713 | |
| 4 | Static method | Public | Method | Maximum Number of Entries for Areas with External Content | 20100610 | |
| 5 | Static method | Private | Method | Settings for the Help Center Areas | 20100713 | |
| 6 | Static method | Public | Method | HTTP Connection for KW Search | 20100419 | |
| 7 | Static method | Public | Method | KW Library | 20090903 | |
| 8 | Static method | Public | Method | Logical Path for KW Search | 20090903 | |
| 9 | Static method | Public | Method | File Share KW | 20090903 | |
| 10 | Static method | Public | Method | Installed Help Type for KW Search | 20100419 | |
| 11 | Static method | Public | Method | Logical Path for Search | 20090713 | |
| 12 | Static method | Public | Method | Maximum Number of Search Results | 20091008 | |
| 13 | Static method | Public | Method | File Share Customer Documents | 20080313 | |
| 14 | Static method | Public | Method | Physical Path for Search | 20090713 | |
| 15 | Static method | Public | Method | Is "Application Help" active? | 20080313 | |
| 16 | Static method | Public | Method | "Documents from ECM" active? | 20100309 | |
| 17 | Static method | Public | Method | Help Center active? | 20080313 | |
| 18 | Static method | Public | Method | Are customer documents language-dependent? | 20080313 | |
| 19 | Static method | Public | Method | Are files from SAP Solution Manager permitted? | 20081210 | |
| 20 | Static method | Public | Method | Display in portal side panel (Help Center iView)? | 20090309 | |
| 21 | Static method | Public | Method | Display in Web Dynpro side panel? | 20090309 |
Events
Class CL_WDHC_CONFIG has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | T_AREA_TEXTS | Public | See coding | 20100713 | begin of t_area_texts,
area type wdhc_category,
text type string,
end of t_area_texts
|
||
| 2 | T_AREA_TEXTS_TT | Public | See coding | 20100713 | t_area_texts_tt type standard table of t_area_texts
|
Method Signatures
Method GET_AREA_SETTINGS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_HIDE_AREAS | Call by reference | Type reference (TYPE) | SAPHC_HIDE_AREAS | Unsichtbare Bereiche | 20081028 | |||
| 2 | E_POS_AREAS | Call by reference | Type reference (TYPE) | SAPHC_POS_AREAS | Wohin mit Notizen, FAQs und Links | 20081028 |
Method GET_AREA_SETTINGS on class CL_WDHC_CONFIG has no exception.
Method GET_AREA_SETTINGS2 Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_AREAS | Call by reference | Type reference (TYPE) | WDHC_AREAS_TT | Wohin mit Notizen, FAQs und Links | 20100708 | |||
| 2 | E_AREA_TEXTS | Call by reference | Type reference (TYPE) | T_AREA_TEXTS_TT | 20100713 | ||||
| 3 | E_HIDE_AREAS | Call by reference | Type reference (TYPE) | WDHC_AREAS_TT | Unsichtbare Bereiche | 20100708 | |||
| 4 | I_NO_MESSAGE | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20100726 |
Method GET_AREA_SETTINGS2 on class CL_WDHC_CONFIG has no exception.
Method GET_AREA_TEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_AREA | Call by reference | Type reference (TYPE) | WDHC_CATEGORY | Help Center: Kategorie | 20100713 | |||
| 2 | R_AREA_TEXT | Value transfer | Type reference (TYPE) | STRING | 20100713 |
Method GET_AREA_TEXT on class CL_WDHC_CONFIG has no exception.
Method GET_EXT_CONTENT_LIMIT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_EXT_CONTENT_LIMIT | Value transfer | Type reference (TYPE) | WDHC_EXT_CONTENT_LIMIT | Maximale Anzahl von Einträgen für Bereiche mit ext. Inhalten | 20100611 |
Method GET_EXT_CONTENT_LIMIT on class CL_WDHC_CONFIG has no exception.
Method GET_HIDE_AREAS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_AREAS | Call by reference | Type reference (TYPE) | WDHC_AREAS_TT | Wohin mit Notizen, FAQs und Links | 20100713 | |||
| 2 | R_HIDE_AREAS | Value transfer | Type reference (TYPE) | WDHC_AREAS_TT | Unsichtbare Bereiche | 20100713 |
Method GET_HIDE_AREAS on class CL_WDHC_CONFIG has no exception.
Method GET_KW_HTTP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_KW_HTTP | Value transfer | Type reference (TYPE) | WDHC_KW_HTTP | HTTP-Verbindung | 20100419 |
Method GET_KW_HTTP on class CL_WDHC_CONFIG has no exception.
Method GET_KW_LIBRARY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_KW_LIBRARY | Value transfer | Type reference (TYPE) | WDHC_KW_LIBRARY | KW Bibliothek | 20090903 |
Method GET_KW_LIBRARY on class CL_WDHC_CONFIG has no exception.
Method GET_KW_LOG_PATH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_KW_LOG_PATH | Value transfer | Type reference (TYPE) | WDHC_LOG_KW_PATH | Logischer Pfad für KW Suche | 20090903 |
Method GET_KW_LOG_PATH on class CL_WDHC_CONFIG has no exception.
Method GET_KW_PATH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_KW_PATH | Value transfer | Type reference (TYPE) | WDHC_PATH | File-Share KW | 20090903 |
Method GET_KW_PATH on class CL_WDHC_CONFIG has no exception.
Method GET_KW_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_KW_TYPE | Value transfer | Type reference (TYPE) | WDHC_KW_TYPE | Help Center: Installierter Hilfetyp | 20100419 |
Method GET_KW_TYPE on class CL_WDHC_CONFIG has no exception.
Method GET_LOG_PATH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_LOG_PATH | Value transfer | Type reference (TYPE) | WDHC_LOG_PATH | Logischer Pfad für Suche | 20090713 |
Method GET_LOG_PATH on class CL_WDHC_CONFIG has no exception.
Method GET_MAX_RESULTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_MAX_RESULTS | Value transfer | Type reference (TYPE) | WDHC_MAX_RESULTS | Maximale Anzahl von Suchergebnissen | 20091008 |
Method GET_MAX_RESULTS on class CL_WDHC_CONFIG has no exception.
Method GET_PATH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_PATH | Value transfer | Type reference (TYPE) | WDHC_PATH | File-Share Kundendokumente | 20080313 |
Method GET_PATH on class CL_WDHC_CONFIG has no exception.
Method GET_PHYS_PATH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_PHYS_PATH | Value transfer | Type reference (TYPE) | STRING | Physischer Pfad für Suche | 20090713 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20140708 |
Method IS_APPHELP_ACTIVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_APPHELP_ACTIVE | Value transfer | Type reference (TYPE) | WDHC_APPHELP_ACTIVE | "Hilfe zur Anwendung" aktiv | 20080313 |
Method IS_APPHELP_ACTIVE on class CL_WDHC_CONFIG has no exception.
Method IS_ECM_ACTIVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_ECM_ACTIVE | Value transfer | Type reference (TYPE) | WDHC_ECM_ACTIVE | "Dokumente aus ECM" aktiv | 20100309 |
Method IS_ECM_ACTIVE on class CL_WDHC_CONFIG has no exception.
Method IS_HC_ACTIVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_ACTIVE | Value transfer | Type reference (TYPE) | WDHC_ACTIVE | Help Center aktiv | 20080313 |
Method IS_HC_ACTIVE on class CL_WDHC_CONFIG has no exception.
Method IS_LANG_DEPENDENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_LANG_DEPENDENT | Value transfer | Type reference (TYPE) | WDHC_LANG_DEPENDENT | Kundendokumente sprachabhängig | 20080313 |
Method IS_LANG_DEPENDENT on class CL_WDHC_CONFIG has no exception.
Method IS_SOLMAN_ACTIVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_SOLMAN_ACTIVE | Value transfer | Type reference (TYPE) | WDHC_SOLMAN_ACTIVE | Dateien aus SAP Solution Manager | 20081210 |
Method IS_SOLMAN_ACTIVE on class CL_WDHC_CONFIG has no exception.
Method USE_PORTAL_IVIEW Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_USE_PORTAL_IVIEW | Value transfer | Type reference (TYPE) | WDHC_USE_PORTAL_IVIEW | Help Center im Portal-Sidepanel | 20090309 |
Method USE_PORTAL_IVIEW on class CL_WDHC_CONFIG has no exception.
Method USE_SIDEPANEL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_USE_SIDEPANEL | Value transfer | Type reference (TYPE) | WDHC_USE_SIDEPANEL | Help Center im WebDynpro-Sidepanel | 20090309 |
Method USE_SIDEPANEL on class CL_WDHC_CONFIG has no exception.
History
| Last changed by/on | SAP | 20141120 |
| SAP Release Created in | 701 |