SAP ABAP Class CL_GUI_DOCUMENTS (Documents)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-SRV-ARL (Application Component) ArchiveLink
     SAOP (Package) ArchiveLink general
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  CL_ALINK_CONSTANTS Constants 20010920
Properties
Class CL_GUI_DOCUMENTS  
Short Description Documents    
Super Class CL_ALINK_CONSTANTS Constants 
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package SAOP   ArchiveLink general 
Created 20010920   SAP 
Last change 00000000   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
Class CL_GUI_DOCUMENTS has no forward declaration.
Interfaces
Class CL_GUI_DOCUMENTS has no interface implemented.
Friends
Class CL_GUI_DOCUMENTS has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 ANNO_COMPONENTS Instance attribute Private Type reference (TYPE) AL_COMPONENTS Components of Stored Documents 20010920
2 COMMUNICATION_TYPE Instance attribute Private Type reference (TYPE) P Communication type 20010920
3 COMPONENT_OBJECTS Instance attribute Private Type reference (TYPE) DOC_COMPS Document Component Object List 20010920
4 CONTENTCONTAINER Instance attribute Private Object reference (TYPE REF TO) CL_GUI_CONTAINER Abstract Container for GUI Controls 20010920
5 CONTREP_TYPE Instance attribute Private Type reference (TYPE) P Type of Content Repository 20010920
6 DISPDOCS Instance attribute Private Type reference (TYPE) TAB_TOADI Structure for Displaying Documents 20010920
7 DISPLAYED_DOCUMENTS Instance attribute Private Type reference (TYPE) DISP_DOCUMENTS Displayed Documents 20010920
8 DOCICONCONTAINER Instance attribute Private Object reference (TYPE REF TO) CL_GUI_CONTAINER Abstract Container for GUI Controls 20010920
9 DOCUMENT_COUNT Instance attribute Private Type reference (TYPE) I Number of Displayed Documents 20010920
10 DOCUMENT_NR Instance attribute Public Type reference (TYPE) SAEINFO Current Document Number 20010920
11 ECLCONTROL_ACTIVE Instance attribute Private Type reference (TYPE) C 20010920
12 ECL_CONTROL Instance attribute Private Object reference (TYPE REF TO) CL_GUI_ECL_2DVIEWER Engineering Client 2D Viewer 20010920
13 GOSCONTAINER Instance attribute Private Object reference (TYPE REF TO) CL_GUI_CONTAINER Abstract Container for GUI Controls 20010920
14 GOS_ACTIVE Instance attribute Private Type reference (TYPE) C 20010920
15 GO_GOS_TOOLBOX Instance attribute Private Object reference (TYPE REF TO) CL_GOS_MANAGER Publication for Generic Object Services 20010920
16 G_ARCHIV_DOC_ID Instance attribute Public Type reference (TYPE) SAPB-SAPADOKID SAP ArchiveLink: Document ID 20010920
17 G_ARCHIV_ID Instance attribute Public Type reference (TYPE) TOAAR-ARCHIV_ID Content Repository Identification 20010920
18 G_DOCUMENT_CLASS Instance attribute Public Type reference (TYPE) TOAOM-SAP_OBJECT SAP ArchiveLink: Object type of business object 20010920
19 G_DP_URI Instance attribute Private Type reference (TYPE) C URL for a Document Component 20010920
20 G_GUID Instance attribute Private Type reference (TYPE) GUID_22 GUID in 'CHAR' format with upper-/lowercase (!) 20010920
21 G_LANGUAGE Instance attribute Public Type reference (TYPE) SY-LANGU SAP System, Current Language 20010920
22 G_OBJECT_ID Instance attribute Public Type reference (TYPE) TOAV0-OBJECT_ID SAP ArchiveLink: Object ID (Object Identifier) 20010920
23 G_OBJECT_TYPE Instance attribute Public Type reference (TYPE) TOAV0-SAP_OBJECT SAP ArchiveLink: Object type of business object 20010920
24 G_WINDOW_ID Instance attribute Public Type reference (TYPE) SAPB-SAPWINID Window_ID (of known display window) 20010920
25 G_WINDOW_TITLE Instance attribute Public Type reference (TYPE) SAPB-SAPWINTITL SAP ArchiveLink Window_Title (title of window) 20010920
26 HTMLCONTROL_ACTIVE Instance attribute Private Type reference (TYPE) C 20010920
27 HTML_CONTROL Instance attribute Private Object reference (TYPE REF TO) CL_GUI_HTML_VIEWER HTML Control Proxy Class 20010920
28 ICONCONTAINER Instance attribute Private Object reference (TYPE REF TO) CL_GUI_CONTAINER Abstract Container for GUI Controls 20010920
29 ICON_SPLITTER Instance attribute Private Object reference (TYPE REF TO) CL_GUI_SPLITTER_CONTAINER Splitter Control 20010920
30 NOTE_EXIST Instance attribute Private Type reference (TYPE) P 20010920
31 NOTE_FUNCTION Instance attribute Private Type reference (TYPE) P 20010920
32 PAGE_COMPONENTS Instance attribute Private Type reference (TYPE) AL_COMPONENTS Components of Stored Documents 20010920
33 TOBEMARKED Instance attribute Private Type reference (TYPE) P 20010920
34 WHOLECONTAINER Instance attribute Private Object reference (TYPE REF TO) CL_GUI_CONTAINER Abstract Container for GUI Controls 20010920
Methods
# Method Level Visibility Method type Description Created on
1 CHECK_AND_SET_GOS Instance method Private Method Check GOS and Activate if Necessary 20010920
2 CHECK_AND_SET_MARK Instance method Private Method Check whether document to be displayed is selected 20010920
3 CHECK_EXITS Instance method Private Method Check whether exits are activated 20010920
4 CHECK_IF_EAI_SHOULD_BE_CALLED Instance method Private Method Check whether ECL is called 20010920
5 CHECK_KIND_OF_BROWSER Instance method Private Method 20010920
6 CLOSE_GOS Instance method Private Method Close GOS Container 20010920
7 CONSTRUCTOR Instance method Public Constructor Constructor 20010920
8 CREATE_ECL Instance method Private Method 20010920
9 DISPLAY_VIA_HTML_CONTROL Instance method Private Method Display Using HTML Control 20010920
10 ELIMINATE_NOT_DISPLAYABLE Instance method Private Method 20010920
11 FIND_CONTREPTYPE Instance method Private Method 20010920
12 FIND_STANDARD_DISPLAY_COMMTYPE Instance method Private Method Determining Standard Display Communication Method 20010920
13 GET_AND_ANALYSE_COMPONENTS Instance method Private Method Determining and Analyzing Components 20010920
14 GET_DISPLAY_COMMUNICATION_TYPE Instance method Private Method Determining the Communication Type 20010920
15 GET_DOCUMENT_CLASS Instance method Private Method Determining the Document Class 20010920
16 INIT_VIEWING_CONTROL Instance method Private Method 20010920
17 INSERT_LAST_DOCUMENTS Instance method Private Method Note the Displayed Document 20010920
18 OPEN_DOCUMENT Instance method Public Method Opens a Document 20010920
19 RESET_GLOBAL_VARIABLES Instance method Private Method Setting Global Variables 20010920
20 SET_GOS Instance method Private Method Setting GOS Control 20010920
21 SET_PARAMETERS Instance method Private Method Setting Set/Get Parameters 20010920
22 SINGLE_OR_MULTIPLE_DOCUMENT Instance method Private Method Display One or More Documents? 20010920
Events
Class CL_GUI_DOCUMENTS has no event.
Types
Class CL_GUI_DOCUMENTS has no local type.
Method Signatures

