SAP ABAP Class CL_DOCF_BDS_QUERY (SAP ArchiveLink: KPro Query Class)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷ BC-SRV-RM (Application Component) SAP Records Management
⤷ SRM_SP_BDS (Package) Service Provider for Business Document Service
⤷ BC-SRV-RM (Application Component) SAP Records Management
⤷ SRM_SP_BDS (Package) Service Provider for Business Document Service
Meta Relationship - Using
# | Relationship type | Using | Short Description | Created on |
---|---|---|---|---|
1 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_ALINK_HITLIST_CALLBACK | ArchiveLink: Query Info Interface | 20021002 |
2 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_ALINK_QUERY | ArchiveLink: Query Interface | 20021002 |
3 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_ALINK_QUERY_RECORDS | Methods for Records Management | 20050531 |
Properties
Class | CL_DOCF_BDS_QUERY | |
Short Description | SAP ArchiveLink: KPro Query Class | |
Super Class | ||
Instantiability of a Class | 2 | Public |
Final |
General Data
Message Class | SRM_GENERAL | |
Program status | ||
Category | 0 | |
Package | SRM_SP_BDS | Service Provider for Business Document Service |
Created | 20021002 | SAP |
Last change | 20050705 | SAP |
Shared Memory-enabled | ||
Fixed point arithmetic | ||
Unicode checks active |
Forward declarations
# | Type group / Object type | Type | Type Description |
---|---|---|---|
1 | AKCL | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
2 | IF_SRM | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
3 | IF_SRM_ACTIVITY_LIST | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
4 | SGENE | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
5 | SRMGS | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
# | Interface | Abstract | Final | Description | Created on |
---|---|---|---|---|---|
1 | IF_ALINK_HITLIST_CALLBACK | ArchiveLink: Query Info Interface | 20021002 | ||
2 | IF_ALINK_QUERY | ArchiveLink: Query Interface | 20021002 | ||
3 | IF_ALINK_QUERY_RECORDS | Methods for Records Management | 20050531 |
Friends
Class CL_DOCF_BDS_QUERY has no friend class.
Attributes
# | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | ATTRIB_DISPLAY_OBJECT | Instance attribute | Protected | Object reference (TYPE REF TO) | CL_ALINK_ATTRIBUTE_VIEWER | Class for Representing Attributes | 20021002 | ||
2 | CALLBACK_FUNCTION | Instance attribute | Protected | Type reference (TYPE) | RS38L_FNAM | Callback FM for Query Template | 20021002 | ||
3 | DISPLAY_OBJECT | Instance attribute | Protected | Object reference (TYPE REF TO) | IF_ALINK_HITLIST | ArchiveLink: Display Interface | 20021002 | ||
4 | DOCUSPACE | Instance attribute | Protected | Type reference (TYPE) | TOADOCSP_S | ArchiveLink: Document Areas (Structure) | 20021002 | ||
5 | FOUND_INFOOBJECTS | Instance attribute | Private | Type reference (TYPE) | SGENE_IT_SDOKRESDOC | Found KPRO Documents | 20021002 | ||
6 | GOS_MANAGER | Instance attribute | Protected | Object reference (TYPE REF TO) | CL_GOS_MANAGER | Publication for Generic Object Services | 20021002 | ||
7 | KPRO_DOCUMENT_L_ATTRIBUTES | Instance attribute | Protected | Type reference (TYPE) | SGENE_IT_SDOKATTRIB | KPro Loio Document Area Attributes | 20021002 | ||
8 | KPRO_DOCUMENT_P_ATTRIBUTES | Instance attribute | Protected | Type reference (TYPE) | SGENE_IT_SDOKATTRIB | KPro Phio Document Area Attributes | 20021002 | ||
9 | KPRO_HITLIST | Instance attribute | Protected | Type reference (TYPE) | AKCL_KPROREP_TAB | Phio Hit List | 20021002 | ||
10 | KPRO_L_ATTRIBUTES | Instance attribute | Protected | Type reference (TYPE) | AKCL_KPROPROP_TAB | Loio Attributes for Hit List | 20021002 | ||
11 | KPRO_P_ATTRIBUTES | Instance attribute | Protected | Type reference (TYPE) | AKCL_KPROPROP_TAB | Phio Attributes for Hit List | 20021002 | ||
12 | LOIO_CLASS | Instance attribute | Private | Type reference (TYPE) | SDOK_CLASS | Document Class | 20021002 | ||
13 | MAX_HITS | Instance attribute | Private | Type reference (TYPE) | SAEMAXHITS | Maximum Number of Hits | 20021002 | ||
14 | PHIO_CLASS | Instance attribute | Private | Type reference (TYPE) | SDOK_CLASS | Document Class | 20021002 | ||
15 | PROPERTY_RMS_ID | Constant | Public | Type reference (TYPE) | CHAR25 | 'SRM_RMS_ID' | RMS ID | 20021002 | |
16 | PROPERTY_SPS_ID | Constant | Public | Type reference (TYPE) | CHAR25 | 'SRM_SPS_ID' | SPS ID | 20021002 | |
17 | RMS_ID | Instance attribute | Private | Type reference (TYPE) | SRMRMSID | RMS ID | 20021002 | ||
18 | SPS_ID | Instance attribute | Private | Type reference (TYPE) | SRMSPSID | SPS ID | 20021002 | ||
19 | TRUE | Constant | Protected | Type reference (TYPE) | I | 0 | Set Value for TRUE | 20021002 | |
20 | X_CHANGED | Instance attribute | Protected | Type reference (TYPE) | C | SPACE | ON_CHANGE Has Changed the Attribute | 20021002 |
Methods
# | Method | Level | Visibility | Method type | Description | Created on |
---|---|---|---|---|---|---|
1 | CHANGE_DESCRIPTION | Instance method | Protected | Method | Change Description of Item | 20021002 |
2 | CONSTRUCTOR | Instance method | Public | Constructor | Constructor | 20021002 |
3 | CREATE_DISPLAY_OBJECT | Instance method | Protected | Method | Select the Appropriate Display Class. | 20021002 |
4 | DISPLAY_ATTRIBUTES | Instance method | Protected | Method | Display Attributes of a Hit | 20021002 |
5 | DISPLAY_BUSINESS_OBJECT | Instance method | Protected | Method | Protected: Display Business Object | 20021002 |
6 | DISPLAY_KPRO_DOCUMENTS | Instance method | Private | Method | Protected: Displaying Documents Using Kpro Data Record | 20021002 |
7 | EDIT_KPRO_DOCUMENTS | Instance method | Private | Method | Protected: Displaying Documents Using Kpro Data Record | 20021002 |
8 | EXPORT_IMS_TO_RM | Instance method | Private | Method | Private: Export IMS Document to File | 20021002 |
9 | EXPORT_KPR_TO_RM | Instance method | Private | Method | Private: Export Kpro Document to File | 20021002 |
10 | PERFORM_IMS_SEARCH | Instance method | Private | Method | Protected: Search Query in IMS | 20021002 |
11 | PERFORM_KPRO_SEARCH | Instance method | Private | Method | Protected: Search Query in KPRO Database Tables | 20021002 |
12 | SET_DOCFINDER_HITLIST | Instance method | Private | Method | Set the Hit List for Display in the DocFinder | 20021002 |
13 | SET_DOCUMENT_ATTRIBUTES | Instance method | Protected | Method | Protected: Set Document Attributes | 20021002 |
14 | SET_HITLIST_FOR_FIRST_DISPLAY | Instance method | Protected | Method | Protected: Sets Kpro Hitlist to Standard Interface | 20021002 |
15 | SET_IMS_DOCUMENT_ATTRIBUTES | Instance method | Private | Method | Private: Sets Document Attributes in IMS Case | 20021002 |
16 | SET_KPRO_DOCUMENT_ATTRIBUTES | Instance method | Private | Method | Private: Sets Document Attributes in KPro Case | 20021002 |
17 | SET_LOIO_ATTRIBUTES | Instance method | Private | Method | Set LOIO Attributes | 20021002 |
Events
Class CL_DOCF_BDS_QUERY has no event.
Types
Class CL_DOCF_BDS_QUERY has no local type.
Method Signatures
Method CHANGE_DESCRIPTION Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | IM_HIT | Call by reference | Type reference (TYPE) | TOARSDOC_S | Treffer | 20021002 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | KPRO_ERROR | KPro Error | 20021002 |
Method CONSTRUCTOR Signature
Method CONSTRUCTOR on class CL_DOCF_BDS_QUERY has no parameter.
Method CONSTRUCTOR on class CL_DOCF_BDS_QUERY has no exception.
Method CREATE_DISPLAY_OBJECT Signature
Method CREATE_DISPLAY_OBJECT on class CL_DOCF_BDS_QUERY has no parameter.
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CREATION_FAILED | Ergeugung misslungen | 20021002 |
Method DISPLAY_ATTRIBUTES Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | IM_HIT | Call by reference | Type reference (TYPE) | TOARSDOC_S | Treffer | 20021002 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CONTROL_ERROR | Control Error | 20021002 | |
2 | NO_ATTRIBUTES | Keine Attribute vorhanden | 20021002 |
Method DISPLAY_BUSINESS_OBJECT Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | IM_HIT | Call by reference | Type reference (TYPE) | TOARSDOC_S | Treffer | 20021002 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | DISPLAY_ERROR | Anzeigefehler | 20021002 |
Method DISPLAY_KPRO_DOCUMENTS Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | IM_SELECTED_HITLIST | Call by reference | Type reference (TYPE) | TOARSDOC_T | Markierte Treffer | 20021002 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | DISPLAY_ERROR | Fehler bei der Anzeige | 20021002 |
Method EDIT_KPRO_DOCUMENTS Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | IM_SELECTED_HITLIST | Call by reference | Type reference (TYPE) | TOARSDOC_T | Markierte Treffer | 20021002 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | DISPLAY_ERROR | Fehler bei der Anzeige | 20021002 |
Method EXPORT_IMS_TO_RM Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Exporting | EX_RM_OBJECTS | Call by reference | Type reference (TYPE) | TOARMOBJ_T | Tabelle von TOAPROP_S | 20021002 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | NO_SELECTION | Keine Selektion erfolgt | 20021002 | |
2 | TOO_MANY_SELECTIONS | Zu viele Selektionen | 20021002 |
Method EXPORT_KPR_TO_RM Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Exporting | EX_RM_OBJECTS | Call by reference | Type reference (TYPE) | TOARMOBJ_T | Tabelle von TOAPROP_S | 20021002 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | NO_SELECTION | Keine Selektion | 20021002 | |
2 | TOO_MANY_SELECTIONS | Zu viele Selektionen | 20021002 |
Method PERFORM_IMS_SEARCH Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | IM_QUERY | Call by reference | Object reference (TYPE REF TO) | CL_ALINK_KPRO_QUERY_CONVERSION | Query Objekt | 20021002 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | BAD_QUERY | Suchanfrage misslungen | 20021002 |
Method PERFORM_KPRO_SEARCH Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | IM_QUERY | Call by reference | Object reference (TYPE REF TO) | CL_ALINK_KPRO_QUERY_CONVERSION | Query Klasse | 20021002 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | BAD_QUERY | Fehlgeschlagene Anfrage | 20021002 | |
2 | NO_HITS | Keine Treffer | 20021002 | |
3 | NO_QUERY | Keine Query EIngabe | 20021002 |
Method SET_DOCFINDER_HITLIST Signature
Method SET_DOCFINDER_HITLIST on class CL_DOCF_BDS_QUERY has no parameter.
Method SET_DOCFINDER_HITLIST on class CL_DOCF_BDS_QUERY has no exception.
Method SET_DOCUMENT_ATTRIBUTES Signature
Method SET_DOCUMENT_ATTRIBUTES on class CL_DOCF_BDS_QUERY has no parameter.
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | INITIALIZATION_ERROR | 20021002 |
Method SET_HITLIST_FOR_FIRST_DISPLAY Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | IM_NUMBER_OF_HITS | Call by reference | Type reference (TYPE) | NUM12 | Numerisches Feld 12 | 20021002 |
Method SET_HITLIST_FOR_FIRST_DISPLAY on class CL_DOCF_BDS_QUERY has no exception.
Method SET_IMS_DOCUMENT_ATTRIBUTES Signature
Method SET_IMS_DOCUMENT_ATTRIBUTES on class CL_DOCF_BDS_QUERY has no parameter.
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | INITIALIZATION_ERROR | 20021002 |
Method SET_KPRO_DOCUMENT_ATTRIBUTES Signature
Method SET_KPRO_DOCUMENT_ATTRIBUTES on class CL_DOCF_BDS_QUERY has no parameter.
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | INITIALIZATION_ERROR | 20021002 |
Method SET_LOIO_ATTRIBUTES Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | IM_LOIOS | Value transfer | Type reference (TYPE) | SGENE_IT_SDOKOBJECT | Liste der LOIOs | 20021002 |
Method SET_LOIO_ATTRIBUTES on class CL_DOCF_BDS_QUERY has no exception.
History
Last changed by/on | SAP | 20050705 |
SAP Release Created in | 640 |