SAP ABAP Class CL_HRGE_OFFICE_DOCUMENT (Global employee: Office Document)
Hierarchy
☛
EA-HRRXX (Software Component) Sub component EA-HRRXX of EA-HR
⤷
PA-GE (Application Component) Management of Global Employees
⤷
PAOC_PAD_MGE (Package) Management Of Global Employees
EA-HRRXX (Software Component) Sub component EA-HRRXX of EA-HR⤷
PA-GE (Application Component) Management of Global Employees⤷
PAOC_PAD_MGE (Package) Management Of Global EmployeesMeta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_HRGE_DOCUMENT | Document (Global Employee) | 20021122 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_HRGE_DOCUMENT_CONST | Constants for documents | 20030116 |
| 3 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_HRPA_BOOLE_D | HR: Master Data, Attribute True and False | 20021113 |
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_HRGE_OS_OFFICE_DOC | Global Employee: Offer Letter In Word | 20021122 |
Properties
| Class | CL_HRGE_OFFICE_DOCUMENT | |
| Short Description | Global employee: Office Document | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | PAOC_PAD_MGE | Management Of Global Employees |
| Created | 20021113 | SAP |
| Last change | 20030113 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  SBDST |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 2 | SOI |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_HRGE_DOCUMENT | Document (Global Employee) | 20021122 | ||
| 2 | IF_HRGE_DOCUMENT_CONST | Constants for documents | 20030116 | ||
| 3 | IF_HRPA_BOOLE_D | HR: Master Data, Attribute True and False | 20021113 |
Friends
Class CL_HRGE_OFFICE_DOCUMENT has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AR_CONTROL |
Instance attribute | Protected | Object reference (TYPE REF TO) | I_OI_CONTAINER_CONTROL | Document Container Control Interface | 20021115 | ||
| 2 | AR_DOC_CALLER |
Instance attribute | Protected | Object reference (TYPE REF TO) | IF_HRGE_DOCUMENT | Global Employee Document | 20021118 | ||
| 3 | AR_PROXY |
Instance attribute | Protected | Object reference (TYPE REF TO) | I_OI_DOCUMENT_PROXY | General Document Interface | 20021115 | ||
| 4 | AR_TABLE_COLLECTION |
Instance attribute | Protected | Object reference (TYPE REF TO) | I_OI_TABLE_COLLECTION | Table Collection | 20021115 | ||
| 5 | A_CLASS_MGEFORMS |
Static Attribute | Public | Type reference (TYPE) | SBDST_CLASSNAME | 'HRMGE_FORMS' | 20021122 | ||
| 6 | A_COMPONENT |
Instance attribute | Protected | Type reference (TYPE) | BAPICOMPON | Business Document Service: Component Table | 20021122 | ||
| 7 | A_DOCUMENT_CLASS |
Instance attribute | Public | Attribute reference (LIKE) | 20030116 | ||||
| 8 | A_DOCUMENT_ID |
Instance attribute | Protected | Type reference (TYPE) | BDS_DOCID | Business Document Service: Document ID | 20021122 | ||
| 9 | A_DOCUMENT_TYPE |
Instance attribute | Public | Attribute reference (LIKE) | 20030116 | ||||
| 10 | A_DOC_TYPE |
Instance attribute | Protected | Type reference (TYPE) | SOI_DOCUMENT_TYPE | 20021115 | |||
| 11 | A_NEW_DOC_ID |
Instance attribute | Protected | Type reference (TYPE) | BDS_DOCID | Business Document Service: Document ID | 20021122 | ||
| 12 | A_NEW_VAR_ID |
Instance attribute | Protected | Type reference (TYPE) | SBDST_DOC_VAR_ID | 20021122 | |||
| 13 | A_NEW_VER_NO |
Instance attribute | Protected | Type reference (TYPE) | BDS_DVERNO | Business Document Service: Document version number | 20021122 | ||
| 14 | A_OBJECTKEY |
Static Attribute | Public | Type reference (TYPE) | SBDST_OBJECT_KEY | 'FORMS' | 20021122 | ||
| 15 | A_OPEN_INPLACE |
Instance attribute | Protected | Type reference (TYPE) | BOOLE_D | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20021115 | ||
| 16 | A_OPEN_READONLY |
Instance attribute | Protected | Type reference (TYPE) | BOOLE_D | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20021115 | ||
| 17 | A_SIGNATURE |
Instance attribute | Protected | Type reference (TYPE) | BAPISIGNAT | Business Document Service: Signature Table | 20021122 | ||
| 18 | A_STARTUP_MACRO |
Instance attribute | Protected | Type reference (TYPE) | STRING | 'InitDisplay' | 20021122 | ||
| 19 | A_TEMPLATE_TYPE |
Static Attribute | Public | Type reference (TYPE) | SBDST_CLASSTYPE | 'OT' | 20021122 | ||
| 20 | A_URL |
Instance attribute | Protected | Type reference (TYPE) | BDS_URI | Business Document Service: URI | 20021122 | ||
| 21 | A_VERSION_NO |
Instance attribute | Protected | Type reference (TYPE) | BDS_DVERNO | Business Document Service: Document version number | 20021122 | ||
| 22 | C_BOR_TYPE |
Instance attribute | Protected | Attribute reference (LIKE) | 20030116 | ||||
| 23 | C_COM_CUSTOMIZE |
Constant | Public | Type reference (TYPE) | PMGE_COMMAND_TYPE | 'CUST' | Command Type for openning a Document | 20021128 | |
| 24 | C_COM_NORMAL |
Constant | Public | Type reference (TYPE) | PMGE_COMMAND_TYPE | 'NORM' | Command Type for openning a Document | 20021128 | |
| 25 | C_COM_PRINT |
Constant | Public | Type reference (TYPE) | PMGE_COMMAND_TYPE | 'PRNT' | Command Type for openning a Document | 20021128 | |
| 26 | C_DOCTYPE_PREFIX |
Instance attribute | Protected | Attribute reference (LIKE) | 20030116 | ||||
| 27 | C_DOC_TYPE |
Instance attribute | Protected | Attribute reference (LIKE) | 20030116 | ||||
| 28 | C_GE_CLASS |
Instance attribute | Protected | Attribute reference (LIKE) | 20030116 | ||||
| 29 | C_GLOBASSIGN_CLASS |
Instance attribute | Protected | Attribute reference (LIKE) | 20030116 | ||||
| 30 | C_MACRO_EDIT |
Constant | Public | Type reference (TYPE) | PMGE_OFFICE_MACRO | 'EditMacro' | Office Macro | 20021127 | |
| 31 | C_MACRO_FINISH_CUSTOMIZE |
Constant | Public | Type reference (TYPE) | PMGE_OFFICE_MACRO | 'FinishCustomize' | Office Macro | 20021127 | |
| 32 | C_MACRO_FINISH_DISPLAY |
Constant | Public | Type reference (TYPE) | PMGE_OFFICE_MACRO | 'FinishDisplay' | Office Macro | 20021127 | |
| 33 | C_MACRO_FINISH_PRINT |
Constant | Public | Type reference (TYPE) | PMGE_OFFICE_MACRO | 'FinishPrint' | Office Macro | 20021127 | |
| 34 | C_MACRO_INIT_CUSTOMIZE |
Constant | Public | Type reference (TYPE) | PMGE_OFFICE_MACRO | 'InitCustomize' | Office Macro | 20021127 | |
| 35 | C_MACRO_INIT_DISPLAY |
Constant | Public | Type reference (TYPE) | PMGE_OFFICE_MACRO | 'InitDisplay' | Office Macro | 20021127 | |
| 36 | C_MACRO_INIT_PRINT |
Constant | Public | Type reference (TYPE) | PMGE_OFFICE_MACRO | 'InitPrint' | Office Macro | 20021127 | |
| 37 | C_MACRO_INSERT_DATA |
Constant | Public | Type reference (TYPE) | PMGE_OFFICE_MACRO | 'InsertData' | Office Macro | 20021127 | |
| 38 | C_MACRO_RESET_FORM |
Constant | Public | Type reference (TYPE) | PMGE_OFFICE_MACRO | 'DeleteCurrentData' | Office Macro | 20021127 | |
| 39 | C_OL_CLASS |
Instance attribute | Protected | Attribute reference (LIKE) | 20030116 | ||||
| 40 | C_PDFTYPE_PREFIX |
Instance attribute | Protected | Attribute reference (LIKE) | 20030116 | ||||
| 41 | C_PDF_TYPE |
Instance attribute | Protected | Attribute reference (LIKE) | 20030116 | ||||
| 42 | FALSE |
Instance attribute | Protected | Attribute reference (LIKE) | 20021113 | ||||
| 43 | TRUE |
Instance attribute | Protected | Attribute reference (LIKE) | 20021113 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ADD_TABLE |
Instance method | Protected | Method | Export a table to the Office document | 20021122 |
| 2 | CLOSE |
Instance method | Public | Method | 20021129 | |
| 3 | CONSTRUCTOR |
Instance method | Public | Constructor | CONSTRUCTOR | 20021220 |
| 4 | ENDUP_MACRO |
Instance method | Protected | Method | Get the endup macro | 20021128 |
| 5 | EXECUTE_MACRO |
Instance method | Public | Method | Execute a Macro in the Office Document | 20021122 |
| 6 | EXPORT_DATA |
Instance method | Protected | Method | Export data to the Office document | 20021128 |
| 7 | ON_CLOSE_DOCUMENT |
Instance method | Public | Event handling method | Method called when document closed | 20021113 |
| 8 | OPEN |
Instance method | Public | Method | 20021129 | |
| 9 | OPEN_TEMPLATE |
Instance method | Public | Method | Open an Office template | 20021122 |
| 10 | PRINT |
Instance method | Public | Method | 20021129 | |
| 11 | RESET |
Instance method | Public | Method | Load the document with empty data | 20021127 |
| 12 | SAVE |
Instance method | Public | Method | 20021129 | |
| 13 | SAVE_AS |
Instance method | Protected | Method | Save the document at a given place | 20021122 |
| 14 | SAVE_TEMPLATE |
Instance method | Public | Method | Save the document | 20021122 |
| 15 | STARTUP_MACRO |
Instance method | Protected | Method | Get the startup macro | 20021122 |
Events
Class CL_HRGE_OFFICE_DOCUMENT has no event.
Types
Class CL_HRGE_OFFICE_DOCUMENT has no local type.
Method Signatures
Method ADD_TABLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Changing |
DATA_TABLE | Call by reference | Type reference (TYPE) | TABLE | 20021122 | |||
| 2 |  Importing |
DDIC_NAME | Call by reference | Type reference (TYPE) | X030L-TABNAME | Tabellenname | 20021122 | ||
| 3 |  Exporting |
IS_OK | Call by reference | Type reference (TYPE) | PMGE_RETURN_CODE | Rückgabewert (Wahr = 'X', Unwahr = Leer) | 20021122 | ||
| 4 | Importing |
MESS_HANDLER | Call by reference | Object reference (TYPE REF TO) | IF_HRGE_MESSAGE_HANDLER | HR-Management globaler Mitarbeiter: Meldungen | 20021122 | ||
| 5 | Importing |
NO_FLUSH | Call by reference | Type reference (TYPE) | C | 20021122 | |||
| 6 | Importing |
TABLE_NAME | Call by reference | Type reference (TYPE) | C | 20021122 | |||
| 7 | Importing |
TABLE_TYPE | Call by reference | Type reference (TYPE) | I | 20021122 |
Method ADD_TABLE on class CL_HRGE_OFFICE_DOCUMENT has no exception.
Method CLOSE Signature
Method CLOSE on class CL_HRGE_OFFICE_DOCUMENT has no parameter.
Method CLOSE on class CL_HRGE_OFFICE_DOCUMENT has no exception.
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
CONTROL | Call by reference | Object reference (TYPE REF TO) | I_OI_CONTAINER_CONTROL | Steuerungsschnittstelle für Dokumentcontainer | 20021220 |
Method CONSTRUCTOR on class CL_HRGE_OFFICE_DOCUMENT has no exception.
Method ENDUP_MACRO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
COMMAND_TYPE | Call by reference | Type reference (TYPE) | PMGE_COMMAND_TYPE | Befehlsart zum Öffnen eines Dokuments | 20021128 | ||
| 2 |  Returning |
ENDUP_MACRO | Value transfer | Type reference (TYPE) | PMGE_OFFICE_MACRO | Office-Makro | 20021128 |
Method ENDUP_MACRO on class CL_HRGE_OFFICE_DOCUMENT has no exception.
Method EXECUTE_MACRO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
IS_OK | Call by reference | Type reference (TYPE) | PMGE_RETURN_CODE | Rückgabewert (Wahr = 'X', Unwahr = Leer) | 20021122 | ||
| 2 | Importing |
MACRO_NAME | Call by reference | Type reference (TYPE) | C | 20021122 | |||
| 3 | Importing |
MESS_HANDLER | Call by reference | Object reference (TYPE REF TO) | IF_HRGE_MESSAGE_HANDLER | HR-Management globaler Mitarbeiter: Meldungen | 20021122 | ||
| 4 | Importing |
PARAM1 | Call by reference | Type reference (TYPE) | ANY | 20021122 | |||
| 5 | Changing |
RETVALUE | Call by reference | Type reference (TYPE) | ANY | 20021122 |
Method EXECUTE_MACRO on class CL_HRGE_OFFICE_DOCUMENT has no exception.
Method EXPORT_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
IS_OK | Call by reference | Type reference (TYPE) | PMGE_RETURN_CODE | Rückgabewert (Wahr = 'X', Unwahr = Leer) | 20021128 | ||
| 2 | Importing |
LANGU | Call by reference | Type reference (TYPE) | THEAD-TDSPRAS | SY-LANGU | Sprachenschlüssel | 20021129 | |
| 3 | Importing |
MESS_HANDLER | Call by reference | Object reference (TYPE REF TO) | IF_HRGE_MESSAGE_HANDLER | HR-Management globaler Mitarbeiter: Meldungen | 20021128 |
Method EXPORT_DATA on class CL_HRGE_OFFICE_DOCUMENT has no exception.
Method ON_CLOSE_DOCUMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
DOCUMENT_PROXY | Call by reference | Attribute reference (LIKE) | 20021113 | ||||
| 2 | Importing |
HAS_CHANGED | Call by reference | Attribute reference (LIKE) | 20021113 |
Method ON_CLOSE_DOCUMENT on class CL_HRGE_OFFICE_DOCUMENT has no exception.
Method OPEN Signature
Method OPEN on class CL_HRGE_OFFICE_DOCUMENT has no parameter.
Method OPEN on class CL_HRGE_OFFICE_DOCUMENT has no exception.
Method OPEN_TEMPLATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
COMMAND_TYPE | Call by reference | Type reference (TYPE) | PMGE_COMMAND_TYPE | Befehlsart zum Öffnen eines Dokuments | 20021128 | ||
| 2 | Importing |
DOCUMENT_ID | Call by reference | Type reference (TYPE) | BDS_DOCID | Business Document Service: Dokument-ID | 20021122 | ||
| 3 | Importing |
INPLACE_SHOW_TOOLBARS | Call by reference | Type reference (TYPE) | BOOLE_D | Datenelement zur Domäne BOOLE: TRUE (='X') und FALSE (=' ') | 20021122 | ||
| 4 | Exporting |
IS_OK | Call by reference | Type reference (TYPE) | PMGE_RETURN_CODE | Rückgabewert (Wahr = 'X', Unwahr = Leer) | 20021122 | ||
| 5 | Importing |
LANGU | Call by reference | Type reference (TYPE) | THEAD-TDSPRAS | SY-LANGU | Sprachenschlüssel | 20021129 | |
| 6 | Importing |
MESS_HANDLER | Call by reference | Object reference (TYPE REF TO) | IF_HRGE_MESSAGE_HANDLER | HR-Management globaler Mitarbeiter: Meldungen | 20021122 | ||
| 7 | Importing |
OPEN_INPLACE | Call by reference | Type reference (TYPE) | BOOLE_D | Dokument im übergeordneten oder externen Fenster öffnen | 20021122 | ||
| 8 | Importing |
READ_ONLY | Call by reference | Type reference (TYPE) | BOOLE_D | Nur-Lese-Commits | 20021122 | ||
| 9 | Importing |
STARTUP_MACRO | Call by reference | Type reference (TYPE) | C | 20021122 | |||
| 10 | Importing |
VERSION_NO | Call by reference | Type reference (TYPE) | BDS_DVERNO | Business Document Service: Dokumentversionsnummer | 20021122 |
Method OPEN_TEMPLATE on class CL_HRGE_OFFICE_DOCUMENT has no exception.
Method PRINT Signature
Method PRINT on class CL_HRGE_OFFICE_DOCUMENT has no parameter.
Method PRINT on class CL_HRGE_OFFICE_DOCUMENT has no exception.
Method RESET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
IS_OK | Call by reference | Type reference (TYPE) | PMGE_RETURN_CODE | Rückgabewert (Wahr = 'X', Unwahr = Leer) | 20021127 | ||
| 2 | Importing |
MESS_HANDLER | Call by reference | Object reference (TYPE REF TO) | IF_HRGE_MESSAGE_HANDLER | HR-Management globaler Mitarbeiter: Meldungen | 20021127 |
Method RESET on class CL_HRGE_OFFICE_DOCUMENT has no exception.
Method SAVE Signature
Method SAVE on class CL_HRGE_OFFICE_DOCUMENT has no parameter.
Method SAVE on class CL_HRGE_OFFICE_DOCUMENT has no exception.
Method SAVE_AS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
CLASSNAME | Call by reference | Type reference (TYPE) | SBDST_CLASSNAME | 20021122 | |||
| 2 | Importing |
CLASSTYPE | Call by reference | Type reference (TYPE) | SBDST_CLASSTYPE | 20021122 | |||
| 3 | Importing |
DESCRIPTION | Call by reference | Type reference (TYPE) | STRING | 20021122 | |||
| 4 | Exporting |
IS_OK | Call by reference | Type reference (TYPE) | BOOLE_D | Datenelement zur Domäne BOOLE: TRUE (='X') und FALSE (=' ') | 20021122 | ||
| 5 | Importing |
MESS_HANDLER | Call by reference | Object reference (TYPE REF TO) | IF_HRGE_MESSAGE_HANDLER | HR-Management globaler Mitarbeiter: Meldungen | 20021122 | ||
| 6 | Importing |
OBJECT_KEY | Call by reference | Type reference (TYPE) | SBDST_OBJECT_KEY | 20021122 |
Method SAVE_AS on class CL_HRGE_OFFICE_DOCUMENT has no exception.
Method SAVE_TEMPLATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
IS_OK | Call by reference | Type reference (TYPE) | BOOLE_D | Datenelement zur Domäne BOOLE: TRUE (='X') und FALSE (=' ') | 20021122 | ||
| 2 | Importing |
MESS_HANDLER | Call by reference | Object reference (TYPE REF TO) | IF_HRGE_MESSAGE_HANDLER | HR-Management globaler Mitarbeiter: Meldungen | 20021122 |
Method SAVE_TEMPLATE on class CL_HRGE_OFFICE_DOCUMENT has no exception.
Method STARTUP_MACRO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
COMMAND_TYPE | Call by reference | Type reference (TYPE) | PMGE_COMMAND_TYPE | Befehlsart zum Öffnen eines Dokuments | 20021128 | ||
| 2 | Returning |
STARTUP_MACRO | Value transfer | Type reference (TYPE) | PMGE_OFFICE_MACRO | Office-Makro | 20021122 |
Method STARTUP_MACRO on class CL_HRGE_OFFICE_DOCUMENT has no exception.
History
| Last changed by/on | SAP | 20030113 |
| SAP Release Created in | 200 |
