SAP ABAP Class CL_PAL_FAVORITES (Class for Favorites)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-CCM-PRN (Application Component) Print and Output Management
⤷
SPCPC (Package) Central Printer Configuration
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-CCM-PRN (Application Component) Print and Output Management⤷
SPCPC (Package) Central Printer ConfigurationProperties
| Class | CL_PAL_FAVORITES | |
| Short Description | Class for Favorites | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SPCPC | Central Printer Configuration |
| Created | 20100705 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  ABAP |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_PAL_FAVORITES has no interface implemented.
Friends
Class CL_PAL_FAVORITES has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CO_PG_ID_STRUC |
Constant | Public | Type reference (TYPE) | STRING | 'SPCPC_PGROUP_ID' | 20100713 | ||
| 2 | CO_TSG_ID_STRUC |
Constant | Public | Type reference (TYPE) | STRING | 'SPCPC_TSGROUP_ID' | 20100712 | ||
| 3 | GO_PG_ID_STRUC |
Static Attribute | Private | Object reference (TYPE REF TO) | CL_ABAP_STRUCTDESCR | Runtime Type Services | 20100713 | ||
| 4 | GO_TSG_ID_STRUC |
Static Attribute | Private | Object reference (TYPE REF TO) | CL_ABAP_STRUCTDESCR | Runtime Type Services | 20100713 | ||
| 5 | GT_PG_ID_DFIE |
Static Attribute | Private | Type reference (TYPE) | DDFIELDS | DD: Field List | 20100713 | ||
| 6 | GT_TSG_ID_DFIE |
Static Attribute | Private | Type reference (TYPE) | DDFIELDS | DD: Field List | 20100713 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ADD_FAVORITES |
Static method | Public | Method | Add Target System Group(s) or Target System(s) | 20100714 |
| 2 | ADD_TSG_TO_PG |
Static method | Public | Method | Add Target System Group(s) to Favorite of Printer Group | 20100708 |
| 3 | DOES_PG_TSG_EXIST |
Static method | Private | Method | Does Printer Group exist | 20100716 |
| 4 | FILTER_STRUC_BY_PG_ID |
Static method | Private | Method | Filter the table according to the SPCPC_TS_ID field | 20100714 |
| 5 | FILTER_STRUC_BY_TSG_ID |
Static method | Private | Method | Filter the table according to the SPCPC_TS_ID field | 20100714 |
| 6 | GET_ALL_TSG |
Static method | Public | Method | Get all Target System Groups | 20100714 |
| 7 | GET_FAVORITES |
Static method | Public | Method | Get Target System Group(s) or Target System(s) | 20100714 |
| 8 | GET_FREE_TSG_FROM_PG |
Static method | Public | Method | Get free Target System Group(s) | 20100708 |
| 9 | GET_TSG_FROM_PG |
Static method | Public | Method | Get Target System Group(s) from Printer Group | 20100708 |
| 10 | IS_PG_ID_FIELDS_EMPTY |
Static method | Private | Method | Are the fields of the PG-ID empty | 20100714 |
| 11 | IS_TSG_ID_FIELDS_EMPTY |
Static method | Private | Method | Is the fields of the TSG-ID structure empty | 20100714 |
| 12 | REMOVE_FAVORITES |
Static method | Public | Method | Remove Target System Group(s) or Taget System(s) | 20100714 |
| 13 | REMOVE_FAVORITES_BY_PGNAME |
Static method | Public | Method | Remove PRG - TSG by Printer Group name | 20100720 |
| 14 | REMOVE_FAVORITES_BY_TSGNAME |
Static method | Public | Method | Remove PRG - TSG by Target Sytem Group name | 20100720 |
| 15 | REMOVE_TSG_FROM_PG |
Static method | Public | Method | Delete TSG(s) from Printer Group as favorite Target(s) | 20100714 |
Events
Class CL_PAL_FAVORITES has no event.
Types
Class CL_PAL_FAVORITES has no local type.
Method Signatures
Method ADD_FAVORITES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
EV_RETURN_CODE | Call by reference | Type reference (TYPE) | SPCPC_RETURN_CODE | Return Code | 20100714 | ||
| 2 |  Importing |
IT_TSG | Call by reference | Type reference (TYPE) | SPCPC_TARGET_SYSTEM_GRP_TABLE | Table of CPC target system groups | 20100714 | ||
| 3 | Importing |
IV_PG_ID | Call by reference | Type reference (TYPE) | SPCPC_PGROUP_ID | Printer group name | 20100714 |
Method ADD_FAVORITES on class CL_PAL_FAVORITES has no exception.
Method ADD_TSG_TO_PG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EV_RETURN_CODE | Call by reference | Type reference (TYPE) | SPCPC_RETURN_CODE | Return Code | 20100712 | ||
| 2 | Importing |
IT_TSG | Call by reference | Type reference (TYPE) | SPCPC_TARGET_SYSTEM_GRP_TABLE | Table of CPC target system groups | 20100712 | ||
| 3 | Importing |
IV_PG_ID | Call by reference | Type reference (TYPE) | SPCPC_PGROUP_ID | Printer group name | 20100713 |
Method ADD_TSG_TO_PG on class CL_PAL_FAVORITES has no exception.
Method DOES_PG_TSG_EXIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_PG_NAME | Call by reference | Type reference (TYPE) | SPCPCPGNAME | Printer group name | 20100716 | ||
| 2 | Importing |
IV_TSG_NAME | Call by reference | Type reference (TYPE) | SPCPCTSGNAME | Name of target system group | 20100716 | ||
| 3 |  Returning |
RV_EXIST | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20100716 |
Method DOES_PG_TSG_EXIST on class CL_PAL_FAVORITES has no exception.
Method FILTER_STRUC_BY_PG_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_PG_ID_FILTER | Call by reference | Type reference (TYPE) | SPCPC_PGROUP_ID | ID for group of central managed printers | 20100714 | ||
| 2 | Importing |
IV_PG_ID_SOURCE | Call by reference | Type reference (TYPE) | SPCPC_PGROUP_ID | ID for group of central managed printers | 20100714 | ||
| 3 | Returning |
RV_CONTAIN | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20100714 |
Method FILTER_STRUC_BY_PG_ID on class CL_PAL_FAVORITES has no exception.
Method FILTER_STRUC_BY_TSG_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_TSG_ID | Call by reference | Type reference (TYPE) | SPCPC_TSGROUP_ID | ID for CPC target system group | 20100714 | ||
| 2 | Importing |
IV_TSG_ID_FILTER | Call by reference | Type reference (TYPE) | SPCPC_TSGROUP_ID | ID for CPC target system group | 20100714 | ||
| 3 | Returning |
RV_CONTAIN | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20100714 |
Method FILTER_STRUC_BY_TSG_ID on class CL_PAL_FAVORITES has no exception.
Method GET_ALL_TSG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_MAPPING_FAV | Call by reference | Type reference (TYPE) | SPCPC_MAPPING_FAV_TAB | Printer Group - Target System Group for Favorite Information | 20100714 | ||
| 2 | Exporting |
EV_RETURN_CODE | Call by reference | Type reference (TYPE) | SPCPC_RETURN_CODE | Return Code | 20100714 | ||
| 3 | Importing |
IV_PG_ID | Call by reference | Type reference (TYPE) | SPCPC_PGROUP_ID | ID for group of central managed printers | 20100718 | ||
| 4 | Importing |
IV_TSG_ID | Call by reference | Type reference (TYPE) | SPCPC_TSGROUP_ID | ID for CPC target system group | 20100714 |
Method GET_ALL_TSG on class CL_PAL_FAVORITES has no exception.
Method GET_FAVORITES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_MAPPING_FAV | Call by reference | Type reference (TYPE) | SPCPC_MAPPING_FAV_TAB | Printer Group - Target System Group for Favorite Information | 20100714 | ||
| 2 | Exporting |
EV_RETURN_CODE | Call by reference | Type reference (TYPE) | SPCPC_RETURN_CODE | Return Code | 20100714 | ||
| 3 | Importing |
IV_FAV_STATUS | Call by reference | Type reference (TYPE) | SPCPC_FAV_STATUS | 1 | PAL - Favorite Status | 20100714 | |
| 4 | Importing |
IV_PG_ID | Call by reference | Type reference (TYPE) | SPCPC_PGROUP_ID | ID for group of central managed printers | 20100714 | ||
| 5 | Importing |
IV_TSG_ID | Call by reference | Type reference (TYPE) | SPCPC_TSGROUP_ID | ID for CPC target system group | 20100714 |
Method GET_FAVORITES on class CL_PAL_FAVORITES has no exception.
Method GET_FREE_TSG_FROM_PG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_MAPPING_FAV | Call by reference | Type reference (TYPE) | SPCPC_MAPPING_FAV_TAB | Printer Group - Target System Group for Favorite Information | 20100714 | ||
| 2 | Exporting |
EV_RETURN_CODE | Call by reference | Type reference (TYPE) | SPCPC_RETURN_CODE | Return Code | 20100708 | ||
| 3 | Importing |
IV_PG_ID | Call by reference | Type reference (TYPE) | SPCPC_PGROUP_ID | Printer group name | 20100712 | ||
| 4 | Importing |
IV_TSG_ID | Call by reference | Type reference (TYPE) | SPCPC_TSGROUP_ID | ID for CPC target system group | 20100714 |
Method GET_FREE_TSG_FROM_PG on class CL_PAL_FAVORITES has no exception.
Method GET_TSG_FROM_PG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_MAPPING_FAV | Call by reference | Type reference (TYPE) | SPCPC_MAPPING_FAV_TAB | Table of CPC target system groups | 20100714 | ||
| 2 | Exporting |
EV_RETURN_CODE | Call by reference | Type reference (TYPE) | SPCPC_RETURN_CODE | Return Code | 20100708 | ||
| 3 | Importing |
IV_PG_ID | Call by reference | Type reference (TYPE) | SPCPC_PGROUP_ID | Printer group name | 20100712 | ||
| 4 | Importing |
IV_TSG_ID | Call by reference | Type reference (TYPE) | SPCPC_TSGROUP_ID | ID for CPC target system group | 20100714 |
Method GET_TSG_FROM_PG on class CL_PAL_FAVORITES has no exception.
Method IS_PG_ID_FIELDS_EMPTY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_PG_ID | Call by reference | Type reference (TYPE) | SPCPC_PGROUP_ID | ID for group of central managed printers | 20100714 | ||
| 2 | Returning |
RV_IS_NOT_EMPTY | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20100714 |
Method IS_PG_ID_FIELDS_EMPTY on class CL_PAL_FAVORITES has no exception.
Method IS_TSG_ID_FIELDS_EMPTY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_TSG_ID | Call by reference | Type reference (TYPE) | SPCPC_TSGROUP_ID | ID for group of central managed printers | 20100714 | ||
| 2 | Returning |
RV_IS_NOT_EMPTY | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20100714 |
Method IS_TSG_ID_FIELDS_EMPTY on class CL_PAL_FAVORITES has no exception.
Method REMOVE_FAVORITES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_TSG | Call by reference | Type reference (TYPE) | SPCPC_TARGET_SYSTEM_GRP_TABLE | Table of CPC target system groups | 20100714 | ||
| 2 | Importing |
IV_PG_ID | Call by reference | Type reference (TYPE) | SPCPC_PGROUP_ID | ID for group of central managed printers | 20100714 | ||
| 3 | Returning |
RV_RETURN_CODE | Value transfer | Type reference (TYPE) | SPCPC_RETURN_CODE | Return Code | 20100714 |
Method REMOVE_FAVORITES on class CL_PAL_FAVORITES has no exception.
Method REMOVE_FAVORITES_BY_PGNAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_PG_NAME | Call by reference | Type reference (TYPE) | SPCPCPGNAME | Printer group name | 20100720 | ||
| 2 | Returning |
RV_RETURN_CODE | Value transfer | Type reference (TYPE) | SPCPC_RETURN_CODE | Return Code | 20100720 |
Method REMOVE_FAVORITES_BY_PGNAME on class CL_PAL_FAVORITES has no exception.
Method REMOVE_FAVORITES_BY_TSGNAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_TSG_NAME | Call by reference | Type reference (TYPE) | SPCPCTSGNAME | Name of target system group | 20100720 | ||
| 2 | Returning |
RV_RETURN_CODE | Value transfer | Type reference (TYPE) | SPCPC_RETURN_CODE | Name of target system group | 20100720 |
Method REMOVE_FAVORITES_BY_TSGNAME on class CL_PAL_FAVORITES has no exception.
Method REMOVE_TSG_FROM_PG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_TSG | Call by reference | Type reference (TYPE) | SPCPC_TARGET_SYSTEM_GRP_TABLE | Table of CPC target system groups | 20100714 | ||
| 2 | Importing |
IV_PG_ID | Call by reference | Type reference (TYPE) | SPCPC_PGROUP_ID | Printer group name | 20100714 | ||
| 3 | Returning |
RV_RETURN_CODE | Value transfer | Type reference (TYPE) | SPCPC_RETURN_CODE | Return Code | 20100714 |
Method REMOVE_TSG_FROM_PG on class CL_PAL_FAVORITES has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 703 |
