SAP ABAP Class /IPRO/CL_COCKPIT_ASSIST (Assistance Class for /IPRO/COCKPIT)
Hierarchy
☛
SAP_BS_FND (Software Component) SAP Business Suite Foundation
⤷
CA-GTF-DOB (Application Component) Document Builder
⤷
/IPRO/PROGS (Package) programs
SAP_BS_FND (Software Component) SAP Business Suite Foundation⤷
CA-GTF-DOB (Application Component) Document Builder⤷
/IPRO/PROGS (Package) programsMeta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_WD_COMPONENT_ASSISTANCE | Basis for a Web Dynpro assistance class | 20061202 |
Properties
| Class | /IPRO/CL_COCKPIT_ASSIST | |
| Short Description | Assistance Class for /IPRO/COCKPIT | |
| Super Class | CL_WD_COMPONENT_ASSISTANCE | Basis for a Web Dynpro assistance class |
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | /IPRO/PROGS | programs |
| Created | 20061202 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class /IPRO/CL_COCKPIT_ASSIST has no forward declaration.
Interfaces
Class /IPRO/CL_COCKPIT_ASSIST has no interface implemented.
Friends
Class /IPRO/CL_COCKPIT_ASSIST has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_ERR |
Constant | Public | Type reference (TYPE) | CHAR1 | 'X' | Single-Character Flag | 20080404 | |
| 2 | GC_EXISTS |
Constant | Public | Type reference (TYPE) | CHAR1 | 'E' | Single-Character Flag | 20080404 | |
| 3 | GC_FALSE |
Constant | Public | Type reference (TYPE) | BOOLEAN | ' ' | Boolean Variable (X=True, -=False, Space=Unknown) | 20070423 | |
| 4 | GC_MODE_COPY |
Constant | Public | Type reference (TYPE) | CHAR1 | 'X' | Single-Character Flag | 20070423 | |
| 5 | GC_MODE_CREATE |
Constant | Public | Type reference (TYPE) | CHAR1 | 'C' | Single-Character Flag | 20061222 | |
| 6 | GC_MODE_DISPLAY |
Constant | Public | Type reference (TYPE) | CHAR1 | '' | Single-Character Flag | 20061222 | |
| 7 | GC_MODE_UPDATE |
Constant | Public | Type reference (TYPE) | CHAR1 | 'U' | Single-Character Flag | 20061222 | |
| 8 | GC_NOERR |
Constant | Public | Type reference (TYPE) | CHAR1 | ' ' | Single-Character Flag | 20080404 | |
| 9 | GC_REP_STATE_ACTIVE |
Constant | Public | Type reference (TYPE) | CHAR1 | '4' | Single-Character Flag | 20070511 | |
| 10 | GC_REP_STATE_APPRVL |
Constant | Public | Type reference (TYPE) | CHAR1 | '3' | Single-Character Flag | 20070511 | |
| 11 | GC_REP_STATE_DRAFT |
Constant | Public | Type reference (TYPE) | CHAR1 | '1' | Single-Character Flag | 20070511 | |
| 12 | GC_REP_STATE_INACTIVE |
Constant | Public | Type reference (TYPE) | CHAR1 | '5' | Single-Character Flag | 20070511 | |
| 13 | GC_REP_STATE_REJECT |
Constant | Public | Type reference (TYPE) | CHAR1 | '2' | Single-Character Flag | 20070511 | |
| 14 | GC_TEXTTYPE_FULL |
Constant | Public | Type reference (TYPE) | CHAR1 | '1' | Single-Character Flag | 20071003 | |
| 15 | GC_TRUE |
Constant | Public | Type reference (TYPE) | BOOLEAN | 'X' | Boolean Variable (X=True, -=False, Space=Unknown) | 20070423 | |
| 16 | MS_STDELM_ID |
Instance attribute | Public | Type reference (TYPE) | /IPRO/TELMNT | 20070502 | |||
| 17 | MV_CONTENT |
Instance attribute | Public | Type reference (TYPE) | /IPRO/CONTENT | Content | 20080807 | ||
| 18 | MV_ELEMENT_MODE |
Instance attribute | Public | Type reference (TYPE) | CHAR1 | Single-Character Flag | 20070423 | ||
| 19 | MV_KEYFIELD_ERR |
Instance attribute | Public | Type reference (TYPE) | CHAR1 | Single-Character Flag | 20080404 | ||
| 20 | MV_KEYFIELD_NOK |
Instance attribute | Public | Type reference (TYPE) | BOOLEAN | Boolean Variable (X=True, -=False, Space=Unknown) | 20070423 | ||
| 21 | MV_TEXT_ID |
Instance attribute | Public | Type reference (TYPE) | GUID | Guid for text id | 20070330 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CHECK_ELEMENT_EXIST |
Instance method | Public | Method | Checks if an element already exists in telmnt table | 20070712 |
| 2 | CHECK_RGSET_EXIST |
Instance method | Public | Method | Check if the entered RGSET is valid | 20090507 |
| 3 | CHECK_USER |
Instance method | Public | Method | checks a user in USR02 | 20070831 |
| 4 | CREATE_ERROR_MESSAGE |
Instance method | Public | Method | Set an error message | 20061222 |
| 5 | CREATE_URL_GUID |
Instance method | Public | Method | Create guid for URL | 20090430 |
| 6 | GET_CONTENT |
Instance method | Public | Method | Reads the first entry from /ipro/tcontent | 20070712 |
| 7 | GET_ELEMENT_TITLE |
Instance method | Public | Method | read the element title from /ipro/ttext_t | 20070905 |
| 8 | GET_ELM_CATEGORIES |
Instance method | Public | Method | read table /ipro/telm_catt | 20070712 |
| 9 | GET_ELM_TYPES |
Instance method | Public | Method | read table /IPRO/TELMTYP_T | 20070712 |
| 10 | GET_FUTURE_ELEMENTS |
Instance method | Public | Method | Get elements with future effective date for the content | 20080606 |
| 11 | LOAD_DOCUMENT_LIST |
Instance method | Public | Method | Load document list | 20070328 |
| 12 | LOAD_TEMPL_LIST |
Instance method | Public | Method | Load template list | 20070712 |
| 13 | LOAD_USERTEMPL_LIST |
Instance method | Public | Method | Load user template list | 20070712 |
| 14 | READ_CONFIG_TABLE |
Instance method | Public | Method | read table /ipro/tconfig for 'FORMAT' | 20070801 |
| 15 | READ_TEMPL_TABLE |
Instance method | Public | Method | Read 1 entry of /ipro/ttempl | 20070712 |
| 16 | READ_TEMP_TEXT |
Instance method | Public | Method | read_temp_text | 20070511 |
| 17 | READ_TOUTDEF |
Instance method | Public | Method | read table for /IPRO/TOUTDEF | 20070712 |
| 18 | READ_TOUTDEF_TXT |
Instance method | Public | Method | read Text table for /IPRO/TOUTDEF | 20070712 |
| 19 | SET_LEAD_SELECTION_INDEX |
Instance method | Public | Method | Set the lead selection | 20061228 |
| 20 | WRITE_CACHE_ENTRY |
Instance method | Public | Method | Create a cache entry | 20070108 |
| 21 | WRITE_HTML_CACHE_ENTRY |
Instance method | Public | Method | Create a cache entry for HTML | 20070108 |
| 22 | WRITE_TEMP_TEXT |
Instance method | Public | Method | write_temp_text | 20070330 |
| 23 | WRITE_TEMP_TEXT_DIRECT |
Instance method | Public | Method | Saves the data to /ipro/ttemptxt | 20090430 |
Events
Class /IPRO/CL_COCKPIT_ASSIST has no event.
Types
Class /IPRO/CL_COCKPIT_ASSIST has no local type.
Method Signatures
Method CHECK_ELEMENT_EXIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
PIS_ELEMENT | Call by reference | Type reference (TYPE) | /IPRO/S_ELMNT_CONTEXT | Element Context structure | 20070712 | ||
| 2 |  Returning |
PRV_EXIST | Value transfer | Type reference (TYPE) | XFELD | element exist | 20070712 |
Method CHECK_ELEMENT_EXIST on class /IPRO/CL_COCKPIT_ASSIST has no exception.
Method CHECK_RGSET_EXIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIS_ELEMENT | Call by reference | Type reference (TYPE) | /IPRO/S_ELMNT_CONTEXT | Regulation Set | 20090507 | ||
| 2 | Returning |
PRV_VALID | Value transfer | Type reference (TYPE) | BOOLEAN | Boolean Variable (X=True, -=False, Space=Unknown) | 20090507 |
Method CHECK_RGSET_EXIST on class /IPRO/CL_COCKPIT_ASSIST has no exception.
Method CHECK_USER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIV_USER | Call by reference | Type reference (TYPE) | SY-UNAME | User Name | 20070831 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  /IPRO/CX_INVALID_USER |
Invalid User | 20070831 |
Method CREATE_ERROR_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_MESSAGE | Call by reference | Type reference (TYPE) | STRING | Error essage | 20061222 |
Method CREATE_ERROR_MESSAGE on class /IPRO/CL_COCKPIT_ASSIST has no exception.
Method CREATE_URL_GUID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_URL_GUID | Value transfer | Type reference (TYPE) | STRING | URL Guid | 20090430 |
Method CREATE_URL_GUID on class /IPRO/CL_COCKPIT_ASSIST has no exception.
Method GET_CONTENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIV_INDEX | Call by reference | Type reference (TYPE) | SY-TABIX | Index of Internal Tables | 20070712 | ||
| 2 |  Exporting |
PRS_CONTENT | Value transfer | Type reference (TYPE) | /IPRO/TCONTENT | Content | 20070712 | ||
| 3 | Exporting |
PRT_CONTENT | Value transfer | Type reference (TYPE) | /IPRO/TT_TCONTENT | Table type for contents in Document Builder | 20070712 |
Method GET_CONTENT on class /IPRO/CL_COCKPIT_ASSIST has no exception.
Method GET_ELEMENT_TITLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIS_ELEMENT | Call by reference | Type reference (TYPE) | /IPRO/TELMNT | Element table | 20070905 | ||
| 2 | Importing |
PIV_LANGU | Call by reference | Type reference (TYPE) | SY-LANGU | Language Key of Current Text Environment | 20070905 | ||
| 3 | Returning |
PRV_TITLE | Value transfer | Type reference (TYPE) | /IPRO/TITLE | Description | 20070905 |
Method GET_ELEMENT_TITLE on class /IPRO/CL_COCKPIT_ASSIST has no exception.
Method GET_ELM_CATEGORIES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIV_CONTENT | Call by reference | Type reference (TYPE) | /IPRO/TDOCMNT-CONTENT | Content | 20070712 | ||
| 2 | Returning |
PRT_ELM_CATEGORIES | Value transfer | Type reference (TYPE) | /IPRO/TELM_CATT_TYPE | table type for /IPRO/TELM_CATT | 20070712 |
Method GET_ELM_CATEGORIES on class /IPRO/CL_COCKPIT_ASSIST has no exception.
Method GET_ELM_TYPES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
PRT_ELM_TYPES | Value transfer | Type reference (TYPE) | /IPRO/TELMTYP_T_TYPE | table type for /IPRO/TELMTYP_T | 20070712 |
Method GET_ELM_TYPES on class /IPRO/CL_COCKPIT_ASSIST has no exception.
Method GET_FUTURE_ELEMENTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIV_CONTENT | Call by reference | Type reference (TYPE) | STRING | 20080606 | |||
| 2 | Returning |
PRT_ELEMENTS | Value transfer | Type reference (TYPE) | /IPRO/TT_ELMNT | table of clause detail | 20080606 |
Method GET_FUTURE_ELEMENTS on class /IPRO/CL_COCKPIT_ASSIST has no exception.
Method LOAD_DOCUMENT_LIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIV_CONTENT | Call by reference | Type reference (TYPE) | /IPRO/TDOCMNT-CONTENT | Content | 20070712 | ||
| 2 | Returning |
PRT_DOCUMENT_LIST | Value transfer | Type reference (TYPE) | /IPRO/TTDOCMNT_TYPE | Document Builder Documents | 20070712 |
Method LOAD_DOCUMENT_LIST on class /IPRO/CL_COCKPIT_ASSIST has no exception.
Method LOAD_TEMPL_LIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIV_CONTENT | Call by reference | Type reference (TYPE) | /IPRO/TDOCMNT-CONTENT | Content | 20070712 | ||
| 2 | Returning |
PRT_TEMPL_LIST | Value transfer | Type reference (TYPE) | /IPRO/TTEMPL_TYPE | table type of /IPRO/TTEMPL | 20070712 |
Method LOAD_TEMPL_LIST on class /IPRO/CL_COCKPIT_ASSIST has no exception.
Method LOAD_USERTEMPL_LIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIV_CONTENT | Call by reference | Type reference (TYPE) | /IPRO/TDOCMNT-CONTENT | Content | 20070712 | ||
| 2 | Returning |
PRT_USER_TEMPL_LIST | Value transfer | Type reference (TYPE) | /IPRO/TUSRTMPL_TYPE | table type for /IPRO/TUSRTMPL | 20070712 |
Method LOAD_USERTEMPL_LIST on class /IPRO/CL_COCKPIT_ASSIST has no exception.
Method READ_CONFIG_TABLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIV_CONTENT | Call by reference | Type reference (TYPE) | /IPRO/TDOCMNT-CONTENT | Content | 20070801 | ||
| 2 | Returning |
PRV_VALUE | Value transfer | Type reference (TYPE) | /IPRO/TCONFIG-VALU | Configuration Parameter Value | 20070801 |
Method READ_CONFIG_TABLE on class /IPRO/CL_COCKPIT_ASSIST has no exception.
Method READ_TEMPL_TABLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIV_TEMPLATE | Call by reference | Type reference (TYPE) | /IPRO/TELMLIST-DOCMNT | template | 20070712 | ||
| 2 | Returning |
PRS_TEMPLATE | Value transfer | Type reference (TYPE) | /IPRO/TTEMPL | Document Builder Templates | 20070712 |
Method READ_TEMPL_TABLE on class /IPRO/CL_COCKPIT_ASSIST has no exception.
Method READ_TEMP_TEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_TEXT_ID | Value transfer | Type reference (TYPE) | GUID | Globally Unique Identifier | 20070511 | ||
| 2 | Returning |
RO_TEXT | Value transfer | Object reference (TYPE REF TO) | /IPRO/CL_DOCB_TEXT | Document Builder Element Text Class | 20070511 |
Method READ_TEMP_TEXT on class /IPRO/CL_COCKPIT_ASSIST has no exception.
Method READ_TOUTDEF Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIV_INDEX | Call by reference | Type reference (TYPE) | SY-TABIX | Index of Internal Tables | 20070712 | ||
| 2 | Exporting |
PRS_OUTDEF | Value transfer | Type reference (TYPE) | /IPRO/TOUTDEF | Defines output types for Document Builder | 20070712 | ||
| 3 | Exporting |
PRT_OUTDEF | Value transfer | Type reference (TYPE) | /IPRO/TOUTDEF_TYPE | table for /IPRO/TOUTDEF | 20070712 |
Method READ_TOUTDEF on class /IPRO/CL_COCKPIT_ASSIST has no exception.
Method READ_TOUTDEF_TXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIV_LANGU | Call by reference | Type reference (TYPE) | SY-LANGU | Language Key of Current Text Environment | 20070712 | ||
| 2 | Importing |
PIV_OTYPE | Call by reference | Type reference (TYPE) | /IPRO/OTYPE | Output Type | 20070712 | ||
| 3 | Returning |
PRV_TEXT | Value transfer | Type reference (TYPE) | TEXT60 | Text Field of Length 60 | 20070712 |
Method READ_TOUTDEF_TXT on class /IPRO/CL_COCKPIT_ASSIST has no exception.
Method SET_LEAD_SELECTION_INDEX Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IR_LIST | Call by reference | Object reference (TYPE REF TO) | IF_WD_CONTEXT_NODE | Web Dynpro: Interface for Context Nodes | 20061228 | ||
| 2 | Importing |
IS_ELEMENT | Call by reference | Type reference (TYPE) | /IPRO/S_ELMNT_CONTEXT | Element Context structure | 20061228 |
Method SET_LEAD_SELECTION_INDEX on class /IPRO/CL_COCKPIT_ASSIST has no exception.
Method WRITE_CACHE_ENTRY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
EV_URL | Value transfer | Type reference (TYPE) | STRING | 20070108 | |||
| 2 | Importing |
IO_EDITFULLTEXT_SEL | Call by reference | Type reference (TYPE) | BOOLEAN | Boolean Variable (X=True, -=False, Space=Unknown) | 20071105 | ||
| 3 | Importing |
IO_TEXT | Call by reference | Object reference (TYPE REF TO) | /IPRO/CL_DOCB_TEXT | Document Builder Element Text Class | 20070108 |
Method WRITE_CACHE_ENTRY on class /IPRO/CL_COCKPIT_ASSIST has no exception.
Method WRITE_HTML_CACHE_ENTRY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
EV_URL | Value transfer | Type reference (TYPE) | STRING | 20070108 | |||
| 2 | Importing |
IO_TEXT | Call by reference | Object reference (TYPE REF TO) | /IPRO/CL_DOCB_TEXT | Document Builder Element Text Class | 20070108 | ||
| 3 | Importing |
IV_HTML | Call by reference | Type reference (TYPE) | STRING | 20070108 |
Method WRITE_HTML_CACHE_ENTRY on class /IPRO/CL_COCKPIT_ASSIST has no exception.
Method WRITE_TEMP_TEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_DOCUMENT | Value transfer | Object reference (TYPE REF TO) | /IPRO/IF_DOCUMENT | Document Builder Document Interface | 20070420 | ||
| 2 | Importing |
IO_TEXT | Call by reference | Object reference (TYPE REF TO) | /IPRO/CL_DOCB_TEXT | Document Builder Element Text Class | 20070330 | ||
| 3 | Importing |
IV_CONTENT | Value transfer | Type reference (TYPE) | /IPRO/CONTENT | Content | 20070423 | ||
| 4 | Importing |
IV_HIDE_TITLE | Call by reference | Type reference (TYPE) | CHAR1 | Single-Character Flag | 20070330 | ||
| 5 | Importing |
IV_ID | Call by reference | Type reference (TYPE) | GUID | Globally Unique Identifier | 20070330 |
Method WRITE_TEMP_TEXT on class /IPRO/CL_COCKPIT_ASSIST has no exception.
Method WRITE_TEMP_TEXT_DIRECT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIS_DATA | Call by reference | Type reference (TYPE) | /IPRO/TTEMPTXT | Temporary text storage | 20090430 | ||
| 2 | Returning |
PRV_URL | Value transfer | Type reference (TYPE) | STRING | Url for preview | 20090430 |
Method WRITE_TEMP_TEXT_DIRECT on class /IPRO/CL_COCKPIT_ASSIST has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 300 |
