SAP ABAP Class CL_WCF_FAV_FACTORY (Favorites factory)
Hierarchy
☛
WEBCUIF (Software Component) SAP Web UI Framework
⤷
CA-WUI-UI (Application Component) User Interface
⤷
WCF_FAVORITES_CORE (Package) Favorites Core Objects
⤷
⤷
Properties
| Class | CL_WCF_FAV_FACTORY | |
| Short Description | Favorites factory | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | WCF_FAVORITES_CORE | Favorites Core Objects |
| Created | 20090216 | SAP |
| Last change | 20100303 | 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) |
Interfaces
Class CL_WCF_FAV_FACTORY has no interface implemented.
Friends
Class CL_WCF_FAV_FACTORY has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Static Attribute | Private | Object reference (TYPE REF TO) | CL_WCF_FAV_CONST | Favorite constants | 20090216 | |||
| 2 | Static Attribute | Private | Object reference (TYPE REF TO) | CL_WCF_FAV_EXCEPTION_REPORTER | Services for raising exceptions | 20090219 | |||
| 3 | Static Attribute | Private | Object reference (TYPE REF TO) | CL_WCF_FAV_FACTORY | Singleton reference | 20090217 | |||
| 4 | Static Attribute | Private | Object reference (TYPE REF TO) | CL_WCF_FAV_PERSISTENCE | Persistence for favorites | 20090216 | |||
| 5 | Static Attribute | Private | Object reference (TYPE REF TO) | CL_WCF_FAV_SERVICES | Service methods for favorites | 20090219 | |||
| 6 | Static Attribute | Private | Object reference (TYPE REF TO) | CL_WCF_FAV_SHARED_FAVORITES | Shared favorites | 20090216 | |||
| 7 | Static Attribute | Private | Type reference (TYPE) | LTY_T_USER | Users buffer | 20090216 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Constructor | CLASS_CONSTRUCTOR | 20090216 | |
| 2 | Static method | Public | Method | Returns a favorite | 20090217 | |
| 3 | Static method | Private | Method | Returns existing favorite root object | 20090217 | |
| 4 | Static method | Public | Method | Returns singleton instance | 20090217 | |
| 5 | Static method | Public | Method | Returns a new filter | 20090507 | |
| 6 | Static method | Public | Method | Returns new root object favorite | 20090219 | |
| 7 | Static method | Public | Method | Returns shared favorites | 20090216 | |
| 8 | Static method | Public | Method | Get existing user favorites | 20090216 |
Events
Class CL_WCF_FAV_FACTORY has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | LTY_S_USER | Private | See coding | 20090216 | BEGIN OF LTY_S_USER,
user TYPE syuname,
instance TYPE REF TO cl_wcf_fav_user_favorites,
END OF LTY_S_USER
|
||
| 2 | LTY_T_USER | Private | See coding | 20090216 | LTY_T_USER TYPE HASHED TABLE OF LTY_S_USER WITH UNIQUE KEY user
|
Method Signatures
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class CL_WCF_FAV_FACTORY has no parameter.
Method CLASS_CONSTRUCTOR on class CL_WCF_FAV_FACTORY has no exception.
Method GET_FAVORITE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ID | Call by reference | Type reference (TYPE) | WCF_FAV_ID | Favorite id | 20090217 | |||
| 2 | IV_STANDALONE_MODE | Call by reference | Type reference (TYPE) | BOOLEAN | ABAP_FALSE | Boolean Variable (X=True, -=False, Space=Unknown) | 20091017 | ||
| 3 | IV_TYPE | Call by reference | Type reference (TYPE) | WCF_FAV_ELEMENT_TYPE | Favorite element type | 20090217 | |||
| 4 | RR_FAVORITE | Value transfer | Object reference (TYPE REF TO) | IF_WCF_FAV_FAVORITE_ELEMENT | 20090217 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Favorite not found | 20090219 |
Method GET_FAVORITE_ROOT_OBJECT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ID | Call by reference | Type reference (TYPE) | WCF_FAV_ID | ID | 20090217 | |||
| 2 | IV_STANDALONE_MODE | Call by reference | Type reference (TYPE) | BOOLEAN | ABAP_FALSE | Boolean Variable (X=True, -=False, Space=Unknown) | 20091017 | ||
| 3 | RR_ROOT_OBJECT | Value transfer | Object reference (TYPE REF TO) | IF_WCF_FAV_FAVORITE_ELEMENT | 20090217 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Favorite not found | 20090219 |
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) | CL_WCF_FAV_FACTORY | Favorites factory | 20090217 |
Method GET_INSTANCE on class CL_WCF_FAV_FACTORY has no exception.
Method GET_NEW_FILTER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_CRITERIA | Call by reference | Type reference (TYPE) | WCF_FAVT_FILTER_CRITERIA | Favorite filter criteria | 20090507 | |||
| 2 | IV_TYPE | Call by reference | Type reference (TYPE) | WCF_FAV_ELEMENT_TYPE | Element Type | 20090507 | |||
| 3 | RR_FILTER | Value transfer | Object reference (TYPE REF TO) | IF_WCF_FAV_FILTER | Favorite filter | 20090507 |
Method GET_NEW_FILTER on class CL_WCF_FAV_FACTORY has no exception.
Method GET_NEW_ROOT_OBJ_FAVORITE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_FOLDER | Call by reference | Type reference (TYPE) | WCF_FAV_ID | ID | 20090219 | |||
| 2 | IV_GENIL_ID | Call by reference | Type reference (TYPE) | CRMT_GENIL_OBJECT_ID | Object ID in Generic Interaction Layer | 20090219 | |||
| 3 | IV_NAME | Call by reference | Type reference (TYPE) | WCF_FAV_NAME | Name | 20090219 | |||
| 4 | IV_OBJECT_NAME | Call by reference | Type reference (TYPE) | CRMT_EXT_OBJ_NAME | External Name of Object | 20090219 | |||
| 5 | IV_SHARED | Call by reference | Type reference (TYPE) | BOOLEAN | Boolean Variable (X=True, -=False, Space=Unknown) | 20090219 | |||
| 6 | IV_UI_OBJECT_TYPE | Call by reference | Type reference (TYPE) | BSP_DLC_OBJECT_TYPE | UI Object Type | 20090219 | |||
| 7 | IV_USER | Call by reference | Type reference (TYPE) | SYUNAME | User Name | 20090219 | |||
| 8 | RR_FAVORITE | Value transfer | Object reference (TYPE REF TO) | IF_WCF_FAV_FAVORITE_ELEMENT | 20090219 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Input parameters invalid | 20090220 |
Method GET_SHARED_FAVORITES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_SHARED | Value transfer | Object reference (TYPE REF TO) | CL_WCF_FAV_SHARED_FAVORITES | Shared favorites | 20090216 |
Method GET_SHARED_FAVORITES on class CL_WCF_FAV_FACTORY has no exception.
Method GET_USER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_USER | Call by reference | Type reference (TYPE) | SYUNAME | User name | 20090216 | |||
| 2 | RR_USER | Value transfer | Object reference (TYPE REF TO) | CL_WCF_FAV_USER_FAVORITES | Favorites for user | 20090216 |
Method GET_USER on class CL_WCF_FAV_FACTORY has no exception.
History
| Last changed by/on | SAP | 20100303 |
| SAP Release Created in | 701 |