SAP ABAP Class CL_IUUC_HELPCENTER_DOCUMENT (Model of the help center)
Hierarchy
☛
DMIS (Software Component) DMIS 2011_1
⤷
CA-EUR (Application Component) European Monetary Union: Euro
⤷
CNV_IUUC_REPLICATION (Package) IUUC: Replication tools
⤷
⤷
Properties
| Class | CL_IUUC_HELPCENTER_DOCUMENT | |
| Short Description | Model of the help center | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | CNV_IUUC_REPLICATION | IUUC: Replication tools |
| Created | 20120608 | SAP |
| Last change | 20141030 | |
| 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_IUUC_HELPCENTER_DOCUMENT has no interface implemented.
Friends
Class CL_IUUC_HELPCENTER_DOCUMENT has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Public | Type reference (TYPE) | IUUC_HELPCENTER_CONTEXT | 1 | Context of the help center document | 20120612 | ||
| 2 | Constant | Public | Type reference (TYPE) | IUUC_HELPCENTER_CONTEXT | 0 | Context of the help center document | 20120612 | ||
| 3 | Constant | Public | Type reference (TYPE) | IUUC_HELPCENTER_CONTEXT | 10 | Context of the help center document | 20120612 | ||
| 4 | Constant | Public | Type reference (TYPE) | IUUC_HELPCENTER_CONTEXT | 11 | Context of the help center document | 20120612 | ||
| 5 | Constant | Public | Type reference (TYPE) | IUUC_HELPCENTER_CONTEXT | 14 | Context of the help center document | 20120612 | ||
| 6 | Constant | Public | Type reference (TYPE) | IUUC_HELPCENTER_CONTEXT | 13 | Context of the help center document | 20120612 | ||
| 7 | Constant | Public | Type reference (TYPE) | IUUC_HELPCENTER_CONTEXT | 12 | Context of the help center document | 20120612 | ||
| 8 | Constant | Public | Type reference (TYPE) | IUUC_HELPCENTER_DOCUCAT | 'G' | Category of help center document | 20120608 | ||
| 9 | Constant | Public | Type reference (TYPE) | IUUC_HELPCENTER_DOCUCAT | 'H' | Category of help center document | 20120608 | ||
| 10 | Constant | Public | Type reference (TYPE) | IUUC_HELPCENTER_DOCUCAT | 'R' | Category of help center document | 20120608 | ||
| 11 | Constant | Public | Type reference (TYPE) | IUUC_HELPCENTER_DOCUCAT | 'T' | Category of help center document | 20120608 | ||
| 12 | Instance attribute | Private | Type reference (TYPE) | IUUC_HELPCENTER | Help Center documents for HANA LTR | 20120608 | |||
| 13 | Instance attribute | Private | Type reference (TYPE) | IUUC_HELPCENTER_DOCUDESCR | Description for the link into the help center document | 20120608 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Private | Method | Check the help center document categrory | 20120608 | |
| 2 | Static method | Private | Method | Collect a Select Option of the relevant context | 20120612 | |
| 3 | Instance method | Public | Constructor | CONSTRUCTOR | 20120608 | |
| 4 | Static method | Public | Method | Execute a transaction in callback | 20120723 | |
| 5 | Instance method | Public | Method | Get the lines of the Se61 document | 20120723 | |
| 6 | Static method | Public | Method | Fetch the help center documents for a given category | 20120608 | |
| 7 | Instance method | Public | Method | Get the description of the help center document | 20120608 | |
| 8 | Instance method | Public | Method | Return the header structure of the help center document | 20120608 |
Events
Class CL_IUUC_HELPCENTER_DOCUMENT has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_SO_CONTEXT | Public | See coding | Select Options for Context | 20120612 | TY_SO_CONTEXT TYPE RANGE OF IUUC_HELPCENTER_CONTEXT
|
Method Signatures
Method CHECK_CATEGORY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_CATEGORY | Call by reference | Type reference (TYPE) | IUUC_HELPCENTER_DOCUCAT | Category of help center document | 20120608 | |||
| 2 | RV_VALID | Value transfer | Type reference (TYPE) | ABAP_BOOL | 'X' valid, ' ' invalid | 20120608 |
Method CHECK_CATEGORY on class CL_IUUC_HELPCENTER_DOCUMENT has no exception.
Method COLLECT_RELEVANT_CONTEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_CONTEXT | Call by reference | Type reference (TYPE) | IUUC_HELPCENTER_CONTEXT | Context of the help center document | 20120612 | |||
| 2 | RT_SO_CONTEXT | Value transfer | Type reference (TYPE) | TY_SO_CONTEXT | Select Options for Context | 20120612 |
Method COLLECT_RELEVANT_CONTEXT on class CL_IUUC_HELPCENTER_DOCUMENT has no exception.
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_HELPCENTER | Call by reference | Type reference (TYPE) | IUUC_HELPCENTER | Help Center document head data | 20120608 | |||
| 2 | IV_DESCRIPTION | Call by reference | Type reference (TYPE) | IUUC_HELPCENTER_DOCUDESCR | Description for the link into the help center document | 20120608 |
Method CONSTRUCTOR on class CL_IUUC_HELPCENTER_DOCUMENT has no exception.
Method EXECUTE_TROUBLESHOOTER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_CONFIG_GUID | Call by reference | Type reference (TYPE) | IUUC_REPL_CONFIG_GUID | Configuration GUID | 20120817 | |||
| 2 | IV_TROUBLESHOOT | Call by reference | Type reference (TYPE) | SEOCLSNAME | Troubleshooter Class | 20120723 | |||
| 3 | RT_MESSAGE | Value transfer | Type reference (TYPE) | DMC_BAL_T_MSG | Messages | 20120723 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Help Center exceptions | 20120821 | ||
| 2 | SQL error in the access clases | 20120821 |
Method GET_61TX_LINES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_HEADER | Call by reference | Type reference (TYPE) | THEAD | SAPscript: Text Header | 20120723 | |||
| 2 | ET_LINE | Value transfer | Type reference (TYPE) | TLINETAB | Lines of ITF | 20120723 |
Method GET_61TX_LINES on class CL_IUUC_HELPCENTER_DOCUMENT has no exception.
Method GET_ALL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_CATEGORY | Call by reference | Type reference (TYPE) | IUUC_HELPCENTER_DOCUCAT | Category of help center document | 20120608 | |||
| 2 | IV_CONTEXT | Call by reference | Type reference (TYPE) | IUUC_HELPCENTER_CONTEXT | 0 | Context of the help center document | 20120611 | ||
| 3 | RT_DOCU | Value transfer | Type reference (TYPE) | IUUC_T_HELPCENTER | Help Center document | 20120608 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Help Center exceptions | 20120608 |
Method GET_DESCRIPTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_DESCRIPTION | Value transfer | Type reference (TYPE) | IUUC_HELPCENTER_DOCUDESCR | Description for the link into the help center document | 20120608 |
Method GET_DESCRIPTION on class CL_IUUC_HELPCENTER_DOCUMENT has no exception.
Method GET_HEADER_STRUCTURE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RS_HELPCENTER | Value transfer | Type reference (TYPE) | IUUC_HELPCENTER | Help Center documents for HANA LTR | 20120608 |
Method GET_HEADER_STRUCTURE on class CL_IUUC_HELPCENTER_DOCUMENT has no exception.
History
| Last changed by/on | SAP | 20141030 |
| SAP Release Created in | 2010_1_700 |