SAP ABAP Class CL_SRM_GENERIC_SP_USER_QUERY (Access to Stored Queries)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SRV-RM (Application Component) SAP Records Management
⤷
SRM_GENSP_QUERY (Package) Query Dialog
⤷
⤷
Properties
| Class | CL_SRM_GENERIC_SP_USER_QUERY | |
| Short Description | Access to Stored Queries | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SRM_GENSP_QUERY | Query Dialog |
| Created | 20020301 | SAP |
| Last change | 20020301 | 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) | |
| 2 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_SRM_GENERIC_SP_USER_QUERY has no interface implemented.
Friends
Class CL_SRM_GENERIC_SP_USER_QUERY has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Protected | Type reference (TYPE) | STRING | 'Searches' | US Space Name for Queries | 20020314 | ||
| 2 | Instance attribute | Protected | Object reference (TYPE REF TO) | CL_SRM_US_SETTING_SPACE | US Space for Queries | 20020314 | |||
| 3 | Instance attribute | Protected | Type reference (TYPE) | STRING | RMS ID | 20020304 | |||
| 4 | Constant | Protected | Type reference (TYPE) | STRING | 'SearchDialog' | Name of Root Space | 20020304 | ||
| 5 | Instance attribute | Protected | Object reference (TYPE REF TO) | CL_SRM_US_SETTING_SPACE | Root User Setting Space of the SPS Search Dialog | 20020304 | |||
| 6 | Instance attribute | Protected | Type reference (TYPE) | STRING | SPS ID | 20020304 | |||
| 7 | Instance attribute | Protected | Object reference (TYPE REF TO) | CL_SRM_US_SETTING_SPACE | US Space of SPS in an RMS, as Sub Space of Root | 20020304 | |||
| 8 | Constant | Protected | Type reference (TYPE) | STRING | 'ActualOnly' | Name of US 'Current Results Only' | 20020304 | ||
| 9 | Constant | Protected | Type reference (TYPE) | STRING | 'Attribute' | Prefix of US 'Attribute' | 20020304 | ||
| 10 | Constant | Protected | Type reference (TYPE) | STRING | 'AttribCount' | Name of US Number of Query Attributes | 20020314 | ||
| 11 | Constant | Protected | Type reference (TYPE) | STRING | 'Value1' | Prefix of US Low Value for an Attribute | 20020304 | ||
| 12 | Constant | Protected | Type reference (TYPE) | STRING | 'Value2' | Prefix of US High Value for an Attribute | 20020304 | ||
| 13 | Constant | Protected | Type reference (TYPE) | STRING | 'Fulltext' | Name of US 'Fulltext Search' | 20020304 | ||
| 14 | Constant | Protected | Type reference (TYPE) | STRING | 'MaxHits' | Name of US 'Max. Number of Results' | 20020304 | ||
| 15 | Constant | Protected | Type reference (TYPE) | STRING | 'Option' | Prefix of US Option for an Attribute | 20020304 | ||
| 16 | Constant | Protected | Type reference (TYPE) | STRING | 'Sign' | Prefix of US Sign | 20030807 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Constructor | Constructor | 20020304 | |
| 2 | Instance method | Public | Method | Delete Search Parameters Stored Under Specified Name | 20020301 | |
| 3 | Instance method | Public | Method | Check Whether Query Exists | 20020301 | |
| 4 | Instance method | Public | Method | Get a Stored Query | 20020304 | |
| 5 | Instance method | Public | Method | Get the List of the Names of All Stored Queries | 20020301 | |
| 6 | Instance method | Public | Method | Save Query Parameters Under Specified Name | 20020301 | |
| 7 | Instance method | Public | Method | Get setting to define if cross-user settings are active | 20050705 | |
| 8 | Instance method | Public | Method | Set setting to define if cross-user settings are active | 20050705 |
Events
Class CL_SRM_GENERIC_SP_USER_QUERY has no event.
Types
Class CL_SRM_GENERIC_SP_USER_QUERY has no local type.
Method Signatures
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_RMS_ID | Value transfer | Type reference (TYPE) | STRING | RMS id | 20020304 | |||
| 2 | IM_SPS_ID | Value transfer | Type reference (TYPE) | STRING | SPS id | 20020304 |
Method CONSTRUCTOR on class CL_SRM_GENERIC_SP_USER_QUERY has no exception.
Method DELETE_QUERY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_NAME | Call by reference | Type reference (TYPE) | STRING | Name der gespeicherten Suchabfrage | 20020301 |
Method DELETE_QUERY on class CL_SRM_GENERIC_SP_USER_QUERY has no exception.
Method EXISTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EX_EXISTS | Value transfer | Type reference (TYPE) | SRMBOOLEAN | True, if Suchabfrage des geg. Namens existiert | 20020304 | |||
| 2 | IM_NAME | Call by reference | Type reference (TYPE) | STRING | Name der gespeicherten Suchabfrage | 20020301 |
Method EXISTS on class CL_SRM_GENERIC_SP_USER_QUERY has no exception.
Method GET_QUERY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EX_ATTRIBUTE_TAB | Call by reference | Type reference (TYPE) | SRMGU_QUERY_ATTRIB_TAB | Tabelle der Suchattribute | 20020304 | |||
| 2 | EX_QUERY_PARAM | Call by reference | Type reference (TYPE) | SRMGU_SPS_QUERY_PARAM | Abfrageparameter | 20020304 | |||
| 3 | IM_NAME | Call by reference | Type reference (TYPE) | STRING | Name der gespeicherten Suchabfrage | 20020304 |
Method GET_QUERY on class CL_SRM_GENERIC_SP_USER_QUERY has no exception.
Method GET_QUERY_LIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EX_QUERY_LIST | Value transfer | Type reference (TYPE) | SRMGU_QUERY_LIST_TAB | Liste der Namen von gespeicherten Suchabfragen | 20020301 |
Method GET_QUERY_LIST on class CL_SRM_GENERIC_SP_USER_QUERY has no exception.
Method SAVE_QUERY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_ATTRIBUTE_TAB | Value transfer | Type reference (TYPE) | SRMGU_QUERY_ATTRIB_TAB | Tabelle der Suchattribute | 20020301 | |||
| 2 | IM_QUERY_PARAM | Call by reference | Type reference (TYPE) | SRMGU_SPS_QUERY_PARAM | Abfrageparameter | 20020304 | |||
| 3 | RE_SUCCESS | Value transfer | Type reference (TYPE) | SRMBOOLEAN | True: Suchparameter erfolgreich gesichert | 20020304 |
Method SAVE_QUERY on class CL_SRM_GENERIC_SP_USER_QUERY has no exception.
Method USE_GLOBAL_SETTINGS_GET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RE_USE_GLOBAL_SETTINGS | Value transfer | Type reference (TYPE) | SRMBOOLEAN | Einstellung, ob benutzerübergreifende Settings aktiv sind | 20050705 |
Method USE_GLOBAL_SETTINGS_GET on class CL_SRM_GENERIC_SP_USER_QUERY has no exception.
Method USE_GLOBAL_SETTINGS_SET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_USE_GLOBAL_SETTINGS | Call by reference | Type reference (TYPE) | SRMBOOLEAN | Einstellung, ob benutzerübergreifende Settings aktiv sind | 20050705 |
Method USE_GLOBAL_SETTINGS_SET on class CL_SRM_GENERIC_SP_USER_QUERY has no exception.
History
| Last changed by/on | SAP | 20020301 |
| SAP Release Created in | 630 |