Method CHECK_AND_SET_GOS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing OBJECT_ID Value transfer Type reference (TYPE) TOAV0-OBJECT_ID SAP ArchiveLink: Objekt-Id (Objektidentifikator) 20010920
2 Importing OBJECT_TYPE Value transfer Type reference (TYPE) TOAV0-SAP_OBJECT SAP ArchiveLink: Objekttyp des Business Objekts 20010920

Method CHECK_AND_SET_GOS on class CL_GUI_DOCUMENTS has no exception.

Method CHECK_AND_SET_MARK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONTREP_ID Value transfer Type reference (TYPE) TOAAR-ARCHIV_ID Content Repository Identifikation 20010920
2 Importing DOCUMENT_ID Value transfer Type reference (TYPE) SAPB-SAPADOKID SAP ArchiveLink: Dokument-Id 20010920
3 Importing DOCUMENT_TYPE Value transfer Type reference (TYPE) TOAV0-AR_OBJECT Dokumentart 20010920
4 Importing OBJECT_ID Value transfer Type reference (TYPE) TOAV0-OBJECT_ID SAP ArchiveLink: Objekt-Id (Objektidentifikator) 20010920
5 Importing OBJECT_TYPE Value transfer Type reference (TYPE) TOAV0-SAP_OBJECT SAP ArchiveLink: Objekttyp des Business Objekts 20010920
6 Exporting TO_BE_MARKED Call by reference Type reference (TYPE) P 20010920

