SAP ABAP Class CL_GRFN_UTIL_ROLE (Authorization Services)
Hierarchy
☛
GRCFND_A (Software Component) GRC Foundation ABAP
⤷
GRC (Application Component) Governance, Risk and Compliance
⤷
GRFN_UTILITIES (Package) Various helping infrastructure for GRC ABAP
GRCFND_A (Software Component) GRC Foundation ABAP⤷
GRC (Application Component) Governance, Risk and Compliance⤷
GRFN_UTILITIES (Package) Various helping infrastructure for GRC ABAPProperties
| Class | CL_GRFN_UTIL_ROLE | |
| Short Description | Authorization Services | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | GRFN_UTILITIES | Various helping infrastructure for GRC ABAP |
| Created | 20080514 | SAP |
| Last change | 20141106 | |
| 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) |
| 2 | CL_GRFN_SHM_ROLE_ROOT |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
| 3 | GRFN0 |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_GRFN_UTIL_ROLE has no interface implemented.
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | CL_GRFN_API_SESSION | 20080717 | Session Management for GRC APIs |
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CS_ROLE_APPL_PC |
Constant | Private | Type reference (TYPE) | GRFN_ROLE_APPL | 'PC' | Role Application PC | 20100504 | |
| 2 | CS_ROLE_APPL_PCRM |
Constant | Private | Type reference (TYPE) | GRFN_ROLE_APPL | '' | Role Application PC + RM | 20100504 | |
| 3 | CS_ROLE_APPL_RM |
Constant | Private | Type reference (TYPE) | GRFN_ROLE_APPL | 'RM' | Role Application RM | 20100504 | |
| 4 | GC_AUTH_WILDCARD |
Constant | Public | Type reference (TYPE) | CHAR1 | '*' | Single-Character Flag | 20080729 | |
| 5 | GC_GENERAL_DATAPART |
Constant | Public | Type reference (TYPE) | GRFN_DATAPART | 'DATA' | General Datapart | 20081013 | |
| 6 | MC_AUTH_FIELD_ACTIVITY |
Constant | Private | Type reference (TYPE) | XUFIELD | 'ACTVT' | Authorization field for activity | 20080514 | |
| 7 | MC_AUTH_FIELD_DATAPART |
Constant | Private | Type reference (TYPE) | XUFIELD | 'GRC_DATAPT' | Authorization field for datapart | 20080514 | |
| 8 | MC_AUTH_FIELD_ENTITY |
Constant | Private | Type reference (TYPE) | XUFIELD | 'GRC_ENTITY' | Authorization field for entity | 20080514 | |
| 9 | MC_AUTH_FIELD_SUBENTITY |
Constant | Private | Type reference (TYPE) | XUFIELD | 'GRC_SUBTYP' | Authorization field for subtype | 20080626 | |
| 10 | MC_AUTH_OBJ |
Constant | Private | Type reference (TYPE) | XUOBJECT | 'GRFN_API' | Authorization Object for GRC API | 20080514 | |
| 11 | MC_CONFIG_2ND_LEVEL_AUTH |
Constant | Public | Type reference (TYPE) | GRFN_AUTH_CUST_FIELD | '2ND_LEVEL_AUTH' | Authorization Customizing Field | 20090218 | |
| 12 | MC_CONFIG_SHARED_MEMORY |
Constant | Public | Type reference (TYPE) | GRFN_AUTH_CUST_FIELD | 'SHARED_MEMORY' | Authorization Customizing Field | 20090218 | |
| 13 | MT_REP_ROLES_BUFFER |
Static Attribute | Private | Type reference (TYPE) | TH_REP_ROLES_BUFFER | 20080917 | |||
| 14 | MT_ROLES_BUFFER |
Static Attribute | Private | Type reference (TYPE) | TH_ROLES_BUFFER | List of roles | 20080514 | ||
| 15 | MT_ROLE_RETRIEVE_BUFFER |
Static Attribute | Private | Type reference (TYPE) | TH_ROLE_RETRIEVE_BUFFER | 20081125 | |||
| 16 | MT_SHM_BUFFER |
Static Attribute | Private | Type reference (TYPE) | CL_GRFN_SHM_ROLE_ROOT=>YT_ROLE_BUFFER | 20090114 | |||
| 17 | MT_SHM_BUFFER_REP |
Static Attribute | Private | Type reference (TYPE) | CL_GRFN_SHM_ROLE_ROOT=>YT_ROLE_BUFFER_REP | 20100721 | |||
| 18 | M_SHM_BUFFER_LOADED |
Static Attribute | Private | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20090217 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | AUTH_CUST_CHECK |
Static method | Public | Method | Checks global 2nd level auth switch | 20090218 |
| 2 | CHECK_SHARED_MEMORY |
Static method | Private | Method | 20090114 | |
| 3 | GET_ACTIVITIES |
Static method | Public | Method | Returns all known activities for authorization | 20080514 |
| 4 | GET_AUTHORIZATION |
Static method | Public | Method | Returns details for a certain role | 20090223 |
| 5 | GET_DATAPARTS |
Static method | Public | Method | Return all dataparts (for a certain entity_id) | 20080530 |
| 6 | GET_RELEVANT_ROLES |
Static method | Public | Method | Returns all relevant roles (for an entity type) | 20080514 |
| 7 | GET_ROLES_CUST |
Static method | Public | Method | Read roles customizing | 20111024 |
| 8 | GET_ROLE_REGULATION |
Static method | Public | Method | Returns all regulations for a role | 20090219 |
| 9 | GET_USER_REGULATION |
Static method | Public | Method | Get user related regulation | 20120412 |
| 10 | GET_USER_ROLES |
Static method | Public | Method | Get user assigned roles | 20120412 |
| 11 | QUERY_REPORTING_ROLES |
Static method | Public | Method | Query for existing roles using auth object GRFN_REP | 20080917 |
| 12 | QUERY_ROLES |
Static method | Public | Method | Query for existing roles using auth object GRFN_API | 20080514 |
| 13 | RETRIEVE_ROLE |
Static method | Public | Method | Returns details for a certain role | 20080514 |
| 14 | RETRIEVE_ROLE_DESCR |
Static method | Public | Method | 20110817 |
Events
Class CL_GRFN_UTIL_ROLE has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | S_REP_ROLES_BUFFER | Private | See coding | 20080917 | begin of s_rep_roles_buffer,
activity type activ_auth,
report type grfn_repname,
t_roles type grfn_t_role,
end of s_rep_roles_buffer
|
||
| 2 | S_ROLES_BUFFER | Private | See coding | 20080514 | begin of s_roles_buffer,
entity type grfn_api_entity_id,
subentity type grfn_subentity,
datapart type grfn_datapart,
activity type activ_auth,
t_roles type agr_tt_name,
end of s_roles_buffer
|
||
| 3 | S_ROLE_RETRIEVE_BUFFER | Private | See coding | 20081125 | begin of s_role_retrieve_buffer,
role type agr_name,
txt_loaded type abap_bool,
txt type agr_title,
stmp_loaded type abap_bool,
stmp type timestamp,
auth_loaded type abap_bool,
auth type grfn_t_authorization,
end of s_role_retrieve_buffer
|
||
| 4 | TH_REP_ROLES_BUFFER | Private | See coding | 20080917 | th_rep_roles_buffer type hashed table of s_rep_roles_buffer with unique key activity report
|
||
| 5 | TH_ROLES_BUFFER | Private | See coding | 20080514 | th_roles_buffer type hashed table of s_roles_buffer with unique key entity subentity datapart activity
|
||
| 6 | TH_ROLE_RETRIEVE_BUFFER | Private | See coding | 20081125 | th_role_retrieve_buffer type hashed table of s_role_retrieve_buffer with unique key role
|
||
| 7 | YS_ACTIVITY_DETAIL | Public | See coding | 20081030 | begin of ys_activity_detail,
activity type activ_auth,
descr type xutxt30,
end of ys_activity_detail
|
||
| 8 | YT_ACTIVITY | Public | See coding | 20081030 | yt_activity type table of activ_auth
|
||
| 9 | YT_ACTIVITY_DETAIL | Public | See coding | 20081030 | yt_activity_detail type table of ys_activity_detail
|
Method Signatures
Method AUTH_CUST_CHECK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IV_ATTRIBUTE | Value transfer | Type reference (TYPE) | GRFN_AUTH_CUST_FIELD | Authorization Customizing Field | 20090218 | ||
| 2 |  Returning |
RV_CHECK | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20090218 |
Method AUTH_CUST_CHECK on class CL_GRFN_UTIL_ROLE has no exception.
Method CHECK_SHARED_MEMORY Signature
Method CHECK_SHARED_MEMORY on class CL_GRFN_UTIL_ROLE has no parameter.
Method CHECK_SHARED_MEMORY on class CL_GRFN_UTIL_ROLE has no exception.
Method GET_ACTIVITIES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_ACTIVITY | Call by reference | Type reference (TYPE) | YT_ACTIVITY | 20080514 | |||
| 2 | Exporting |
ET_ACTIVITY_DETAIL | Call by reference | Type reference (TYPE) | YT_ACTIVITY_DETAIL | 20081030 |
Method GET_ACTIVITIES on class CL_GRFN_UTIL_ROLE has no exception.
Method GET_AUTHORIZATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ROLE | Call by reference | Type reference (TYPE) | AGR_NAME | Role Name | 20090223 | ||
| 2 | Returning |
RT_AUTHORIZATION | Value transfer | Type reference (TYPE) | GRFN_T_AUTHORIZATION | Authorizations for GRC API | 20090223 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_GRFN_EXCEPTION |
Generic GRC API exception | 20090223 |
Method GET_DATAPARTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ENTITY | Call by reference | Type reference (TYPE) | GRFN_API_ENTITY_ID | Entity ID | 20080530 | ||
| 2 | Returning |
RT_DATAPART | Value transfer | Type reference (TYPE) | GRFN_T_DATAPART | Table of dataparts | 20080530 |
Method GET_DATAPARTS on class CL_GRFN_UTIL_ROLE has no exception.
Method GET_RELEVANT_ROLES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ENTITY_ID | Call by reference | Type reference (TYPE) | GRFN_API_ENTITY_ID | Entity ID | 20080514 | ||
| 2 | Importing |
IV_IGNORE_REG_RELEVANCE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Ignore regulation relevance | 20100504 | |
| 3 | Importing |
IV_NO_TEXT | Value transfer | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Skip loading of text | 20090407 | |
| 4 | Importing |
IV_OBJECT_ID | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20080714 | ||
| 5 | Importing |
IV_PATTERN | Call by reference | Type reference (TYPE) | GRFN_API_SEARCH_PATTERN | API search pattern | 20081023 | ||
| 6 | Importing |
IV_REGULATION_ID | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | Regulation Type | 20100504 | ||
| 7 | Returning |
RT_ENTITY_ROLES | Value transfer | Type reference (TYPE) | GRFN_T_ENTITY_ROLE | Table of entity - role relationships | 20080514 |
Method GET_RELEVANT_ROLES on class CL_GRFN_UTIL_ROLE has no exception.
Method GET_ROLES_CUST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ENTITY_ID | Call by reference | Type reference (TYPE) | GRFN_API_ENTITY_ID | Entity ID | 20111024 | ||
| 2 | Importing |
IV_OBJECT_ID | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20111024 | ||
| 3 | Importing |
IV_REGULATION_ID | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | Regulation Type | 20111024 | ||
| 4 | Returning |
RT_ENTITY_ROLES | Value transfer | Type reference (TYPE) | GRFN_T_ENTITY_ROLE | Table of entity - role relationships | 20111024 |
Method GET_ROLES_CUST on class CL_GRFN_UTIL_ROLE has no exception.
Method GET_ROLE_REGULATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_ROLE_REGULATION | Call by reference | Type reference (TYPE) | GRFN_T_ROLE_REGULATION | Role Regulations | 20090219 | ||
| 2 | Importing |
IV_ENTITY | Call by reference | Type reference (TYPE) | GRFN_API_ENTITY_ID | Entity ID | 20090219 | ||
| 3 | Importing |
IV_ROLE | Call by reference | Type reference (TYPE) | AGR_NAME | Role Name | 20090219 |
Method GET_ROLE_REGULATION on class CL_GRFN_UTIL_ROLE has no exception.
Method GET_USER_REGULATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_REGULATION | Call by reference | Type reference (TYPE) | GRFN_T_ROLE_REGULATION | Role Regulations | 20120503 | ||
| 2 | Exporting |
EV_CROSS_REGULATION | Call by reference | Type reference (TYPE) | BOOLEAN | Boolean Variable (X=True, -=False, Space=Unknown) | 20120503 | ||
| 3 | Importing |
IV_BEGDA | Call by reference | Type reference (TYPE) | BEGDA | SY-DATUM | Start Date | 20120412 | |
| 4 | Importing |
IV_ENDDA | Call by reference | Type reference (TYPE) | ENDDA | SY-DATUM | End Date | 20120412 | |
| 5 | Importing |
IV_UNAME | Call by reference | Type reference (TYPE) | UNAME | SY-UNAME | User Name | 20120412 |
Method GET_USER_REGULATION on class CL_GRFN_UTIL_ROLE has no exception.
Method GET_USER_ROLES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_BEGDA | Call by reference | Type reference (TYPE) | BEGDA | SY-DATUM | Start Date | 20120412 | |
| 2 | Importing |
IV_ENDDA | Call by reference | Type reference (TYPE) | ENDDA | SY-DATUM | End Date | 20120412 | |
| 3 | Importing |
IV_UNAME | Call by reference | Type reference (TYPE) | UNAME | SY-UNAME | User Name | 20120412 | |
| 4 | Returning |
RT_ROLE | Value transfer | Type reference (TYPE) | RSRA_T_ROLE | Table of Roles | 20120412 |
Method GET_USER_ROLES on class CL_GRFN_UTIL_ROLE has no exception.
Method QUERY_REPORTING_ROLES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ACTIVITY | Call by reference | Type reference (TYPE) | ACTIV_AUTH | Activity | 20080917 | ||
| 2 | Importing |
IV_REPORT | Call by reference | Type reference (TYPE) | GRFN_REPNAME | Report name | 20090127 | ||
| 3 | Returning |
RT_ROLES | Value transfer | Type reference (TYPE) | AGR_TT_NAME | List of roles | 20080917 |
Method QUERY_REPORTING_ROLES on class CL_GRFN_UTIL_ROLE has no exception.
Method QUERY_ROLES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ACTIVITY | Call by reference | Type reference (TYPE) | ACTIV_AUTH | Activity | 20080514 | ||
| 2 | Importing |
IV_DATAPART | Call by reference | Type reference (TYPE) | GRFN_DATAPART | Data Part for GRC Object Types | 20080514 | ||
| 3 | Importing |
IV_ENTITY | Call by reference | Type reference (TYPE) | GRFN_API_ENTITY_ID | Entity ID | 20080514 | ||
| 4 | Importing |
IV_SUBENTITY | Call by reference | Type reference (TYPE) | GRFN_SUBENTITY | Subentity | 20080626 | ||
| 5 | Returning |
RT_ROLES | Value transfer | Type reference (TYPE) | GRFN_T_ROLE | List of roles | 20080514 |
Method QUERY_ROLES on class CL_GRFN_UTIL_ROLE has no exception.
Method RETRIEVE_ROLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_AUTHORIZATION | Call by reference | Type reference (TYPE) | GRFN_T_AUTHORIZATION | Authorizations for GRC API | 20080606 | ||
| 2 | Exporting |
ET_MESSAGE | Call by reference | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20090805 | ||
| 3 | Exporting |
EV_TEXT | Call by reference | Type reference (TYPE) | AGR_TITLE | Role name | 20080606 | ||
| 4 | Exporting |
EV_TIMESTAMP | Value transfer | Type reference (TYPE) | TIMESTAMP | UTC Time Stamp in Short Form (YYYYMMDDhhmmss) | 20090128 | ||
| 5 | Importing |
IV_ROLE | Call by reference | Type reference (TYPE) | AGR_NAME | Role Name | 20080514 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20080514 |
Method RETRIEVE_ROLE_DESCR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ROLE | Call by reference | Type reference (TYPE) | AGR_NAME | Role Name | 20110817 | ||
| 2 | Returning |
RV_DESCR | Value transfer | Type reference (TYPE) | STRING | 20110817 |
Method RETRIEVE_ROLE_DESCR on class CL_GRFN_UTIL_ROLE has no exception.
History
| Last changed by/on | SAP | 20141106 |
| SAP Release Created in | 300 |
