SAP ABAP Class CL_GRPC_NOTE_API (SOA: Notes)
Hierarchy
☛
GRCFND_A (Software Component) GRC Foundation ABAP
⤷
GRC-SPC (Application Component) Process Controls
⤷
GRPC_CASE_MANAGEMENT (Package) Specific to Case Management
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_GRPC_NOTES_API | SOA: Notes API | 20070611 |
Properties
| Class | CL_GRPC_NOTE_API | |
| Short Description | SOA: Notes | |
| Super Class | ||
| Instantiability of a Class | 1 | Protected |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | GRPC_CASE_MANAGEMENT | Specific to Case Management |
| Created | 20070611 | SAP |
| Last change | 20141106 | |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) | |
| 2 | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... | |
| 3 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_GRPC_NOTES_API | SOA: Notes API | 20070611 |
Friends
Class CL_GRPC_NOTE_API has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Private | Type reference (TYPE) | STRING | 'TEXT' | Default Description | 20070611 | ||
| 2 | Constant | Public | Type reference (TYPE) | STRING | 'GRPC_PC' | RMS ID | 20070611 | ||
| 3 | Constant | Private | Type reference (TYPE) | STRING | 'GRPC_PC' | Default Semantic ID | 20070611 | ||
| 4 | Constant | Public | Type reference (TYPE) | STRING | 'GRPC_SPS_NOTE' | SPS ID | 20070611 | ||
| 5 | Instance attribute | Public | Type reference (TYPE) | SRMGS_ASCII_CONTENT | Note Contents (Line ... ) | 20070611 | |||
| 6 | Static Attribute | Private | Object reference (TYPE REF TO) | CL_SRM_SRM_CLIENT_MANAGER | Basis for Client Manager | 20070611 | |||
| 7 | Static Attribute | Public | Object reference (TYPE REF TO) | IF_SRM_SRM_CLIENT_SERVICE | Global Service | 20070611 | |||
| 8 | Instance attribute | Private | Type reference (TYPE) | XFELD | Case was deleted: Yes/No (X/space) | 20070611 | |||
| 9 | Instance attribute | Private | Type reference (TYPE) | SRMBOOLEAN | Notes Were Changed (Yes/No=X/Space) | 20070611 | |||
| 10 | Instance attribute | Private | Type reference (TYPE) | SRMBOOLEAN | Lock Set: Yes/No (X/Space) | 20070611 | |||
| 11 | Instance attribute | Private | Object reference (TYPE REF TO) | CL_SRM_SP_NOTE | Note Back End | 20070611 | |||
| 12 | Instance attribute | Private | Object reference (TYPE REF TO) | IF_SRM_POID | POID of the Case | 20070611 | |||
| 13 | Static Attribute | Public | Object reference (TYPE REF TO) | IF_SRM_ROOT | Root Object | 20070611 | |||
| 14 | Instance attribute | Private | Type reference (TYPE) | SRMBOOLEAN | Update Indicator | 20070611 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | Notes: Create | 20070611 | |
| 2 | Instance method | Public | Method | Notes: Save | 20070611 | |
| 3 | Instance method | Public | Method | Remove Lock from Case | 20070611 | |
| 4 | Instance method | Public | Method | Lock Case | 20070611 | |
| 5 | Instance method | Public | Method | Get Contents of Notes | 20070611 | |
| 6 | Static method | Public | Method | Create NOTE-API Object | 20070611 | |
| 7 | Instance method | Public | Method | Get SRM_POID of the Note | 20070611 | |
| 8 | Instance method | Public | Method | Read Update Switch | 20070611 | |
| 9 | Instance method | Public | Method | Whether Note is Changed (X/Space=Yes/No) | 20070611 | |
| 10 | Instance method | Public | Method | Whether Note is Enqueued (X/Space=Yes/No) | 20070611 | |
| 11 | Instance method | Public | Method | Notes: Save | 20070611 | |
| 12 | Instance method | Public | Method | Set Note Contents | 20070611 | |
| 13 | Instance method | Private | Method | Set Update Indicator | 20070611 | |
| 14 | Static method | Protected | Method | Initialization of the Framework etc. | 20070611 | |
| 15 | Static method | Private | Method | Convert STRING into Table SRMGS_ASCII_CONTENT | 20070611 | |
| 16 | Static method | Private | Method | Convert Table SRMGS_ASCII_CONTENT into STRING | 20070611 |
Events
Class CL_GRPC_NOTE_API has no event.
Types
Class CL_GRPC_NOTE_API has no local type.
Method Signatures
Method CREATE_NOTE 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 | 20070611 | |||
| 2 | IM_SPS_ID | Value transfer | Type reference (TYPE) | STRING | SPS ID | 20070611 | |||
| 3 | IM_UPDATE_TASK | Value transfer | Type reference (TYPE) | SRMBOOLEAN | IF_SRM=>TRUE | Update Indicator (Initial = No Update, X = Update) | 20070611 | ||
| 4 | R_NOTE | Value transfer | Object reference (TYPE REF TO) | CL_GRPC_NOTE_API | SOA: Notes | 20070611 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20070611 |
Method DELETE Signature
Method DELETE on class CL_GRPC_NOTE_API has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20070611 |
Method DEQUEUE Signature
Method DEQUEUE on class CL_GRPC_NOTE_API has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20070611 |
Method ENQUEUE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_MODE | Call by reference | Type reference (TYPE) | STRING | IF_SRM_SP_ENQUEUE=>MODE_EXCLUSIVE | 20070611 | |||
| 2 | IM_SCOPE | Call by reference | Type reference (TYPE) | STRING | IF_SRM_SP_ENQUEUE=>SCOPE_DIALOG | 20070611 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20070611 |
Method GET_CONTENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_ASCII_CONTENT | Value transfer | Type reference (TYPE) | STRING | Note Contents | 20070611 |
Method GET_CONTENT on class CL_GRPC_NOTE_API has no exception.
Method GET_NOTE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_DOC_ID | Value transfer | Type reference (TYPE) | SRMGS_DOC_ID | DOC_ID in SRM_LIST_POID | 20070611 | |||
| 2 | IM_RMS_ID | Value transfer | Type reference (TYPE) | STRING | RMS ID | 20070611 | |||
| 3 | IM_SPS_ID | Value transfer | Type reference (TYPE) | STRING | SPS ID | 20070611 | |||
| 4 | IM_SP_POID | Value transfer | Type reference (TYPE) | SRM_LIST_POID | List: POID Parameter Values | 20070611 | |||
| 5 | IM_SRM_POID | Value transfer | Object reference (TYPE REF TO) | IF_SRM_POID | POID | 20070611 | |||
| 6 | IM_UPDATE_TASK | Value transfer | Type reference (TYPE) | SRMBOOLEAN | IF_SRM=>TRUE | Update Indicator (Initial = No Update, X = Update) | 20070611 | ||
| 7 | IM_VARIANT | Value transfer | Type reference (TYPE) | SRMGS_DOC_VAR_ID | 0 | VARIANT in SRM_LIST_POID | 20070611 | ||
| 8 | IM_VERSION | Value transfer | Type reference (TYPE) | SRMGS_DOC_VER_ID | 0 | VERSION in SRM_LIST_POID | 20070611 | ||
| 9 | R_NOTE | Value transfer | Object reference (TYPE REF TO) | CL_GRPC_NOTE_API | SOA: Notes | 20070611 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20070611 |
Method GET_SRM_POID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_SRM_POID | Value transfer | Object reference (TYPE REF TO) | IF_SRM_POID | POID | 20070611 |
Method GET_SRM_POID on class CL_GRPC_NOTE_API has no exception.
Method GET_UPDATE_TASK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RE_UPDATE_TASK | Value transfer | Type reference (TYPE) | SRMBOOLEAN | Boolean: Possible Values IF_SRM=>TRUE / FALSE | 20070611 |
Method GET_UPDATE_TASK on class CL_GRPC_NOTE_API has no exception.
Method IS_CHANGED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_CHANGED | Value transfer | Type reference (TYPE) | SRMBOOLEAN | X/Space=Yes/No | 20070611 |
Method IS_CHANGED on class CL_GRPC_NOTE_API has no exception.
Method IS_ENQUEUED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_ENQUEUED | Value transfer | Type reference (TYPE) | SRMBOOLEAN | X/Space=Yes/No | 20070611 |
Method IS_ENQUEUED on class CL_GRPC_NOTE_API has no exception.
Method SAVE Signature
Method SAVE on class CL_GRPC_NOTE_API has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20070611 |
Method SET_CONTENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_ASCII_CONTENT | Value transfer | Type reference (TYPE) | STRING | Note Contents | 20070611 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20070611 |
Method SET_UPDATE_TASK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_UPDATE_TASK | Call by reference | Type reference (TYPE) | SRMBOOLEAN | Boolean: Possible Values IF_SRM=>TRUE / FALSE | 20070611 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20070611 |
Method START_FRAMEWORK Signature
Method START_FRAMEWORK on class CL_GRPC_NOTE_API has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Initialization Error (Abstract) | 20070611 | ||
| 2 | SOA: Case | 20070611 |
Method STR_TO_TAB Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_STR | Value transfer | Type reference (TYPE) | STRING | String Value | 20070611 | |||
| 2 | R_TAB | Value transfer | Type reference (TYPE) | SRMGS_ASCII_CONTENT | Table Value (SRMGS_ASCII_CONTENT) | 20070611 |
Method STR_TO_TAB on class CL_GRPC_NOTE_API has no exception.
Method TAB_TO_STR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_TAB | Value transfer | Type reference (TYPE) | SRMGS_ASCII_CONTENT | Table Value (SRMGS_ASCII_CONTENT) | 20070611 | |||
| 2 | R_STR | Value transfer | Type reference (TYPE) | STRING | String Value | 20070611 |
Method TAB_TO_STR on class CL_GRPC_NOTE_API has no exception.
History
| Last changed by/on | SAP | 20141106 |
| SAP Release Created in | 250 |