Method CHECK_AND_SET_MARK on class CL_GUI_DOCUMENTS has no exception.

Method CHECK_EXITS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting COMMUNICATION_TYPE Call by reference Type reference (TYPE) P 20010920
2 Importing DOCUMENT_CLASS Value transfer Type reference (TYPE) TOAOM-DOC_TYPE SAP ArchiveLink: Dokumenttyp 20010920

Method CHECK_EXITS on class CL_GUI_DOCUMENTS has no exception.

Method CHECK_IF_EAI_SHOULD_BE_CALLED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing DOCUMENT_CLASS Value transfer Type reference (TYPE) SAEDOCETYP SAP ArchiveLink: technischer Dokumenttyp 20010920
2 Exporting EAI_STATUS Call by reference Type reference (TYPE) P 20010920

Method CHECK_IF_EAI_SHOULD_BE_CALLED on class CL_GUI_DOCUMENTS has no exception.

Method CHECK_KIND_OF_BROWSER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting BROWSER_STATUS Call by reference Type reference (TYPE) P 20010920
2 Importing DOCUMENT_CLASS Value transfer Type reference (TYPE) SAEDOCETYP SAP ArchiveLink: technischer Dokumenttyp 20010920

Method CHECK_KIND_OF_BROWSER on class CL_GUI_DOCUMENTS has no exception.

Method CLOSE_GOS Signature

Method CLOSE_GOS on class CL_GUI_DOCUMENTS has no parameter.
Method CLOSE_GOS on class CL_GUI_DOCUMENTS has no exception.

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing LIFETIME Call by reference Type reference (TYPE) I Lifetime 20010920
2 Importing PARENT Call by reference Object reference (TYPE REF TO) CL_GUI_CONTAINER Parent container of control 20010920
3 Importing SHELLSTYPE Value transfer Type reference (TYPE) I Shellstyle 20010920
# Exception Resumable Description Created on
1 CNTL_ERROR Control Error 20010920
2 CNTL_SYSTEM_ERROR Control system error 20010920
3 CREATE_ERROR Create error 20010920
4 LIFETIME_ERROR Lifetime error 20010920

Method CREATE_ECL Signature

Method CREATE_ECL on class CL_GUI_DOCUMENTS has no parameter.
Method CREATE_ECL on class CL_GUI_DOCUMENTS has no exception.

Method DISPLAY_VIA_HTML_CONTROL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONTREP_ID Value transfer Type reference (TYPE) TOAAR-ARCHIV_ID Content Repository Identifikation 20010920
2 Importing DOCUMENT_CLASS Value transfer Type reference (TYPE) TOAOM-DOC_TYPE SAP ArchiveLink: Dokumenttyp 20010920
3 Importing DOCUMENT_ID Value transfer Type reference (TYPE) SAPB-SAPADOKID SAP ArchiveLink: Dokument-Id 20010920
4 Importing DOCUMENT_TYPE Value transfer Type reference (TYPE) TOAV0-AR_OBJECT Dokumentart 20010920
5 Importing LANGUAGE Value transfer Type reference (TYPE) SY-LANGU R/3-System, aktuelle Sprache 20010920
6 Importing OBJECT_ID Value transfer Type reference (TYPE) TOAV0-OBJECT_ID SAP ArchiveLink: Objekt-Id (Objektidentifikator) 20010920
7 Importing OBJECT_TYPE Value transfer Type reference (TYPE) TOAV0-SAP_OBJECT SAP ArchiveLink: Objekttyp des Business Objekts 20010920

Method DISPLAY_VIA_HTML_CONTROL on class CL_GUI_DOCUMENTS has no exception.

Method ELIMINATE_NOT_DISPLAYABLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing DISPDOCS Call by reference Type reference (TYPE) TAB_TOADI Struktur für die Anzeige von Dokumenten 20010920

Method ELIMINATE_NOT_DISPLAYABLE on class CL_GUI_DOCUMENTS has no exception.

Method FIND_CONTREPTYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONTREP_ID Value transfer Type reference (TYPE) SAEARCHIVI Content Repository Identifikation 20010920
2 Exporting CONTREP_TYPE Call by reference Type reference (TYPE) P Art des Content Repository 20010920

