SAP ABAP Class /RPM/CL_FAVOURITES_API (Favorites Provider class)
Hierarchy
☛
CPRXRPM (Software Component) SAP Portfolio and Project Management 6.0
⤷
PPM-PFM (Application Component) Portfolio Management
⤷
/RPM/API (Package) xRPM External Interfaces
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | /RPM/IF_PROVIDER_ACCESS | ESA: "CRUD"-Interface Pattern | 20070502 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | /RPM/IF_PROVIDER_QUERY | ESA: "Query"-Interface-Pattern | 20070502 |
Properties
| Class | /RPM/CL_FAVOURITES_API | |
| Short Description | Favorites Provider class | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | /RPM/API | xRPM External Interfaces |
| Created | 20070423 | SAP |
| Last change | 20141109 | |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class /RPM/CL_FAVOURITES_API has no forward declaration.
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | /RPM/IF_PROVIDER_ACCESS | ESA: "CRUD"-Interface Pattern | 20070502 | ||
| 2 | /RPM/IF_PROVIDER_QUERY | ESA: "Query"-Interface-Pattern | 20070502 |
Friends
Class /RPM/CL_FAVOURITES_API has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Public | Type reference (TYPE) | STRING | 'CHANGE_MODE' | 20070503 | |||
| 2 | Constant | Public | Type reference (TYPE) | STRING | 'CONTEXT' | 20070510 | |||
| 3 | Constant | Public | Type reference (TYPE) | STRING | 'FAVO_DESC' | 20070502 | |||
| 4 | Constant | Public | Type reference (TYPE) | STRING | 'FAVO_DETAIL' | 20070502 | |||
| 5 | Constant | Public | Type reference (TYPE) | STRING | 'FAVO_ITEMS' | 20070502 | |||
| 6 | Constant | Public | Type reference (TYPE) | STRING | 'FAVO_LISTS' | 20070502 | |||
| 7 | Constant | Public | Type reference (TYPE) | STRING | 'FAVO_GUID' | 20070503 | |||
| 8 | Constant | Public | Type reference (TYPE) | STRING | 'LANGUAGE' | 20070503 | |||
| 9 | Constant | Public | Type reference (TYPE) | STRING | 'OBJECT_TYPE' | 20070503 | |||
| 10 | Constant | Public | Type reference (TYPE) | STRING | 'SEL_VAR_DATA' | 20100524 | |||
| 11 | Constant | Public | Type reference (TYPE) | STRING | 'SEL_VAR_DESC' | 20100525 | |||
| 12 | Constant | Public | Type reference (TYPE) | STRING | 'SEL_VAR_DETAIL' | 20100524 | |||
| 13 | Constant | Public | Type reference (TYPE) | STRING | 'SEL_VAR_GUID' | 20100526 | |||
| 14 | Constant | Public | Type reference (TYPE) | STRING | 'SEL_VAR_LIST' | 20100525 | |||
| 15 | Constant | Public | Type reference (TYPE) | STRING | 'USER' | 20070503 | |||
| 16 | Constant | Public | Type reference (TYPE) | STRING | 'FAVO_QUERY' | 20070502 | |||
| 17 | Static Attribute | Private | Object reference (TYPE REF TO) | /RPM/CL_FAVOURITES_API | Favorites Provider class | 20081230 | |||
| 18 | Instance attribute | Public | Type reference (TYPE) | /RPM/TT_MESSAGES | Table Type for Messages | 20070503 | |||
| 19 | Instance attribute | Public | Type reference (TYPE) | I | 20070503 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Constructor | CLASS_CONSTRUCTOR | 20100602 | |
| 2 | Instance method | Private | Method | 20100602 | ||
| 3 | Static method | Public | Method | 20081230 | ||
| 4 | Instance method | Private | Method | 20070502 | ||
| 5 | Instance method | Private | Method | 20070502 | ||
| 6 | Instance method | Private | Method | 20070502 | ||
| 7 | Instance method | Private | Method | 20070502 | ||
| 8 | Instance method | Private | Method | 20100525 | ||
| 9 | Instance method | Private | Method | 20100525 | ||
| 10 | Instance method | Private | Method | 20100525 | ||
| 11 | Instance method | Private | Method | 20100525 |
Events
| # | Event | Type | Visibility | Description | Created on |
|---|---|---|---|---|---|
| 1 | SEL_VAR_SAVED | Instance Event (0) |
Public (2) |
20100601 |
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TT_MODIFICATIONS | Public | Attribute reference (LIKE) | 20070502 | |
||
| 2 | TT_SELECTION_PARAMETERS | Public | Attribute reference (LIKE) | 20070502 | |
||
| 3 | TY_EDIT_MODE | Public | Attribute reference (LIKE) | 20070510 | |
||
| 4 | TY_MODIFICATIONS | Public | Attribute reference (LIKE) | 20070510 | |
||
| 5 | TY_QUERY_INFO | Public | Attribute reference (LIKE) | 20070502 | |
||
| 6 | TY_QUERY_OPTIONS | Public | Attribute reference (LIKE) | 20070502 | |
||
| 7 | TY_SELECTION_PARAMETER | Public | Attribute reference (LIKE) | 20070502 | |
Method Signatures
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class /RPM/CL_FAVOURITES_API has no parameter.
Method CLASS_CONSTRUCTOR on class /RPM/CL_FAVOURITES_API has no exception.
Method CONTRUCTORS Signature
Method CONTRUCTORS on class /RPM/CL_FAVOURITES_API has no parameter.
Method CONTRUCTORS on class /RPM/CL_FAVOURITES_API has no exception.
Method GET_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_INSTANCE | Value transfer | Object reference (TYPE REF TO) | /RPM/CL_FAVOURITES_API | Favorites Provider class | 20081230 |
Method GET_INSTANCE on class /RPM/CL_FAVOURITES_API has no exception.
Method QUERY_DESCRIPTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IN_FILL_DATA | Call by reference | Type reference (TYPE) | SCOL_BOOLEAN | SPACE | Boolean | 20070502 | ||
| 2 | IN_FILTER_KEYS | Call by reference | Type reference (TYPE) | INDEX TABLE | 20070502 | ||||
| 3 | IN_MESSAGE_BUFFER | Call by reference | Object reference (TYPE REF TO) | /RPM/IF_MESSAGE_BUFFER | Message Handler Interface | 20070502 | |||
| 4 | IN_QUERY_OPTIONS | Call by reference | Type reference (TYPE) | TY_QUERY_OPTIONS | 20070502 | ||||
| 5 | IN_SELECTION_PARAMETERS | Call by reference | Type reference (TYPE) | TT_SELECTION_PARAMETERS | 20070502 | ||||
| 6 | OUT_DATA | Call by reference | Type reference (TYPE) | INDEX TABLE | 20070502 | ||||
| 7 | OUT_KEYS | Call by reference | Type reference (TYPE) | INDEX TABLE | 20070502 | ||||
| 8 | OUT_QUERY_INFO | Call by reference | Type reference (TYPE) | TY_QUERY_INFO | 20070502 |
Method QUERY_DESCRIPTION on class /RPM/CL_FAVOURITES_API has no exception.
Method QUERY_FAVORITE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IN_FILL_DATA | Call by reference | Type reference (TYPE) | SCOL_BOOLEAN | SPACE | Boolean | 20070502 | ||
| 2 | IN_FILTER_KEYS | Call by reference | Type reference (TYPE) | INDEX TABLE | 20070502 | ||||
| 3 | IN_MESSAGE_BUFFER | Call by reference | Object reference (TYPE REF TO) | /RPM/IF_MESSAGE_BUFFER | Message Handler Interface | 20070502 | |||
| 4 | IN_QUERY_OPTIONS | Call by reference | Type reference (TYPE) | TY_QUERY_OPTIONS | 20070502 | ||||
| 5 | IN_SELECTION_PARAMETERS | Call by reference | Type reference (TYPE) | TT_SELECTION_PARAMETERS | 20070502 | ||||
| 6 | OUT_DATA | Call by reference | Type reference (TYPE) | INDEX TABLE | 20070502 | ||||
| 7 | OUT_KEYS | Call by reference | Type reference (TYPE) | INDEX TABLE | 20070502 | ||||
| 8 | OUT_QUERY_INFO | Call by reference | Type reference (TYPE) | TY_QUERY_INFO | 20070502 |
Method QUERY_FAVORITE on class /RPM/CL_FAVOURITES_API has no exception.
Method QUERY_FAVORITE_GETLIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IN_FILL_DATA | Call by reference | Type reference (TYPE) | SCOL_BOOLEAN | SPACE | Boolean | 20070502 | ||
| 2 | IN_FILTER_KEYS | Call by reference | Type reference (TYPE) | INDEX TABLE | 20070502 | ||||
| 3 | IN_MESSAGE_BUFFER | Call by reference | Object reference (TYPE REF TO) | /RPM/IF_MESSAGE_BUFFER | Message Handler Interface | 20070502 | |||
| 4 | IN_QUERY_OPTIONS | Call by reference | Type reference (TYPE) | TY_QUERY_OPTIONS | 20070502 | ||||
| 5 | IN_SELECTION_PARAMETERS | Call by reference | Type reference (TYPE) | TT_SELECTION_PARAMETERS | 20070502 | ||||
| 6 | OUT_DATA | Call by reference | Type reference (TYPE) | INDEX TABLE | 20070502 | ||||
| 7 | OUT_KEYS | Call by reference | Type reference (TYPE) | INDEX TABLE | 20070502 | ||||
| 8 | OUT_QUERY_INFO | Call by reference | Type reference (TYPE) | TY_QUERY_INFO | 20070502 |
Method QUERY_FAVORITE_GETLIST on class /RPM/CL_FAVOURITES_API has no exception.
Method QUERY_FAVORITE_ITEMS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IN_FILL_DATA | Call by reference | Type reference (TYPE) | SCOL_BOOLEAN | SPACE | Boolean | 20070502 | ||
| 2 | IN_FILTER_KEYS | Call by reference | Type reference (TYPE) | INDEX TABLE | 20070502 | ||||
| 3 | IN_MESSAGE_BUFFER | Call by reference | Object reference (TYPE REF TO) | /RPM/IF_MESSAGE_BUFFER | Message Handler Interface | 20070502 | |||
| 4 | IN_QUERY_OPTIONS | Call by reference | Type reference (TYPE) | TY_QUERY_OPTIONS | 20070502 | ||||
| 5 | IN_SELECTION_PARAMETERS | Call by reference | Type reference (TYPE) | TT_SELECTION_PARAMETERS | 20070502 | ||||
| 6 | OUT_DATA | Call by reference | Type reference (TYPE) | INDEX TABLE | 20070502 | ||||
| 7 | OUT_KEYS | Call by reference | Type reference (TYPE) | INDEX TABLE | 20070502 | ||||
| 8 | OUT_QUERY_INFO | Call by reference | Type reference (TYPE) | TY_QUERY_INFO | 20070502 |
Method QUERY_FAVORITE_ITEMS on class /RPM/CL_FAVOURITES_API has no exception.
Method QUERY_SEL_VAR_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IN_FILL_DATA | Call by reference | Type reference (TYPE) | SCOL_BOOLEAN | SPACE | Boolean | 20100525 | ||
| 2 | IN_FILTER_KEYS | Call by reference | Type reference (TYPE) | INDEX TABLE | 20100525 | ||||
| 3 | IN_MESSAGE_BUFFER | Call by reference | Object reference (TYPE REF TO) | /RPM/IF_MESSAGE_BUFFER | Message Handler Interface | 20100525 | |||
| 4 | IN_QUERY_OPTIONS | Call by reference | Type reference (TYPE) | TY_QUERY_OPTIONS | 20100525 | ||||
| 5 | IN_SELECTION_PARAMETERS | Call by reference | Type reference (TYPE) | TT_SELECTION_PARAMETERS | 20100525 | ||||
| 6 | OUT_DATA | Call by reference | Type reference (TYPE) | INDEX TABLE | 20100525 | ||||
| 7 | OUT_KEYS | Call by reference | Type reference (TYPE) | INDEX TABLE | 20100525 | ||||
| 8 | OUT_QUERY_INFO | Call by reference | Type reference (TYPE) | TY_QUERY_INFO | 20100525 |
Method QUERY_SEL_VAR_DATA on class /RPM/CL_FAVOURITES_API has no exception.
Method QUERY_SEL_VAR_DESC Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IN_FILL_DATA | Call by reference | Type reference (TYPE) | SCOL_BOOLEAN | SPACE | Boolean | 20100525 | ||
| 2 | IN_FILTER_KEYS | Call by reference | Type reference (TYPE) | INDEX TABLE | 20100525 | ||||
| 3 | IN_MESSAGE_BUFFER | Call by reference | Object reference (TYPE REF TO) | /RPM/IF_MESSAGE_BUFFER | Message Handler Interface | 20100525 | |||
| 4 | IN_QUERY_OPTIONS | Call by reference | Type reference (TYPE) | TY_QUERY_OPTIONS | 20100525 | ||||
| 5 | IN_SELECTION_PARAMETERS | Call by reference | Type reference (TYPE) | TT_SELECTION_PARAMETERS | 20100525 | ||||
| 6 | OUT_DATA | Call by reference | Type reference (TYPE) | INDEX TABLE | 20100525 | ||||
| 7 | OUT_KEYS | Call by reference | Type reference (TYPE) | INDEX TABLE | 20100525 | ||||
| 8 | OUT_QUERY_INFO | Call by reference | Type reference (TYPE) | TY_QUERY_INFO | 20100525 |
Method QUERY_SEL_VAR_DESC on class /RPM/CL_FAVOURITES_API has no exception.
Method QUERY_SEL_VAR_DETAIL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IN_FILL_DATA | Call by reference | Type reference (TYPE) | SCOL_BOOLEAN | SPACE | Boolean | 20100525 | ||
| 2 | IN_FILTER_KEYS | Call by reference | Type reference (TYPE) | INDEX TABLE | 20100525 | ||||
| 3 | IN_MESSAGE_BUFFER | Call by reference | Object reference (TYPE REF TO) | /RPM/IF_MESSAGE_BUFFER | Message Handler Interface | 20100525 | |||
| 4 | IN_QUERY_OPTIONS | Call by reference | Type reference (TYPE) | TY_QUERY_OPTIONS | 20100525 | ||||
| 5 | IN_SELECTION_PARAMETERS | Call by reference | Type reference (TYPE) | TT_SELECTION_PARAMETERS | 20100525 | ||||
| 6 | OUT_DATA | Call by reference | Type reference (TYPE) | INDEX TABLE | 20100525 | ||||
| 7 | OUT_KEYS | Call by reference | Type reference (TYPE) | INDEX TABLE | 20100525 | ||||
| 8 | OUT_QUERY_INFO | Call by reference | Type reference (TYPE) | TY_QUERY_INFO | 20100525 |
Method QUERY_SEL_VAR_DETAIL on class /RPM/CL_FAVOURITES_API has no exception.
Method QUERY_SEL_VAR_GETLIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IN_FILL_DATA | Call by reference | Type reference (TYPE) | SCOL_BOOLEAN | SPACE | Boolean | 20100525 | ||
| 2 | IN_FILTER_KEYS | Call by reference | Type reference (TYPE) | INDEX TABLE | 20100525 | ||||
| 3 | IN_MESSAGE_BUFFER | Call by reference | Object reference (TYPE REF TO) | /RPM/IF_MESSAGE_BUFFER | Message Handler Interface | 20100525 | |||
| 4 | IN_QUERY_OPTIONS | Call by reference | Type reference (TYPE) | TY_QUERY_OPTIONS | 20100525 | ||||
| 5 | IN_SELECTION_PARAMETERS | Call by reference | Type reference (TYPE) | TT_SELECTION_PARAMETERS | 20100525 | ||||
| 6 | OUT_DATA | Call by reference | Type reference (TYPE) | INDEX TABLE | 20100525 | ||||
| 7 | OUT_KEYS | Call by reference | Type reference (TYPE) | INDEX TABLE | 20100525 | ||||
| 8 | OUT_QUERY_INFO | Call by reference | Type reference (TYPE) | TY_QUERY_INFO | 20100525 |
Method QUERY_SEL_VAR_GETLIST on class /RPM/CL_FAVOURITES_API has no exception.
Event Signatures
Event SEL_VAR_SAVED Signature
| # | Parameter | Type | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_OBJECT_TYPE | Exporting | Value transfer | Type reference (TYPE) | /RPM/TV_FAVO_OBJECT_TYPE | Object Type of Favorites | 20100601 | ||
| 2 | IV_SEL_VAR_GUID | Exporting | Value transfer | Type reference (TYPE) | /RPM/TV_GUID | Guid for application objects | 20100601 |
History
| Last changed by/on | SAP | 20141109 |
| SAP Release Created in | 450 |