SAP ABAP Class /BOBF/CL_FRW_ADDON (Runtime addon management)
Hierarchy
☛
SAP_BS_FND (Software Component) SAP Business Suite Foundation
⤷
AP-RC-BOF-RNT (Application Component) Business Object Processing Framework Runtime
⤷
/BOBF/FRAMEWORK (Package) Business Object Processing Framework
⤷
⤷
Properties
| Class | /BOBF/CL_FRW_ADDON | |
| Short Description | Runtime addon management | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | /BOBF/FRAMEWORK | Business Object Processing Framework |
| Created | 20081212 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class /BOBF/CL_FRW_ADDON has no forward declaration.
Interfaces
Class /BOBF/CL_FRW_ADDON has no interface implemented.
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | /BOBF/CL_FRW_FACTORY | 20081212 | Framework Instance Management | |
| 2 | /BOBF/CL_TRA_SERV_MGR_FACTORY | 20090130 | Factory class for the (proxy) service manager | |
| 3 | /BOBF/CL_TRA_TRANS_MGR_FACTORY | 20090130 | Factory class for the transaction manager |
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Public | Type reference (TYPE) | /BOBF/FRW_ADDON_ACCESS | 'X' | Addon access (yes/no/configurable) | 20081212 | ||
| 2 | Constant | Public | Type reference (TYPE) | /BOBF/FRW_ADDON_ACCESS | 'A' | Addon access (yes/no/configurable) | 20081212 | ||
| 3 | Constant | Public | Type reference (TYPE) | /BOBF/FRW_ADDON_ACCESS | ' ' | Addon access (yes/no/configurable) | 20081212 | ||
| 4 | Static Attribute | Private | Type reference (TYPE) | /BOBF/T_FRW_KEY2 | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20081212 | |||
| 5 | Static Attribute | Private | Type reference (TYPE) | TT_ADDON | 20081212 | ||||
| 6 | Static Attribute | Private | Type reference (TYPE) | TT_ADDON_RUNTIME | 20081212 | ||||
| 7 | Static Attribute | Private | Type reference (TYPE) | BOOLE_D | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20081212 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | Dynamically activate addon | 20081212 | |
| 2 | Static method | Private | Method | Check for active addons | 20081212 | |
| 3 | Static method | Private | Method | Invoke BOPF instance dependent addons | 20081212 | |
| 4 | Static method | Private | Method | Invoke configuration instance dependent addons | 20081212 | |
| 5 | Static method | Private | Method | Invoke Service Manager related addons | 20090130 | |
| 6 | Static method | Private | Method | Invoke Transaction Manager related addons | 20090130 | |
| 7 | Static method | Public | Constructor | CLASS_CONSTRUCTOR | 20081212 | |
| 8 | Static method | Public | Method | Delete static addon activation | 20081212 | |
| 9 | Static method | Public | Method | delete addon settings | 20081212 | |
| 10 | Static method | Public | Method | Get static addon activation | 20081212 | |
| 11 | Static method | Public | Method | Get addon settings | 20081212 | |
| 12 | Static method | Public | Method | Set static addon activation | 20081212 | |
| 13 | Static method | Public | Method | Set addon settings | 20081212 |
Events
Class /BOBF/CL_FRW_ADDON has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TT_ADDON | Public | See coding | 20081212 | tt_addon TYPE SORTED TABLE OF ty_addon WITH UNIQUE KEY addon_name
|
||
| 2 | TT_ADDON_ACTIVATION | Public | See coding | 20081212 | tt_addon_activation TYPE STANDARD TABLE OF ty_addon_activation
|
||
| 3 | TT_ADDON_RUNTIME | Public | See coding | 20081212 | tt_addon_runtime TYPE SORTED TABLE OF ty_addon_runtime WITH UNIQUE KEY bo_key addon_name
|
||
| 4 | TY_ADDON | Public | See coding | 20081212 | BEGIN OF ty_addon,
addon_name TYPE /BOBF/OBM_NAME,
addon_class TYPE seoclsname,
configuration TYPE /BOBF/FRW_ADDON_ACCESS,
bopf TYPE /BOBF/FRW_ADDON_ACCESS,
activation TYPE /BOBF/FRW_ADDON_ACTIVATION,
serv_mgr TYPE /BOBF/FRW_ADDON_ACCESS,
trans_mgr TYPE /BOBF/FRW_ADDON_ACCESS,
END OF ty_addon
|
||
| 5 | TY_ADDON_ACTIVATION | Public | See coding | 20081212 | BEGIN OF ty_addon_activation,
addon_name TYPE /BOBF/OBM_NAME,
uname TYPE uname,
bo_key TYPE /BOBF/OBM_BO_KEY,
config_active TYPE boole_d,
bopf_active TYPE boole_d,
serv_mgr_active TYPE boole_d,
trans_mgr_active TYPE boole_d,
END OF ty_addon_activation
|
||
| 6 | TY_ADDON_RUNTIME | Public | See coding | 20081212 | BEGIN OF ty_addon_runtime,
bo_key TYPE /BOBF/OBM_BO_KEY,
addon_name TYPE /BOBF/OBM_NAME,
addon_class TYPE seoclsname,
configuration TYPE /BOBF/FRW_ADDON_ACCESS,
bopf TYPE /BOBF/FRW_ADDON_ACCESS,
serv_mgr TYPE /BOBF/FRW_ADDON_ACCESS,
trans_mgr TYPE /BOBF/FRW_ADDON_ACCESS,
END OF ty_addon_runtime
|
Method Signatures
Method ACTIVATE_ADDON Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ADDON_NAME | Call by reference | Type reference (TYPE) | /BOBF/OBM_NAME | Name | 20081212 | |||
| 2 | IV_BOPF | Call by reference | Type reference (TYPE) | BOOLE_D | Activate BOPF access - use only if addon access adjustable | 20081212 | |||
| 3 | IV_BO_KEY | Call by reference | Type reference (TYPE) | /BOBF/OBM_BO_KEY | Business Object | 20081212 | |||
| 4 | IV_CONFIGURATION | Call by reference | Type reference (TYPE) | BOOLE_D | Activate config access - use only if addon access adjustable | 20081212 | |||
| 5 | IV_SERV_MGR | Call by reference | Type reference (TYPE) | BOOLE_D | Activate service mgr - use only if addon access adjustable | 20090209 | |||
| 6 | IV_TRANS_MGR | Call by reference | Type reference (TYPE) | BOOLE_D | Activate trans mgr - use only if addon access adjustable | 20090209 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20081212 |
Method ADDON_ACTIVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_BOPF | Call by reference | Type reference (TYPE) | BOOLE_D | Addon for BOPF instance active | 20081212 | |||
| 2 | EV_CONF | Call by reference | Type reference (TYPE) | BOOLE_D | Addon for configuration instance active | 20081212 | |||
| 3 | EV_SERV_MGR | Call by reference | Type reference (TYPE) | BOOLE_D | Addon for Service Manager instance active | 20090130 | |||
| 4 | EV_TRANS_MGR | Call by reference | Type reference (TYPE) | BOOLE_D | Addon for Transaction Manager instance | 20090130 | |||
| 5 | IV_BO_KEY | Call by reference | Type reference (TYPE) | /BOBF/OBM_BO_KEY | Business Object | 20081212 |
Method ADDON_ACTIVE on class /BOBF/CL_FRW_ADDON has no exception.
Method ADJUST_BOPF Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CO_BOPF | Call by reference | Object reference (TYPE REF TO) | /BOBF/IF_FRW_SERVICE_LAYER | Interface for the Service Layer | 20081212 | |||
| 2 | IV_BO_KEY | Call by reference | Type reference (TYPE) | /BOBF/OBM_BO_KEY | Business Object | 20081212 |
Method ADJUST_BOPF on class /BOBF/CL_FRW_ADDON has no exception.
Method ADJUST_CONF Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_CONF | Call by reference | Object reference (TYPE REF TO) | /BOBF/IF_CONFRT_COMPLETE | Interface for Configuration | 20081212 | |||
| 2 | IV_BO_KEY | Call by reference | Type reference (TYPE) | /BOBF/OBM_BO_KEY | Business Object | 20081212 |
Method ADJUST_CONF on class /BOBF/CL_FRW_ADDON has no exception.
Method ADJUST_SERV_MGR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CO_SERV_MGR | Call by reference | Object reference (TYPE REF TO) | /BOBF/IF_TRA_SERV_MGR_COMPL | Interface for (Proxy) Service Manager | 20090130 | |||
| 2 | IV_BO_KEY | Call by reference | Type reference (TYPE) | /BOBF/OBM_BO_KEY | Business Object | 20090130 |
Method ADJUST_SERV_MGR on class /BOBF/CL_FRW_ADDON has no exception.
Method ADJUST_TRANS_MGR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CO_TRANS_MGR | Call by reference | Object reference (TYPE REF TO) | /BOBF/IF_TRA_TRANS_MGR_COMPL | Transaction Manager | 20090130 |
Method ADJUST_TRANS_MGR on class /BOBF/CL_FRW_ADDON has no exception.
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class /BOBF/CL_FRW_ADDON has no parameter.
Method CLASS_CONSTRUCTOR on class /BOBF/CL_FRW_ADDON has no exception.
Method DELETE_ADDON_ACTIVATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ADDON_NAME | Call by reference | Type reference (TYPE) | /BOBF/OBM_NAME | Addon name | 20081212 | |||
| 2 | IV_BO_KEY | Call by reference | Type reference (TYPE) | /BOBF/OBM_BO_KEY | Business Object | 20081212 | |||
| 3 | IV_UNAME | Call by reference | Type reference (TYPE) | UNAME | User Name | 20081212 |
Method DELETE_ADDON_ACTIVATION on class /BOBF/CL_FRW_ADDON has no exception.
Method DELETE_ADDON_SETTINGS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ADDON_NAME | Call by reference | Type reference (TYPE) | /BOBF/OBM_NAME | Addon name | 20081212 |
Method DELETE_ADDON_SETTINGS on class /BOBF/CL_FRW_ADDON has no exception.
Method GET_ADDON_ACTIVATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_ADDON_ACTIVATION | Call by reference | Type reference (TYPE) | TY_ADDON_ACTIVATION | 20081212 | ||||
| 2 | ET_ADDON_ACTIVATION | Call by reference | Type reference (TYPE) | TT_ADDON_ACTIVATION | 20081212 | ||||
| 3 | IV_ADDON_NAME | Call by reference | Type reference (TYPE) | /BOBF/OBM_NAME | Addon name | 20081212 | |||
| 4 | IV_BO_KEY | Call by reference | Type reference (TYPE) | /BOBF/OBM_BO_KEY | Business Object | 20081212 | |||
| 5 | IV_UNAME | Call by reference | Type reference (TYPE) | UNAME | User Name | 20081212 |
Method GET_ADDON_ACTIVATION on class /BOBF/CL_FRW_ADDON has no exception.
Method GET_ADDON_SETTINGS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_ADDON_SETTINGS | Call by reference | Type reference (TYPE) | TY_ADDON | 20081212 | ||||
| 2 | IV_ADDON_NAME | Call by reference | Type reference (TYPE) | /BOBF/OBM_NAME | Addon name | 20081212 |
Method GET_ADDON_SETTINGS on class /BOBF/CL_FRW_ADDON has no exception.
Method SET_ADDON_ACTIVATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_ADDON_ACTIVATION | Call by reference | Type reference (TYPE) | TY_ADDON_ACTIVATION | 20081212 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20081212 |
Method SET_ADDON_SETTINGS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_ADDON_SETTINGS | Call by reference | Type reference (TYPE) | TY_ADDON | 20081212 |
Method SET_ADDON_SETTINGS on class /BOBF/CL_FRW_ADDON has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 702 |