Method FIND_CONTREPTYPE on class CL_GUI_DOCUMENTS has no exception.

Method FIND_STANDARD_DISPLAY_COMMTYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing COMMUNICATION_TYPE Call by reference Type reference (TYPE) P 20010920
2 Importing CONTREP_ID Value transfer Type reference (TYPE) SAEARCHIVI Content Repository Identifikation 20010920
3 Importing DOCUMENT_CLASS Call by reference Type reference (TYPE) SAEDOCETYP SAP ArchiveLink: technischer Dokumenttyp 20010920

Method FIND_STANDARD_DISPLAY_COMMTYPE on class CL_GUI_DOCUMENTS has no exception.

Method GET_AND_ANALYSE_COMPONENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ANNO_COMPONENTS Call by reference Type reference (TYPE) AL_COMPONENTS Annotationenkomponenten 20010920
2 Importing CONTREP_ID Value transfer Type reference (TYPE) TOAAR-ARCHIV_ID Content Repository Identifikation 20010920
3 Importing DOCUMENT_ID Value transfer Type reference (TYPE) SAPB-SAPADOKID SAP ArchiveLink: Dokument-Id 20010920
4 Exporting NOTE_EXIST Call by reference Type reference (TYPE) P Existiert eine Notiz 20010920
5 Exporting NOTE_FUNCTION Call by reference Type reference (TYPE) P Ist die Notizbearbeitung aktiv 20010920
6 Exporting PAGE_COMPONENTS Call by reference Type reference (TYPE) AL_COMPONENTS Anzeigbare Komponenten 20010920

Method GET_AND_ANALYSE_COMPONENTS on class CL_GUI_DOCUMENTS has no exception.

Method GET_DISPLAY_COMMUNICATION_TYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting COMMUNICATION_TYPE Call by reference Type reference (TYPE) P 20010920
2 Importing CONTREP_ID Value transfer Type reference (TYPE) SAEARCHIVI Content Repository Identifikation 20010920
3 Importing DOCUMENT_CLASS Value transfer Type reference (TYPE) SAEDOCETYP SAP ArchiveLink: technischer Dokumenttyp 20010920

Method GET_DISPLAY_COMMUNICATION_TYPE on class CL_GUI_DOCUMENTS has no exception.

Method GET_DOCUMENT_CLASS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONTREP_ID Value transfer Type reference (TYPE) SAEARCHIVI Content Repository Identifikation 20010920
2 Changing DOCUMENT_CLASS Value transfer Type reference (TYPE) SAEDOCETYP SAP ArchiveLink: technischer Dokumenttyp 20010920
3 Importing DOCUMENT_ID Value transfer Type reference (TYPE) SAEARDOID SAP ArchiveLink: Dokument-Id 20010920
4 Importing DOCUMENT_TYPE Value transfer Type reference (TYPE) SAEOBJART Dokumentart 20010920
5 Importing OBJECT_TYPE Value transfer Type reference (TYPE) SAEANWDID SAP ArchiveLink: Objekttyp des Business Objekts 20010920

Method GET_DOCUMENT_CLASS on class CL_GUI_DOCUMENTS has no exception.

Method INIT_VIEWING_CONTROL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing COMMUNICATION_TYPE Value transfer Type reference (TYPE) P 20010920

Method INIT_VIEWING_CONTROL on class CL_GUI_DOCUMENTS has no exception.

Method INSERT_LAST_DOCUMENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing COMMUNICATION_TYPE Value transfer Type reference (TYPE) P Kommunikationstyp 20010920
2 Importing CONTREP_ID Value transfer Type reference (TYPE) TOADI-AID Content Repository Identifikation 20010920
3 Importing DOCUMENT_CLASS Value transfer Type reference (TYPE) TOADI-DCL SAP ArchiveLink: technischer Dokumenttyp 20010920
4 Importing DOCUMENT_ID Value transfer Type reference (TYPE) TOADI-ADID SAP ArchiveLink: Dokument-Id 20010920
5 Importing DOCUMENT_TYPE Value transfer Type reference (TYPE) TOADI-DTI Dokumentart 20010920
6 Importing OBJECT_ID Value transfer Type reference (TYPE) TOADI-OID SAP ArchiveLink: Objekt-Id (Objektidentifikator) 20010920
7 Importing OBJECT_TYPE Value transfer Type reference (TYPE) TOADI-OTI SAP ArchiveLink: Objekttyp des Business Objekts 20010920
8 Importing URI Value transfer Type reference (TYPE) C URL 20010920
9 Importing WINDOW_ID Value transfer Type reference (TYPE) TOADI-WID Window_Id (des bereits bekannten Anzeigefensters) 20010920
10 Importing WINDOW_TITLE Value transfer Type reference (TYPE) TOADI-WTI SAP ArchiveLink Window_Title (Titel des Fensters) 20010920

