SAP ABAP Class /PLMB/CL_NAVC (NAV - Controller)
Hierarchy
☛
SAP_BS_FND (Software Component) SAP Business Suite Foundation
⤷
CA-EPT-NAV (Application Component) Object Navigator
⤷
/PLMB/BA_NAV (Package) Base: PLM Object Navigator
⤷
⤷
Properties
| Class | /PLMB/CL_NAVC | |
| Short Description | NAV - Controller | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | /PLMB/BA_NAV | Base: PLM Object Navigator |
| Created | 20071024 | SAP |
| Last change | 20130531 | SAP |
| 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 /PLMB/CL_NAVC has no interface implemented.
Friends
Class /PLMB/CL_NAVC has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Static Attribute | Private | Type reference (TYPE) | INT4 | 0 | Natural Number | 20080310 | ||
| 2 | Static Attribute | Private | Type reference (TYPE) | /PLMB/NAV_ERROR_TYPE | '1' | NAV error type | 20080417 | ||
| 3 | Static Attribute | Private | Type reference (TYPE) | /PLMB/NAV_ERROR_TYPE | '2' | NAV errot type | 20080507 | ||
| 4 | Static Attribute | Private | Type reference (TYPE) | /PLMB/T_NAV_BCITEM_MGMT | NAV - Table type for bc item mgmt per C.Obj, active tab page | 20071102 | |||
| 5 | Static Attribute | Private | Type reference (TYPE) | /PLMB/T_NAV_PARAMETER_DATA | NAV - Parameter data table type | 20080311 | |||
| 6 | Static Attribute | Private | Type reference (TYPE) | /PLMB/T_NAV_PARAMETERS_MGMT | NAV - Table type for management of Parameters | 20080311 | |||
| 7 | Static Attribute | Private | Type reference (TYPE) | /PLMB/T_NAV_TREE_MGMT | NAV - Table type for Mgmt of tree,engine per bcitem,tab page | 20071114 | |||
| 8 | Static Attribute | Private | Type reference (TYPE) | /PLMB/NAV_ERROR_TYPE | error type | 20080417 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | Delete breadcrumb items | 20071123 | |
| 2 | Static method | Public | Method | Retrieve Central Object's attributes | 20071211 | |
| 3 | Static method | Public | Method | Get error type | 20080417 | |
| 4 | Static method | Public | Method | Delete breadcrumb items | 20080529 | |
| 5 | Static method | Public | Method | Get User specific layout settings | 20091003 | |
| 6 | Static method | Public | Method | Get semantic key for given internal IDs | 20080201 | |
| 7 | Static method | Public | Method | get the additional details of object type | 20090810 | |
| 8 | Static method | Public | Method | Info Message on Personalized Values in Navigator Settings | 20091107 | |
| 9 | Static method | Public | Method | Provide complete set of NAV relevant otype names | 20080410 | |
| 10 | Static method | Public | Method | Get settings | 20080311 | |
| 11 | Static method | Public | Method | Explode tree nodes | 20071024 | |
| 12 | Static method | Public | Method | Create new breadcrumb item | 20071024 | |
| 13 | Static method | Public | Method | Get internal ID for key | 20071026 | |
| 14 | Static method | Public | Method | Get semantic key for given internal IDs | 20080131 | |
| 15 | Static method | Public | Method | Build Layout from Customizing | 20071024 | |
| 16 | Static method | Public | Method | On Runtime redefine the Parameter Data (Internal) | 20090223 | |
| 17 | Static method | Public | Method | Explode tree nodes | 20080304 | |
| 18 | Static method | Public | Method | Set active tab page variant for given breadcrumb item | 20071213 | |
| 19 | Static method | Public | Method | Set User specific layout settings | 20091003 | |
| 20 | Static method | Public | Method | Set settings | 20080319 | |
| 21 | Static method | Public | Method | Update expand status of a tree | 20071214 |
Events
Class /PLMB/CL_NAVC has no event.
Types
Class /PLMB/CL_NAVC has no local type.
Method Signatures
Method DELETE_BREADCRUMB_ITEMS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_BC_ITEMID | Call by reference | Type reference (TYPE) | /PLMB/T_NAV_BCITEM_ID | NAV - Table with node IDs of a Breadcrumb Item | 20071123 |
Method DELETE_BREADCRUMB_ITEMS on class /PLMB/CL_NAVC has no exception.
Method GET_CENTRAL_OBJ_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_CENTRAL_OBJ_DATA | Call by reference | Type reference (TYPE) | /PLMB/S_NAV_CENTRAL_OBJ_DATA | Attributes of given object | 20071211 | |||
| 2 | ET_MESSAGE | Call by reference | Type reference (TYPE) | /PLMB/T_SPI_MSG | Message | 20071211 | |||
| 3 | EV_SEVERITY | Call by reference | Type reference (TYPE) | /PLMB/SPI_MSG_SEVERITY | Severity | 20071211 | |||
| 4 | IS_CENTRAL_OBJ | Call by reference | Type reference (TYPE) | /PLMB/S_NAV_OBJ_ID | otype, intid of central object | 20071211 |
Method GET_CENTRAL_OBJ_DATA on class /PLMB/CL_NAVC has no exception.
Method GET_ERROR_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_ERROR_TYPE | Call by reference | Type reference (TYPE) | /PLMB/NAV_ERROR_TYPE | NAV error type | 20080417 |
Method GET_ERROR_TYPE on class /PLMB/CL_NAVC has no exception.
Method GET_INTID_BY_BC_ITEMID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_BCITEM_DATA | Call by reference | Type reference (TYPE) | /PLMB/S_NAV_BCITEM_SP | NAV - Node data of a Breadcrumb Item | 20080620 | |||
| 2 | ET_MESSAGE | Call by reference | Type reference (TYPE) | /PLMB/T_SPI_MSG | Message | 20080617 | |||
| 3 | EV_SEVERITY | Call by reference | Type reference (TYPE) | /PLMB/SPI_MSG_SEVERITY | Severity | 20080617 | |||
| 4 | IV_BC_ITEMID | Call by reference | Type reference (TYPE) | /PLMB/NAV_BC_ITEMID | Breadcrumb Item ID | 20080529 |
Method GET_INTID_BY_BC_ITEMID on class /PLMB/CL_NAVC has no exception.
Method GET_LAYOUT_SETTINGS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_USR_LAYOUT | Call by reference | Type reference (TYPE) | /PLMB/S_NAV_USR_LAYOUT | 20091003 | ||||
| 2 | ET_MESSAGE | Call by reference | Type reference (TYPE) | /PLMB/T_SPI_MSG | 20091003 | ||||
| 3 | EV_SEVERITY | Call by reference | Type reference (TYPE) | /PLMB/SPI_MSG_SEVERITY | 20091003 | ||||
| 4 | IV_OTYPE_NAME | Call by reference | Type reference (TYPE) | /PLMB/NAV_OTYPE_NAME | Object Type | 20091003 | |||
| 5 | IV_USER | Call by reference | Type reference (TYPE) | SYUNAME | SY-UNAME | User Name | 20091003 |
Method GET_LAYOUT_SETTINGS on class /PLMB/CL_NAVC has no exception.
Method GET_NAV_OBJECT_ATTRIBUTES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGE | Call by reference | Type reference (TYPE) | /PLMB/T_SPI_MSG | Message | 20080201 | |||
| 2 | ET_OBJ_ATTRIBUTES_DATA | Call by reference | Type reference (TYPE) | /PLMB/T_NAV_OBJ_SP | NAV - Table with IDs of NAV Objects | 20080201 | |||
| 3 | EV_SEVERITY | Call by reference | Type reference (TYPE) | /PLMB/SPI_MSG_SEVERITY | Severity | 20080201 | |||
| 4 | IT_OBJECT_TYPE_INTID | Call by reference | Type reference (TYPE) | /PLMB/T_NAV_OBJ_ID | NAV - Table with IDs of NAV objects | 20080201 |
Method GET_NAV_OBJECT_ATTRIBUTES on class /PLMB/CL_NAVC has no exception.
Method GET_NAV_OTYPE_DETAILS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_INTID_ATTRIB_DDICNAME | Call by reference | Type reference (TYPE) | TYPENAME | Name of Dictionary Type | 20090810 | |||
| 2 | EV_INTID_KEY_DDICNAME | Call by reference | Type reference (TYPE) | TYPENAME | NAV - Object type instances & further data | 20090810 | |||
| 3 | IV_OTYPE_NAME | Call by reference | Type reference (TYPE) | /PLMB/NAV_OTYPE_NAME | Object Type | 20090810 |
Method GET_NAV_OTYPE_DETAILS on class /PLMB/CL_NAVC has no exception.
Method GET_NAV_SETTING_INFO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGE | Call by reference | Type reference (TYPE) | /PLMB/T_SPI_MSG | Message | 20091107 | |||
| 2 | EV_SEVERITY | Call by reference | Type reference (TYPE) | /PLMB/SPI_MSG_SEVERITY | Severity | 20091107 |
Method GET_NAV_SETTING_INFO on class /PLMB/CL_NAVC has no exception.
Method GET_OTYPE_NAMES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_OTYPE_NAME | Call by reference | Type reference (TYPE) | /PLMB/T_NAV_OTYPE_NAME | NAV - Object type table | 20080613 |
Method GET_OTYPE_NAMES on class /PLMB/CL_NAVC has no exception.
Method GET_SETTINGS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_SETTINGS | Call by reference | Type reference (TYPE) | /PLMB/S_NAV_SETTINGS_SP | NAV - Node data of Settings | 20080311 | |||
| 2 | ET_MESSAGE | Call by reference | Type reference (TYPE) | /PLMB/T_SPI_MSG | Message | 20080312 | |||
| 3 | EV_SEVERITY | Call by reference | Type reference (TYPE) | /PLMB/SPI_MSG_SEVERITY | Severity | 20080312 | |||
| 4 | IS_SETTINGSID | Call by reference | Type reference (TYPE) | /PLMB/S_NAV_SETTINGS_ID | NAV - Node ID of Settings | 20080311 | |||
| 5 | IV_IGNORE_MISSING_MAND | Call by reference | Type reference (TYPE) | BOOLE_D | ignore the missing mandatory parameters | 20091118 |
Method GET_SETTINGS on class /PLMB/CL_NAVC has no exception.
Method GET_SUBTREE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGE | Call by reference | Type reference (TYPE) | /PLMB/T_SPI_MSG | Message | 20071203 | |||
| 2 | ET_REL_MESSAGE | Call by reference | Type reference (TYPE) | /PLMB/T_NAV_REL_MSG | Message table for messages of NAV relation classes | 20080222 | |||
| 3 | ET_SUBTREE | Call by reference | Type reference (TYPE) | /PLMB/T_NAV_TREE_SP | NAV - Table with node data of a tree | 20071114 | |||
| 4 | EV_SEVERITY | Call by reference | Type reference (TYPE) | /PLMB/SPI_MSG_SEVERITY | Severity | 20071203 | |||
| 5 | IS_EXPAND_PARAMETERS | Call by reference | Type reference (TYPE) | /PLMB/S_NAV_TREE_EXPAND_PARAMS | Objects to expand and expand options | 20071114 | |||
| 6 | IS_TREEID | Call by reference | Type reference (TYPE) | /PLMB/S_NAV_TREE_ID | NAV - Node ID of Tree | 20071114 |
Method GET_SUBTREE on class /PLMB/CL_NAVC has no exception.
Method INSERT_BREADCRUMB_ITEM Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_BCITEM_DATA | Call by reference | Type reference (TYPE) | /PLMB/S_NAV_BCITEM_SP | NAV - Node data of a Breadcrumb Item | 20071105 | |||
| 2 | ET_MESSAGE | Call by reference | Type reference (TYPE) | /PLMB/T_SPI_MSG | Message | 20080109 | |||
| 3 | EV_SEVERITY | Call by reference | Type reference (TYPE) | /PLMB/SPI_MSG_SEVERITY | Severity | 20080109 | |||
| 4 | IS_CENTRAL_OBJ_INTID | Call by reference | Type reference (TYPE) | /PLMB/S_NAV_OBJ_ID | INTID of Central Object | 20071211 | |||
| 5 | IS_CENTRAL_OBJ_KEY | Call by reference | Type reference (TYPE) | /PLMB/S_NAV_OTYPE_KEY_FIELDS | Key of Central Obj. | 20071211 | |||
| 6 | IV_BC_ITEMID_TEMPLATE | Call by reference | Type reference (TYPE) | /PLMB/NAV_BC_ITEMID | BC Item Template | 20071211 |
Method INSERT_BREADCRUMB_ITEM on class /PLMB/CL_NAVC has no exception.
Method PROVIDE_INTID_BY_KEY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_OBJECT_TYPE_INTID | Call by reference | Type reference (TYPE) | /PLMB/S_NAV_OBJ_ID | Object type-Intid for central object | 20071211 | |||
| 2 | ET_MESSAGE | Call by reference | Type reference (TYPE) | /PLMB/T_SPI_MSG | Message | 20071026 | |||
| 3 | EV_SEVERITY | Call by reference | Type reference (TYPE) | /PLMB/SPI_MSG_SEVERITY | Severity | 20071026 | |||
| 4 | IS_OTYPE_KEY_FIELDS | Call by reference | Type reference (TYPE) | /PLMB/S_NAV_OTYPE_KEY_FIELDS | Object type and key fields for central object | 20071211 |
Method PROVIDE_INTID_BY_KEY on class /PLMB/CL_NAVC has no exception.
Method PROVIDE_KEYS_BY_INTIDS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGE | Call by reference | Type reference (TYPE) | /PLMB/T_SPI_MSG | Message | 20080131 | |||
| 2 | ET_OBJ_KEY_DATA | Call by reference | Type reference (TYPE) | /PLMB/T_NAV_OBJ_SP | NAV - Table with IDs of NAV Objects | 20080131 | |||
| 3 | EV_SEVERITY | Call by reference | Type reference (TYPE) | /PLMB/SPI_MSG_SEVERITY | Severity | 20080131 | |||
| 4 | IT_OBJECT_TYPE_INTID | Call by reference | Type reference (TYPE) | /PLMB/T_NAV_OBJ_ID | NAV - Table with IDs of NAV objects | 20080131 |
Method PROVIDE_KEYS_BY_INTIDS on class /PLMB/CL_NAVC has no exception.
Method READ_LAYOUT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_LAYOUT | Call by reference | Type reference (TYPE) | /PLMB/T_NAV_LAYOUT_SP | NAV - Table with node IDs of Central Objects | 20071031 | |||
| 2 | ET_MESSAGE | Call by reference | Type reference (TYPE) | /PLMB/T_SPI_MSG | Message | 20080109 | |||
| 3 | EV_SEVERITY | Call by reference | Type reference (TYPE) | /PLMB/SPI_MSG_SEVERITY | Severity | 20080109 | |||
| 4 | IV_OTYPE_NAME | Call by reference | Type reference (TYPE) | /PLMB/NAV_OTYPE_NAME | NAV - Object type name | 20071031 | |||
| 5 | IV_USER | Call by reference | Type reference (TYPE) | SYUNAME | SY-UNAME | User Name | 20091003 |
Method READ_LAYOUT on class /PLMB/CL_NAVC has no exception.
Method REDEFINE_PARAMETER_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_SEVERITY | Call by reference | Type reference (TYPE) | /PLMB/SPI_MSG_SEVERITY | Severity | 20090223 | |||
| 2 | IS_PARAMETER_DATA | Call by reference | Type reference (TYPE) | /PLMB/S_NAV_PARAMETER_DATA | NAV - Navigation parameter meta data | 20090223 |
Method REDEFINE_PARAMETER_DATA on class /PLMB/CL_NAVC has no exception.
Method REFRESH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGE | Call by reference | Type reference (TYPE) | /PLMB/T_SPI_MSG | Message | 20080306 | |||
| 2 | EV_SEVERITY | Call by reference | Type reference (TYPE) | /PLMB/SPI_MSG_SEVERITY | Severity | 20080306 |
Method REFRESH on class /PLMB/CL_NAVC has no exception.
Method SET_ACTIVE_TP_VARIANT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_BC_ITEMID | Call by reference | Type reference (TYPE) | /PLMB/NAV_BC_ITEMID | NAV - Breadcrumb Item ID | 20071213 | |||
| 2 | IV_TP_VARIANT_NAME | Call by reference | Type reference (TYPE) | /PLMB/NAV_TABPAGE_VARIANT_NAME | NAV - Tab page variant name | 20071213 |
Method SET_ACTIVE_TP_VARIANT on class /PLMB/CL_NAVC has no exception.
Method SET_LAYOUT_SETTINGS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGE | Call by reference | Type reference (TYPE) | /PLMB/T_SPI_MSG | Message | 20091003 | |||
| 2 | EV_SEVERITY | Call by reference | Type reference (TYPE) | /PLMB/SPI_MSG_SEVERITY | Severity | 20091003 | |||
| 3 | IV_USER | Call by reference | Type reference (TYPE) | SYUNAME | SY-UNAME | User Name | 20091003 | ||
| 4 | IV_USR_LAYOUT | Call by reference | Type reference (TYPE) | /PLMB/S_NAV_USR_LAYOUT | Object Type | 20091003 |
Method SET_LAYOUT_SETTINGS on class /PLMB/CL_NAVC has no exception.
Method SET_SETTINGS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGE | Call by reference | Type reference (TYPE) | /PLMB/T_SPI_MSG | Message | 20091105 | |||
| 2 | EV_FAILED | Call by reference | Type reference (TYPE) | /PLMB/SPI_FAILED_IND | Failed Indicator | 20080507 | |||
| 3 | IT_SETTINGS_VALUES | Call by reference | Type reference (TYPE) | /PLMB/T_NAV_PARAMETER_VALUES | Settings values | 20080820 | |||
| 4 | IV_DELETE_CHECK | Call by reference | Type reference (TYPE) | /PLMB/NAV_DELETE_CHECK | Delete Navigator Settings | 20091105 | |||
| 5 | IV_SAVE_CHECK | Call by reference | Type reference (TYPE) | /PLMB/NAV_SAVE | Save Values | 20090827 |
Method SET_SETTINGS on class /PLMB/CL_NAVC has no exception.
Method SET_TREE_STATUS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_TREEID | Call by reference | Type reference (TYPE) | /PLMB/S_NAV_TREE_ID | NAV - Node ID of Tree | 20071214 | |||
| 2 | IT_EXPANDED_TREE_ELEMENTS | Call by reference | Type reference (TYPE) | /PLMB/T_NAV_TREE_ELEMENT_ID | NAV - Table with node data of a tree | 20071214 |
Method SET_TREE_STATUS on class /PLMB/CL_NAVC has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 100 |