SAP ABAP Class CL_GRFN_API_BASIS (Basis class for GRC API classes)
Hierarchy
☛
GRCFND_A (Software Component) GRC Foundation ABAP
⤷
GRC (Application Component) Governance, Risk and Compliance
⤷
GRFN_API_SERVICES (Package) GRC Foundation API Services
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_GRFN_API_BASIS | Basis interface for the GRC API | 20080123 |
Meta Relationship - Used By
Properties
| Class | CL_GRFN_API_BASIS | |
| Short Description | Basis class for GRC API classes | |
| Super Class | ||
| Instantiability of a Class | 1 | Protected |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | GRFN_API_SERVICES | GRC Foundation API Services |
| Created | 20080123 | SAP |
| Last change | 20141106 | |
| 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) | |
| 2 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 3 | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_GRFN_API_BASIS | Basis interface for the GRC API | 20080123 |
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | CL_GRFN_API_SESSION | 20080311 | Session Management for GRC APIs |
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Static Attribute | Private | Object reference (TYPE REF TO) | CL_GRFN_APPLOG_API | GRC API Logging | 20080311 | |||
| 2 | Instance attribute | Protected | Object reference (TYPE REF TO) | CL_GRFN_API_SESSION | Session Management for GRC APIs | 20080311 | |||
| 3 | Instance attribute | Private | Type reference (TYPE) | YT_EXTENSION | Extensions pooling | 20091021 | |||
| 4 | Static Attribute | Public | Type reference (TYPE) | SY-MSGID | 'GRFN_ENTITY_API' | Message Class | 20080311 | ||
| 5 | Instance attribute | Protected | Attribute reference (LIKE) | 20080311 |
Methods
Events
Class CL_GRFN_API_BASIS has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | YS_EXTENSION | Private | See coding | 20091021 | begin of ys_extension,
class type grfn_class_name,
extension_ref type ref to if_grfn_api_extension,
end of ys_extension
|
||
| 2 | YT_EXTENSION | Private | See coding | 20091021 | yt_extension type standard table of ys_extension with default key
|
Method Signatures
Method CHECK_APPLOG Signature
Method CHECK_APPLOG on class CL_GRFN_API_BASIS has no parameter.
Method CHECK_APPLOG on class CL_GRFN_API_BASIS has no exception.
Method CHECK_OWN_AUTH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_DATAPART | Call by reference | Type reference (TYPE) | GRFN_DATAPART | IF_GRFN_CNST_ACCESS=>DP_DATA | Data Part for GRC Object Types | 20090204 | ||
| 2 | IV_OPERATION | Call by reference | Type reference (TYPE) | GRFN_API_OPERATION_ID | Activity | 20090204 | |||
| 3 | IV_REGULATION_ID | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20090204 | |||
| 4 | RV_AUTHORIZED | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20090204 |
Method CHECK_OWN_AUTH on class CL_GRFN_API_BASIS has no exception.
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_SESSION | Value transfer | Object reference (TYPE REF TO) | CL_GRFN_API_SESSION | Session Management for GRC APIs | 20080311 | |||
| 2 | IV_OBJECT | Value transfer | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20080311 |
Method CONSTRUCTOR on class CL_GRFN_API_BASIS has no exception.
Method CREATE_EX Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_FLD | Value transfer | Type reference (TYPE) | BAPI_FLD | Field in parameter | 20080514 | |||
| 2 | IV_ID | Value transfer | Type reference (TYPE) | SY-MSGID | Message Class | 20080514 | |||
| 3 | IV_NO | Value transfer | Type reference (TYPE) | SY-MSGNO | Message Number | 20080514 | |||
| 4 | IV_TP | Value transfer | Type reference (TYPE) | SY-MSGTY | Message Type | 20080514 | |||
| 5 | IV_V1 | Value transfer | Type reference (TYPE) | ANY | 20080514 | ||||
| 6 | IV_V2 | Value transfer | Type reference (TYPE) | ANY | 20080514 | ||||
| 7 | IV_V3 | Value transfer | Type reference (TYPE) | ANY | 20080514 | ||||
| 8 | IV_V4 | Value transfer | Type reference (TYPE) | ANY | 20080514 | ||||
| 9 | RV_EX | Value transfer | Object reference (TYPE REF TO) | CX_GRFN_EXCEPTION | Generic GRC API exception | 20080514 |
Method CREATE_EX on class CL_GRFN_API_BASIS has no exception.
Method GET_BAPIRET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ID | Value transfer | Type reference (TYPE) | SY-MSGID | Message Class | 20080311 | |||
| 2 | IV_NO | Value transfer | Type reference (TYPE) | SY-MSGNO | Message Number | 20080311 | |||
| 3 | IV_TP | Value transfer | Type reference (TYPE) | SY-MSGTY | 'E' | Message Type | 20080311 | ||
| 4 | IV_V1 | Value transfer | Type reference (TYPE) | ANY | SY-MSGV1 | 20080311 | |||
| 5 | IV_V2 | Value transfer | Type reference (TYPE) | ANY | SY-MSGV2 | 20080311 | |||
| 6 | IV_V3 | Value transfer | Type reference (TYPE) | ANY | SY-MSGV3 | 20080311 | |||
| 7 | IV_V4 | Value transfer | Type reference (TYPE) | ANY | SY-MSGV4 | 20080311 | |||
| 8 | RS_BAPIRET | Value transfer | Type reference (TYPE) | BAPIRET2 | Return Parameter | 20080311 |
Method GET_BAPIRET on class CL_GRFN_API_BASIS has no exception.
Method GET_DOCUMENT_COUNT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_REGULATION_ID | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20081208 | |||
| 2 | IV_SEGMENT | Call by reference | Type reference (TYPE) | GRFN_DOCUMENT_SEGMENT | Document Segment | 20081209 | |||
| 3 | RV_DOC_COUNT | Value transfer | Type reference (TYPE) | INT4 | Natural number | 20080314 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Generic GRC API exception | 20080314 |
Method GET_DOCUMENT_LIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_OBJECT_ID | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20081202 | |||
| 2 | I_SEGMENT | Call by reference | Type reference (TYPE) | GRFN_DOCUMENT_SEGMENT | Document Segment | 20081210 | |||
| 3 | RT_DOCUMENT_LIST | Value transfer | Type reference (TYPE) | GRFN_T_API_DOCUMENT_LIST | The list of the documents | 20081202 |
Method GET_DOCUMENT_LIST on class CL_GRFN_API_BASIS has no exception.
Method GET_DOCUMENT_NAMES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_SEGMENT | Call by reference | Type reference (TYPE) | GRFN_DOCUMENT_SEGMENT | Document Segment | 20081210 | |||
| 2 | R_NAMES | Value transfer | Type reference (TYPE) | STRING | 20081202 |
Method GET_DOCUMENT_NAMES on class CL_GRFN_API_BASIS has no exception.
Method GET_MSGID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_MSGID | Value transfer | Type reference (TYPE) | SY-MSGID | Message Class | 20100702 |
Method GET_MSGID on class CL_GRFN_API_BASIS has no exception.
Method LOG_ERROR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_FLD | Value transfer | Type reference (TYPE) | BAPI_FLD | Field in parameter | 20080311 | |||
| 2 | IV_ID | Value transfer | Type reference (TYPE) | SY-MSGID | Message Class | 20080311 | |||
| 3 | IV_NO | Value transfer | Type reference (TYPE) | SY-MSGNO | Message Number | 20080311 | |||
| 4 | IV_TP | Value transfer | Type reference (TYPE) | SY-MSGTY | Message Type | 20080311 | |||
| 5 | IV_V1 | Value transfer | Type reference (TYPE) | ANY | 20080311 | ||||
| 6 | IV_V2 | Value transfer | Type reference (TYPE) | ANY | 20080311 | ||||
| 7 | IV_V3 | Value transfer | Type reference (TYPE) | ANY | 20080311 | ||||
| 8 | IV_V4 | Value transfer | Type reference (TYPE) | ANY | 20080311 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Generic GRC API exception | 20080204 |
Method LOG_EXCEPTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IX_EX | Value transfer | Object reference (TYPE REF TO) | CX_GRFN_EXCEPTION | Generic GRC API exception | 20080311 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Generic GRC API exception | 20080204 |
Method LOG_FAILURE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_MESSAGE | Value transfer | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20080414 |
Method LOG_FAILURE on class CL_GRFN_API_BASIS has no exception.
Method LOG_INFO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ID | Value transfer | Type reference (TYPE) | SY-MSGID | Message Class | 20100721 | |||
| 2 | IV_NO | Value transfer | Type reference (TYPE) | SY-MSGNO | Message Number | 20100622 | |||
| 3 | IV_V1 | Value transfer | Type reference (TYPE) | ANY | 20100622 | ||||
| 4 | IV_V2 | Value transfer | Type reference (TYPE) | ANY | 20100622 | ||||
| 5 | IV_V3 | Value transfer | Type reference (TYPE) | ANY | 20100622 | ||||
| 6 | IV_V4 | Value transfer | Type reference (TYPE) | ANY | 20100622 |
Method LOG_INFO on class CL_GRFN_API_BASIS has no exception.
Method LOG_NO_AUTHORIZATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_FLD | Value transfer | Type reference (TYPE) | BAPI_FLD | Field in parameter | 20080821 | |||
| 2 | IV_ID | Value transfer | Type reference (TYPE) | SY-MSGID | Message Class | 20080821 | |||
| 3 | IV_NO | Value transfer | Type reference (TYPE) | SY-MSGNO | Message Number | 20080821 | |||
| 4 | IV_TP | Value transfer | Type reference (TYPE) | SY-MSGTY | Message Type | 20080821 | |||
| 5 | IV_V1 | Value transfer | Type reference (TYPE) | ANY | 20080821 | ||||
| 6 | IV_V2 | Value transfer | Type reference (TYPE) | ANY | 20080821 | ||||
| 7 | IV_V3 | Value transfer | Type reference (TYPE) | ANY | 20080821 | ||||
| 8 | IV_V4 | Value transfer | Type reference (TYPE) | ANY | 20080821 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Generic GRC API exception | 20080821 |
Method LOG_START_I Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_OPERATION | Value transfer | Type reference (TYPE) | GRFN_API_OPERATION_ID | The ID of the operation | 20080311 |
Method LOG_START_I on class CL_GRFN_API_BASIS has no exception.
Method LOG_START_S Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ENTITY | Value transfer | Type reference (TYPE) | GRFN_API_ENTITY_ID | Entity ID | 20080311 | |||
| 2 | IV_OPERATION | Value transfer | Type reference (TYPE) | GRFN_API_OPERATION_ID | The ID of the operation | 20080311 |
Method LOG_START_S on class CL_GRFN_API_BASIS has no exception.
Method LOG_STOP Signature
Method LOG_STOP on class CL_GRFN_API_BASIS has no parameter.
Method LOG_STOP on class CL_GRFN_API_BASIS has no exception.
Method ROLE_ASSIGNMENT_INT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_REGULATION_ID | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20081208 | |||
| 2 | RO_RESULT | Value transfer | Object reference (TYPE REF TO) | CL_GRFN_API_ROLEASSIGNMENT | API for role assignment | 20080505 |
Method ROLE_ASSIGNMENT_INT on class CL_GRFN_API_BASIS has no exception.
Meta Relationship - Used By (full list)
History
| Last changed by/on | SAP | 20141106 |
| SAP Release Created in | 300 |