Method INSERT_LAST_DOCUMENTS on class CL_GUI_DOCUMENTS has no exception.

Method OPEN_DOCUMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONTREP_ID Value transfer Type reference (TYPE) SAEARCHIVI Content Repository 20010920
2 Importing DOCUMENT_CLASS Value transfer Type reference (TYPE) SAEDOKTYP Dokumententyp 20010920
3 Importing DOCUMENT_ID Value transfer Type reference (TYPE) SAEARDOID Dokumentid 20010920
4 Importing DOCUMENT_TYPE Value transfer Type reference (TYPE) SAEOBJART Dokumentart 20010920
5 Importing GUID Value transfer Type reference (TYPE) GUID_22 GUID zur Dokumentfindung 20010920
6 Importing GUIDTOUSE Value transfer Type reference (TYPE) CHAR1 SPACE Soll die Guid verwendet werden das Dokument 20010920
7 Importing OBJECT_ID Value transfer Type reference (TYPE) SAEOBJID Objekt-Id der Businessobjektinstanz 20010920
8 Importing OBJECT_TYPE Value transfer Type reference (TYPE) SAEANWDID Objekttyp des Business Objekts 20010920
# Exception Resumable Description Created on
1 IMPLACE_NOT_SUPPORTED Implace Anzeige nicht unterstützt / deaktiviert 20010920

Method RESET_GLOBAL_VARIABLES Signature

Method RESET_GLOBAL_VARIABLES on class CL_GUI_DOCUMENTS has no parameter.
Method RESET_GLOBAL_VARIABLES on class CL_GUI_DOCUMENTS has no exception.

Method SET_GOS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing GOS_OBJECT Call by reference Type reference (TYPE) BORIDENT Object Relationship Service : BOR Objektidentifier 20010920

Method SET_GOS on class CL_GUI_DOCUMENTS has no exception.

Method SET_PARAMETERS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing DOCUMENT_TYPE Value transfer Type reference (TYPE) SAEOBJART Dokumentart 20010920
2 Importing OBJECT_ID Value transfer Type reference (TYPE) SAEOBJID SAP ArchiveLink: Objekt-Id (Objektidentifikator) 20010920
3 Importing OBJECT_TYPE Value transfer Type reference (TYPE) SAEANWDID SAP ArchiveLink: Objekttyp des Business Objekts 20010920

Method SET_PARAMETERS on class CL_GUI_DOCUMENTS has no exception.

Method SINGLE_OR_MULTIPLE_DOCUMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CONTREP_ID Value transfer Type reference (TYPE) SAEARCHIVI Content Repository Identifikation 20010920
2 Changing DOCUMENT_CLASS Value transfer Type reference (TYPE) SAEDOKTYP SAP ArchiveLink: Dokumenttyp 20010920
3 Changing DOCUMENT_ID Value transfer Type reference (TYPE) SAEARDOID SAP ArchiveLink: Dokument-Id 20010920
4 Changing DOCUMENT_TYPE Value transfer Type reference (TYPE) SAEOBJART Dokumentart 20010920
5 Importing GUID Value transfer Type reference (TYPE) GUID_22 GUID im 'CHAR' Format mit Groß-/Kleinschreibung (!) 20010920
6 Importing GUIDTOUSE Value transfer Type reference (TYPE) CHAR1 Werden die Dokumente über GUID übergeben 20010920
7 Changing OBJECT_ID Value transfer Type reference (TYPE) SAEOBJID SAP ArchiveLink: Objekt-Id (Objektidentifikator) 20010920
8 Changing OBJECT_TYPE Value transfer Type reference (TYPE) SAEANWDID SAP ArchiveLink: Objekttyp des Business Objekts 20010920

Method SINGLE_OR_MULTIPLE_DOCUMENT on class CL_GUI_DOCUMENTS has no exception.
History
Last changed by/on SAP  00000000 
SAP Release Created in 620