SAP ABAP Class CL_PIM_API (PIM API)
Hierarchy
☛
SAP_BS_FND (Software Component) SAP Business Suite Foundation
⤷
PIMAPI (Package) Product Information Management - Integration
⤷
Properties
| Class | CL_PIM_API | |
| Short Description | PIM API | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | PIMAPI | Product Information Management - Integration |
| Created | 20130802 | SAP |
| Last change | 20140121 | 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_PIM_API has no interface implemented.
Friends
Class CL_PIM_API has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Private | Object reference (TYPE REF TO) | CL_PIM_FACADE | PIM Facade | 20130807 | |||
| 2 | Instance attribute | Private | Object reference (TYPE REF TO) | LIF_PIM_FACADE_STUB | 20130813 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Private | Method | Validate the Asset Type | 20130813 | |
| 2 | Instance method | Private | Method | Validate the Search Parameters (under specific asset type) | 20130813 | |
| 3 | Instance method | Public | Constructor | 20130802 | ||
| 4 | Instance method | Private | Method | Convert 1 digit SAP language key->2 digit ISO language | 20130919 | |
| 5 | Instance method | Private | Method | Convert 2 digit ISO language->1 digit SAP language key | 20130919 | |
| 6 | Instance method | Public | Method | Check PIM Service Status | 20130802 | |
| 7 | Instance method | Public | Method | Get a set of Assets by predefined search criteria | 20130802 | |
| 8 | Instance method | Public | Method | Get a set of Assets by range of search criteria | 20130805 | |
| 9 | Instance method | Private | Method | Validate if the input string a valid DATs | 20131003 |
Events
Class CL_PIM_API has no event.
Types
Class CL_PIM_API has no local type.
Method Signatures
Method CHECK_VALID_ASSET_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CT_ASSET_TYPE | Call by reference | Type reference (TYPE) | PIM_ASSET_TYPE_T | Table for Searching Asset Type with PIM | 20130813 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | PIM Exception Class | 20130813 |
Method CHECK_VALID_SEARCH_PARAM Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CT_SEARCH_PARAM | Call by reference | Type reference (TYPE) | PIM_SEARCH_PARAM_BY_RANGE_T | Table for PIM Search Parameters by Range | 20130813 | |||
| 2 | IT_ASSET_TYPE | Call by reference | Type reference (TYPE) | PIM_ASSET_TYPE_T | Search for Assets in PIM | 20131008 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | PIM Exception Class | 20130813 |
Method CONSTRUCTOR Signature
Method CONSTRUCTOR on class CL_PIM_API has no parameter.
Method CONSTRUCTOR on class CL_PIM_API has no exception.
Method CONVERT_LANGUAGE_1_TO_2 Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_SEARCH_PARAM | Call by reference | Type reference (TYPE) | PIM_SEARCH_PARAM_S | Structure for Searching Parameters with PIM | 20130920 | |||
| 2 | IS_SEARCH_PARAM_INTERNAL | Call by reference | Type reference (TYPE) | PIM_SEARCH_PARAM_INTERNAL_S | Structure for Searching Parameters with PIM | 20130920 |
Method CONVERT_LANGUAGE_1_TO_2 on class CL_PIM_API has no exception.
Method CONVERT_LANGUAGE_2_TO_1 Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_AUDIO_ASSET_INTERNAL | Call by reference | Type reference (TYPE) | PIM_AUDIO_ASSET_INTERNAL_T | 20130920 | ||||
| 2 | ET_DOCUMENT_ASSET_INTERNAL | Call by reference | Type reference (TYPE) | PIM_DOCUMENT_ASSET_INTERNAL_T | 20130920 | ||||
| 3 | ET_IMAGE_ASSET_INTERNAL | Call by reference | Type reference (TYPE) | PIM_IMAGE_ASSET_INTERNAL_T | 20130920 | ||||
| 4 | ET_TEXT_ASSET_INTERNAL | Call by reference | Type reference (TYPE) | PIM_TEXT_ASSET_INTERNAL_T | 20130920 | ||||
| 5 | ET_VIDEO_ASSET_INTERNAL | Call by reference | Type reference (TYPE) | PIM_VIDEO_ASSET_INTERNAL_T | 20130920 | ||||
| 6 | IT_AUDIO_ASSET | Call by reference | Type reference (TYPE) | PIM_AUDIO_ASSET_T | 20130919 | ||||
| 7 | IT_DOCUMENT_ASSET | Call by reference | Type reference (TYPE) | PIM_DOCUMENT_ASSET_T | 20130919 | ||||
| 8 | IT_IMAGE_ASSET | Call by reference | Type reference (TYPE) | PIM_IMAGE_ASSET_T | 20130919 | ||||
| 9 | IT_TEXT_ASSET | Call by reference | Type reference (TYPE) | PIM_TEXT_ASSET_T | 20130919 | ||||
| 10 | IT_VIDEO_ASSET | Call by reference | Type reference (TYPE) | PIM_VIDEO_ASSET_T | 20130919 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | PIM Exception Class | 20130919 |
Method GET_PIM_SERVICE_STATUS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_ERROR_MSG | Call by reference | Type reference (TYPE) | STRING | 20130805 | ||||
| 2 | EV_STATUS | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20130805 |
Method GET_PIM_SERVICE_STATUS on class CL_PIM_API has no exception.
Method SEARCH_ASSETS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_AUDIO_ASSET | Call by reference | Type reference (TYPE) | PIM_AUDIO_ASSET_INTERNAL_T | Structure for Searching Parameters with PIM | 20130805 | |||
| 2 | ET_DOCUMENT_ASSET | Call by reference | Type reference (TYPE) | PIM_DOCUMENT_ASSET_INTERNAL_T | Structure for Searching Parameters with PIM | 20130805 | |||
| 3 | ET_IMAGE_ASSET | Call by reference | Type reference (TYPE) | PIM_IMAGE_ASSET_INTERNAL_T | Structure for Searching Parameters with PIM | 20130805 | |||
| 4 | ET_RETURN_INFO | Call by reference | Type reference (TYPE) | STRINGTAB | Table with Strings | 20130805 | |||
| 5 | ET_TEXT_ASSET | Call by reference | Type reference (TYPE) | PIM_TEXT_ASSET_INTERNAL_T | Structure for Searching Parameters with PIM | 20130805 | |||
| 6 | ET_VIDEO_ASSET | Call by reference | Type reference (TYPE) | PIM_VIDEO_ASSET_INTERNAL_T | Structure for Searching Parameters with PIM | 20130805 | |||
| 7 | EV_RETURN_CODE | Call by reference | Type reference (TYPE) | I | 20130805 | ||||
| 8 | IS_SEARCH_PARAM | Call by reference | Type reference (TYPE) | PIM_SEARCH_PARAM_INTERNAL_S | Structure for Searching Parameters with PIM | 20130805 | |||
| 9 | IT_ASSET_TYPE | Call by reference | Type reference (TYPE) | PIM_ASSET_TYPE_T | 20130916 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | PIM Exception Class | 20130807 |
Method SEARCH_ASSETS_BY_RANGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_AUDIO_ASSET | Call by reference | Type reference (TYPE) | PIM_AUDIO_ASSET_INTERNAL_T | Table for PIM Audio Asset | 20130805 | |||
| 2 | ET_DOCUMENT_ASSET | Call by reference | Type reference (TYPE) | PIM_DOCUMENT_ASSET_INTERNAL_T | Table for PIM Document Asset | 20130805 | |||
| 3 | ET_IMAGE_ASSET | Call by reference | Type reference (TYPE) | PIM_IMAGE_ASSET_INTERNAL_T | Table for PIM Image Asset | 20130805 | |||
| 4 | ET_RETURN_INFO | Call by reference | Type reference (TYPE) | STRINGTAB | Table with Strings | 20130805 | |||
| 5 | ET_TEXT_ASSET | Call by reference | Type reference (TYPE) | PIM_TEXT_ASSET_INTERNAL_T | Table for PIM Text Asset | 20130805 | |||
| 6 | ET_VIDEO_ASSET | Call by reference | Type reference (TYPE) | PIM_VIDEO_ASSET_INTERNAL_T | Table for PIM Video Asset | 20130805 | |||
| 7 | EV_RETURN_CODE | Call by reference | Type reference (TYPE) | I | 20130805 | ||||
| 8 | IT_ASSET_TYPE | Call by reference | Type reference (TYPE) | PIM_ASSET_TYPE_T | Table for Searching Asset Type with PIM | 20130808 | |||
| 9 | IT_SEARCH_PARAM | Call by reference | Type reference (TYPE) | PIM_SEARCH_PARAM_BY_RANGE_T | Table for Searching Asset Type with PIM | 20130805 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | PIM Exception Class | 20130808 |
Method VALIDATE_DATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_DATE_STR | Call by reference | Type reference (TYPE) | TABNAME30 | String | 20131003 | |||
| 2 | RV_ISVALID | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20131003 |
Method VALIDATE_DATE on class CL_PIM_API has no exception.
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 748 |