SAP ABAP Class CL_ESH_EX_EXTRACTOR_USER (Generation / Mainenance of Generic User for ESH Data Extract)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
⤷
S_ESH_ENG_EXTRACTION (Package) Extraction
⤷
⤷
Properties
| Class | CL_ESH_EX_EXTRACTOR_USER | |
| Short Description | Generation / Mainenance of Generic User for ESH Data Extract | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_ESH_ENG_EXTRACTION | Extraction |
| Created | 20090429 | SAP |
| Last change | 20110908 | 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 CL_ESH_EX_EXTRACTOR_USER has no interface implemented.
Friends
Class CL_ESH_EX_EXTRACTOR_USER has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Public | Type reference (TYPE) | SY-UNAME | 'ESH%' | User Name Prefix | 20090429 | ||
| 2 | Constant | Public | Type reference (TYPE) | SY-UNAME | 'EX' | User Name Suffix | 20090429 | ||
| 3 | Static Attribute | Private | Type reference (TYPE) | ESH_EX_EXTR_USER | Extraction User | 20090508 | |||
| 4 | Static Attribute | Private | Type reference (TYPE) | CHAR01 | Buffer is up-to-date | 20090508 | |||
| 5 | Instance attribute | Private | Object reference (TYPE REF TO) | IF_ESH_OM_APPLOG | Application Log | 20090507 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Adjust profile | 20090429 | |
| 2 | Instance method | Private | Method | Is authorized to change user profiles | 20090507 | |
| 3 | Static method | Public | Constructor | STATIC: Class Constructor | 20090506 | |
| 4 | Instance method | Public | Constructor | Constructor | 20090429 | |
| 5 | Instance method | Public | Method | Create | 20090429 | |
| 6 | Instance method | Private | Method | Generate data extractor profile and add to user | 20090429 | |
| 7 | Static method | Public | Method | STATIC: Get ESH Extractor User | 20090429 | |
| 8 | Static method | Public | Method | STATIC: Get Admin Details | 20090508 | |
| 9 | Static method | Public | Method | STATIC: Check ESH Extractor User is Maintained | 20090429 | |
| 10 | Instance method | Public | Method | Propose Name for Extraction User | 20090506 | |
| 11 | Static method | Private | Method | Register (internal) | 20090508 | |
| 12 | Instance method | Public | Method | Reset | 20090507 | |
| 13 | Static method | Private | Method | Select (internal) | 20090508 | |
| 14 | Static method | Private | Method | Unregister (internal) | 20090508 |
Events
Class CL_ESH_EX_EXTRACTOR_USER has no event.
Types
Class CL_ESH_EX_EXTRACTOR_USER has no local type.
Method Signatures
Method ADJUST_PROFILE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_ERROR | Call by reference | Type reference (TYPE) | BOOLE_D | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20090513 | |||
| 2 | IV_USER | Call by reference | Type reference (TYPE) | ESH_E_EX_EXTR_USER | User for Data Extraction | 20090513 |
Method ADJUST_PROFILE on class CL_ESH_EX_EXTRACTOR_USER has no exception.
Method CHECK_IS_AUTHORIZED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CT_RETURN | Call by reference | Type reference (TYPE) | BAPIRETTAB | BAPI-return messages | 20090507 | |||
| 2 | EV_NOT_AUTHORIZED | Call by reference | Type reference (TYPE) | CHAR01 | BAPI-return contains message 'Not Authorized' | 20090507 |
Method CHECK_IS_AUTHORIZED on class CL_ESH_EX_EXTRACTOR_USER has no exception.
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class CL_ESH_EX_EXTRACTOR_USER has no parameter.
Method CLASS_CONSTRUCTOR on class CL_ESH_EX_EXTRACTOR_USER has no exception.
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_APPLOG | Call by reference | Object reference (TYPE REF TO) | IF_ESH_OM_APPLOG | Application Log | 20090507 |
Method CONSTRUCTOR on class CL_ESH_EX_EXTRACTOR_USER has no exception.
Method CREATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_PWD | Call by reference | Type reference (TYPE) | BAPIPWD-BAPIPWD | Auto-generated passwd | 20090507 | |||
| 2 | EV_USER_GENERATED | Call by reference | Type reference (TYPE) | CHAR01 | User has been generated | 20090507 | |||
| 3 | EV_USER_REGISTERED | Call by reference | Type reference (TYPE) | CHAR01 | User has been registered | 20090507 | |||
| 4 | IV_GENERATE_NEW_USER | Call by reference | Type reference (TYPE) | CHAR01 | Generate new user | 20090507 | |||
| 5 | IV_SET_IMPORTED_USER | Call by reference | Type reference (TYPE) | CHAR01 | Set imported user | 20090507 | |||
| 6 | IV_USER_NAME | Call by reference | Type reference (TYPE) | ESH_E_EX_EXTR_USER | User for Data Extraction | 20090507 |
Method CREATE on class CL_ESH_EX_EXTRACTOR_USER has no exception.
Method GENERATE_PROFILE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_EXTR_USER | Call by reference | Type reference (TYPE) | ESH_E_EX_EXTR_USER | Extractor User | 20090507 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Extraction: Not sufficient authorization | 20090508 | ||
| 2 | Extraction: Processing error | 20090508 |
Method GET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_EXTRACTION_USER | Value transfer | Type reference (TYPE) | ESH_E_EX_EXTR_USER | Extraction User | 20090506 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ESH Extraction User does not exist | 20090429 |
Method GET_ADMIN_DETAILS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RS_ADMIN_DETAILS | Value transfer | Type reference (TYPE) | ESH_EX_EXTR_USER | User for Data Extraction | 20090508 |
Method GET_ADMIN_DETAILS on class CL_ESH_EX_EXTRACTOR_USER has no exception.
Method IS_MAINTAINED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_BYPASSING_BUFFER | Call by reference | Type reference (TYPE) | CHAR01 | Reselect from DB | 20090506 | |||
| 2 | RV_IS_MAINTAINED | Value transfer | Type reference (TYPE) | CHAR01 | ESH extractor user is maintained | 20090429 |
Method IS_MAINTAINED on class CL_ESH_EX_EXTRACTOR_USER has no exception.
Method PROPOSE_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_PROPOSED_NAME | Value transfer | Type reference (TYPE) | ESH_E_EX_EXTR_USER | Proposed Name for Extraction User | 20090506 |
Method PROPOSE_NAME on class CL_ESH_EX_EXTRACTOR_USER has no exception.
Method REGISTER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_EXTR_USER | Call by reference | Type reference (TYPE) | ESH_E_EX_EXTR_USER | User for Data Extraction | 20090508 | |||
| 2 | IV_IS_GENERATED | Call by reference | Type reference (TYPE) | CHAR01 | Is Generated User | 20090508 | |||
| 3 | IV_UPD_LASTGEN_TSP | Call by reference | Type reference (TYPE) | CHAR01 | ABAP_TRUE | Update Last Generation Tsp | 20090508 | ||
| 4 | IV_UPD_LAST_ROLEUPD_TSP | Call by reference | Type reference (TYPE) | CHAR01 | ABAP_TRUE | Update Last Role-Update Tsp | 20090508 |
Method REGISTER on class CL_ESH_EX_EXTRACTOR_USER has no exception.
Method RESET Signature
Method RESET on class CL_ESH_EX_EXTRACTOR_USER has no parameter.
Method RESET on class CL_ESH_EX_EXTRACTOR_USER has no exception.
Method SELECT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RS_EXTRACTION_USER | Value transfer | Type reference (TYPE) | ESH_EX_EXTR_USER | User Details for Data Extraction | 20090508 |
Method SELECT on class CL_ESH_EX_EXTRACTOR_USER has no exception.
Method UNREGISTER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_INCL_ADMINDATA | Call by reference | Type reference (TYPE) | CHAR01 | ABAP_FALSE | Do not store unregistration admin data | 20090515 |
Method UNREGISTER on class CL_ESH_EX_EXTRACTOR_USER has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 720 |