SAP ABAP Interface IF_GRFN_API_TASKPLANGROUP (Interface for planner entity APIs)
Hierarchy
GRCFND_A (Software Component) GRC Foundation ABAP
   GRC (Application Component) Governance, Risk and Compliance
     GRFN_ENTITY_API (Package) GRC Foundation API
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  CL_GRFN_API_TASKPLANGROUP Planner Entity API class 20080414
Properties
Interface IF_GRFN_API_TASKPLANGROUP  
Short Description Interface for planner entity APIs    
General Data
Package GRFN_ENTITY_API   GRC Foundation API 
Created 20080414   SAP 
Last changed 20141106    
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
# Interface Abstract Final Description Created on
1 IF_GRFN_API_BASIS Basis interface for the GRC API 20080414
Friends
Interface IF_GRFN_API_TASKPLANGROUP has no friend.
Attributes
Interface IF_GRFN_API_TASKPLANGROUP has no attribute.
Methods
# Method Level Visibility Method type Description Created on
1 AUTHORIZE Static method Public Method Check the core authorizations 20080414
2 CANCEL Static method Public Method cancel plan 20100602
3 CANCEL_JOB Static method Public Method Cancel schedule job 20100716
4 CHECK Static method Public Method (Obsolete) check for user input 20080414
5 CHECK_EXISTENCE Static method Public Method Check if plans exist for the same period, task and org 20110210
6 COPY Static method Public Method (Obsolete) 20080414
7 CREATE Static method Public Method create taskplan group 20080414
8 DELETE Static method Public Method delete a taskplan group 20080414
9 DELETE_JOB Static method Public Method delete a job instance 20100604
10 LOAD Static method Public Method get taskplan group list 20080414
11 LOAD_MONITOR Static method Public Method Load the monitor details for evaluation planner monitor 20100615
12 ORGUNIT Static method Public Method load related orgunits 20080414
13 READ_JOB_APPLOG Static method Public Method read application log for a job instance 20100818
14 RETRIEVE Static method Public Method get taskplan group detail 20080414
15 SEARCH_JOB Static method Public Method Search Job in Planner Monitor 20100517
16 SIGNOFF Static method Public Method check task plan group sign off 20080414
17 SPLIT Static method Public Method split taskplan group 20080414
18 UNLOCK Static method Public Method unlock taskplan group 20100531
19 UPDATE Static method Public Method update taskplan group 20080414
Events
Interface IF_GRFN_API_TASKPLANGROUP has no event.
Types
Interface IF_GRFN_API_TASKPLANGROUP has no local type.
Method Signatures

Method AUTHORIZE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_MESSAGE Call by reference Type reference (TYPE) BAPIRETTAB Table with BAPI Return Information 20080414
2 Exporting E_CREATE_ALLOWED Call by reference Type reference (TYPE) BOOLE_D Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20080414
3 Exporting E_DELETE_ALLOWED Call by reference Type reference (TYPE) BOOLE_D Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20080414
4 Exporting E_RETURN_CODE Call by reference Type reference (TYPE) INT4 Natural number 20080414
5 Exporting E_UPDATE_ALLOWED Call by reference Type reference (TYPE) BOOLE_D Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20080414
6 Importing IR_SESSION Call by reference Object reference (TYPE REF TO) CL_GRFN_API_SESSION Session Management for GRC APIs 20080414
7 Importing I_ENTITY_ID Call by reference Type reference (TYPE) GRFN_API_ENTITY_ID Entity ID 20080414
8 Importing I_GROUP_ID Call by reference Type reference (TYPE) GUID_32 GUID in 'CHAR' Format in Uppercase 20080414
9 Importing I_REGULATION_ID Call by reference Type reference (TYPE) GRFN_API_OBJECT_ID Object ID 20081030

Method AUTHORIZE on Interface IF_GRFN_API_TASKPLANGROUP has no exception.

Method CANCEL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_SESSION Call by reference Object reference (TYPE REF TO) CL_GRFN_API_SESSION Session Management for GRC APIs 20100602
2 Importing IV_PLANGRP_ID Call by reference Type reference (TYPE) GUID_32 GUID in 'CHAR' Format in Uppercase 20100602
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION Generic GRC API exception 20100602

Method CANCEL_JOB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_SESSION Call by reference Object reference (TYPE REF TO) CL_GRFN_API_SESSION Session Management for GRC APIs 20100716
2 Importing IV_JOB_COUNT Value transfer Type reference (TYPE) BTCJOBCNT Job ID 20100716
3 Importing IV_JOB_NAME Value transfer Type reference (TYPE) BTCJOB Background job name 20100716
4 Importing IV_PLAN_USAGE Value transfer Type reference (TYPE) GRFN_PLAN_USAGE Plan usage 20100716
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION Generic GRC API exception 20100716

Method CHECK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_MESSAGE Call by reference Type reference (TYPE) BAPIRETTAB Table with BAPI Return Information 20080414
2 Exporting E_RETURN_CODE Call by reference Type reference (TYPE) INT4 Natural number 20080414
3 Importing IR_SESSION Call by reference Object reference (TYPE REF TO) CL_GRFN_API_SESSION Session Management for GRC APIs 20080414
4 Importing IV_DUE_DATE Call by reference Type reference (TYPE) DATUM Date 20080414
5 Importing IV_START_DATE Call by reference Type reference (TYPE) DATUM Date 20080414

Method CHECK on Interface IF_GRFN_API_TASKPLANGROUP has no exception.

Method CHECK_EXISTENCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ORGUNIT Call by reference Type reference (TYPE) GRFN_API_OBJECT_ID Object ID 20110210
2 Importing IV_TASK Call by reference Type reference (TYPE) GRFN_PLAN_USAGE Plan usage 20110210
3 Importing IV_TF_YEAR Call by reference Type reference (TYPE) GRFN_TF_YEAR Timeframe Year 20110210
4 Importing IV_TIMEFRAME Call by reference Type reference (TYPE) GRFN_TIMEFRAME Timeframe 20110210
5 Returning RV_EXIST Value transfer Type reference (TYPE) GRFN_BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20110210

Method CHECK_EXISTENCE on Interface IF_GRFN_API_TASKPLANGROUP has no exception.

Method COPY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_MESSAGE Call by reference Type reference (TYPE) BAPIRETTAB Table with BAPI Return Information 20080414
2 Exporting E_GROUP_ID Call by reference Type reference (TYPE) GUID_32 GUID in 'CHAR' Format in Uppercase 20080414
3 Exporting E_RETURN_CODE Call by reference Type reference (TYPE) INT4 Natural number 20080414
4 Importing IR_SESSION Call by reference Object reference (TYPE REF TO) CL_GRFN_API_SESSION Session Management for GRC APIs 20080414
5 Importing IV_GROUP_ID Call by reference Type reference (TYPE) GUID_32 GUID in 'CHAR' Format in Uppercase 20080414

Method COPY on Interface IF_GRFN_API_TASKPLANGROUP has no exception.

Method CREATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_JOB Value transfer Type reference (TYPE) GRFN_T_JOB_IDENT Job ID 20100526
2 Exporting E_GROUP_ID Value transfer Type reference (TYPE) GUID_32 GUID in 'CHAR' Format in Uppercase 20080414
3 Importing IR_SESSION Call by reference Object reference (TYPE REF TO) CL_GRFN_API_SESSION ID of GRC session 20080414
4 Importing IS_TASKPLANGRP_ATTR Value transfer Type reference (TYPE) GRFN_S_TASKPLAN_GRP_GEN_API task plan group information 20080414
5 Importing IT_ORGUNIT Call by reference Type reference (TYPE) GRFN_T_API_OBJECT_ID table type of API object ID 20080414
6 Importing IT_ORGUNIT_RISKCONS Call by reference Type reference (TYPE) GRPC_T_ORGUNIT_HIER Orgunit hierarchy table 20110901
7 Importing IT_SHARED_REG Call by reference Type reference (TYPE) GRFN_T_PLANNER_REGULATION The internal table for planner share regulations 20100412
8 Importing IT_TASKPLAN_RCPT Call by reference Type reference (TYPE) GRFN_T_TASKPLAN_RCPT The internal table for recipient information 20100513
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION Generic GRC API exception 20100513

Method DELETE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_SESSION Call by reference Object reference (TYPE REF TO) CL_GRFN_API_SESSION ID of GRC session 20080414
2 Importing IV_GROUP_ID Call by reference Type reference (TYPE) GUID_32 GUID in 'CHAR' Format in Uppercase 20080414
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION Generic GRC API exception 20100531

Method DELETE_JOB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_SESSION Value transfer Object reference (TYPE REF TO) CL_GRFN_API_SESSION ID of GRC session 20100604
2 Importing IV_JOB_COUNT Value transfer Type reference (TYPE) BTCJOBCNT Job ID 20100604
3 Importing IV_JOB_NAME Value transfer Type reference (TYPE) BTCJOB UUID of the GRC object (char32) 20100604
4 Importing IV_PLAN_USAGE Value transfer Type reference (TYPE) GRFN_PLAN_USAGE Plan usage 20100607
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION Generic GRC API exception 20100604

Method LOAD Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_TASKPLAN_GRP Value transfer Type reference (TYPE) GRFN_T_TASKPLANGRP_OVERVIEW Table type for the orgunit list structure 20080414
2 Importing IR_SESSION Call by reference Object reference (TYPE REF TO) CL_GRFN_API_SESSION Session Management for GRC APIs 20080414
3 Importing I_COMP Value transfer Type reference (TYPE) GRFN_APP_COMPONENT Application Component 20100512
4 Importing I_ENTITY_ID Value transfer Type reference (TYPE) GRFN_API_ENTITY_ID Entity ID 20080414
5 Importing I_REGULATION_ID Value transfer Type reference (TYPE) GRFN_API_OBJECT_ID Object ID 20080904
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION Generic GRC API exception 20100513

Method LOAD_MONITOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_PLAN_MONITOR Call by reference Type reference (TYPE) GRFN_T_API_PLAN_MONITOR Plan Monitor API Table 20100617
2 Importing IO_SESSION Call by reference Object reference (TYPE REF TO) CL_GRFN_API_SESSION Session Management for GRC APIs 20100615
3 Importing IS_SEARCH_CRITERIA Call by reference Type reference (TYPE) GRFN_S_SEL_PLAN_MONITOR The structure for plan monitor selection criteria 20100621
4 Importing I_REGULATION_ID Call by reference Type reference (TYPE) GRFN_API_OBJECT_ID Object ID 20100617

Method LOAD_MONITOR on Interface IF_GRFN_API_TASKPLANGROUP has no exception.

Method ORGUNIT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_MESSAGE Call by reference Type reference (TYPE) BAPIRETTAB Table with BAPI Return Information 20080414
2 Exporting ET_ORGUNIT_LIST Call by reference Type reference (TYPE) GRFN_T_API_ORGUNIT_LIST Table type for orgunit list 20080414
3 Exporting E_ORGUNIT_SIGNOFF Call by reference Type reference (TYPE) INT4 Natural number 20080414
4 Exporting E_RETURN_CODE Call by reference Type reference (TYPE) INT4 Natural number 20080414
5 Importing IR_SESSION Call by reference Object reference (TYPE REF TO) CL_GRFN_API_SESSION Session Management for GRC APIs 20080414
6 Importing I_CERTIFICATION Call by reference Type reference (TYPE) ABAP_BOOL 20080414
7 Importing I_GROUP_ID Call by reference Type reference (TYPE) GUID_32 GUID in 'CHAR' Format in Uppercase 20080414
8 Importing I_ORGUNIT_VIEW Call by reference Type reference (TYPE) GRFN_ORG_VIEW_ID Organization View ID 20120406
9 Importing I_REGULATION_ID Call by reference Type reference (TYPE) GRFN_API_OBJECT_ID Object ID 20081014

Method ORGUNIT on Interface IF_GRFN_API_TASKPLANGROUP has no exception.

Method READ_JOB_APPLOG Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_APPLOG Call by reference Type reference (TYPE) GRFN_T_PLAN_APPLOG application log messages 20100818
2 Importing IR_SESSION Value transfer Object reference (TYPE REF TO) CL_GRFN_API_SESSION ID of GRC session 20100818
3 Importing IV_JOB_ID Value transfer Type reference (TYPE) BTCJOBCNT Job ID 20100818
4 Importing IV_PLANGRP_ID Value transfer Type reference (TYPE) GRFN_GUID UUID of the GRC object (char32) 20100818
5 Importing IV_PLAN_USAGE Value transfer Type reference (TYPE) GRFN_PLAN_USAGE Plan usage 20100818
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION Generic GRC API exception 20100818

Method RETRIEVE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_TASKPLANGRP_ATTR Call by reference Type reference (TYPE) GRFN_S_TASKPLAN_GRP_GEN_API task plan group information 20080414
2 Exporting ET_APPLOG Call by reference Type reference (TYPE) GRFN_T_PLAN_APPLOG application log messages 20100421
3 Exporting ET_MESSAGE Call by reference Type reference (TYPE) BAPIRETTAB Table with BAPI Return Information 20080414
4 Exporting ET_ORGUNIT Call by reference Type reference (TYPE) GRFN_T_API_OBJECT_ID table type of API object ID 20080414
5 Exporting ET_OU_DTLS Call by reference Type reference (TYPE) GRFN_T_API_ORGUNIT_DATA Table type for orgunit data 20080414
6 Exporting ET_OU_HIER Call by reference Type reference (TYPE) GRPC_T_ORGUNIT_HIER Orgunit hierarchy table 20080415
7 Exporting ET_SHARED_REG Call by reference Type reference (TYPE) GRFN_T_PLANNER_REGULATION The internal table for planner share regulations 20100412
8 Exporting ET_TASKPLAN_RCPT Call by reference Type reference (TYPE) GRFN_T_TASKPLAN_RCPT The internal table for recipient information 20100513
9 Exporting E_RETURN_CODE Call by reference Type reference (TYPE) INT4 Natural number 20080414
10 Importing IR_SESSION Call by reference Object reference (TYPE REF TO) CL_GRFN_API_SESSION Session Management for GRC APIs 20080414
11 Importing I_EDITABLE Call by reference Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20080414
12 Importing I_GROUP_ID Call by reference Type reference (TYPE) GUID_32 GUID in 'CHAR' Format in Uppercase 20080414
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION Generic GRC API exception 20100524

Method SEARCH_JOB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_RESULT Value transfer Type reference (TYPE) GRFN_T_API_JOB_RESULT Job result list in Scheduler Monitor 20100517
2 Importing IO_SESSION Value transfer Object reference (TYPE REF TO) CL_GRFN_API_SESSION Session Management for GRC APIs 20100517
3 Importing IS_SEARCH_CRIT Value transfer Type reference (TYPE) GRFN_S_JOB_SEARCH_CRITERIA for job search in monitor 20100517
4 Importing IV_IS_AC Value transfer Type reference (TYPE) GRFN_BOOLEAN Indicator 20111201
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION Generic GRC API exception 20100517

Method SIGNOFF Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_MESSAGE Call by reference Type reference (TYPE) BAPIRETTAB Table with BAPI Return Information 20080414
2 Exporting E_RETURN_CODE Call by reference Type reference (TYPE) INT4 Natural number 20080414
3 Importing IR_SESSION Call by reference Object reference (TYPE REF TO) CL_GRFN_API_SESSION Session Management for GRC APIs 20080414
4 Importing IV_GROUP_ID Call by reference Type reference (TYPE) GUID_32 GUID in 'CHAR' Format in Uppercase 20080414

Method SIGNOFF on Interface IF_GRFN_API_TASKPLANGROUP has no exception.

Method SPLIT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_SESSION Call by reference Object reference (TYPE REF TO) CL_GRFN_API_SESSION Session Management for GRC APIs 20080414
2 Importing IT_ORGUNIT Call by reference Type reference (TYPE) GRFN_T_API_OBJECT_ID table type of API object ID 20080414
3 Importing IV_GROUP_ID Call by reference Type reference (TYPE) GUID_32 GUID in 'CHAR' Format in Uppercase 20080414
4 Importing IV_SPLIT_METHOD Call by reference Type reference (TYPE) GRFN_PLANGROUP_SPLIT_METHOD Taskplan group split method 20080414
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION Generic GRC API exception 20100531

Method UNLOCK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_SESSION Call by reference Object reference (TYPE REF TO) CL_GRFN_API_SESSION Session Management for GRC APIs 20100531
2 Importing IV_PLANGRP_ID Call by reference Type reference (TYPE) GUID_32 GUID in 'CHAR' Format in Uppercase 20100531
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION Generic GRC API exception 20100531

Method UPDATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_SESSION Call by reference Object reference (TYPE REF TO) CL_GRFN_API_SESSION Session Management for GRC APIs 20080414
2 Importing IS_TASKPLANGRP_ATTR Value transfer Type reference (TYPE) GRFN_S_TASKPLAN_GRP_GEN_API task plan group information 20080414
3 Importing IT_ORGUNIT Call by reference Type reference (TYPE) GRFN_T_API_OBJECT_ID table type of API object ID 20080414
4 Importing IT_ORGUNIT_RISKCONS Call by reference Type reference (TYPE) GRPC_T_ORGUNIT_HIER Orgunit hierarchy table 20111020
5 Importing IT_SHARED_REG Call by reference Type reference (TYPE) GRFN_T_PLANNER_REGULATION The internal table for planner share regulations 20100412
6 Importing IT_TASKPLAN_RCPT Call by reference Type reference (TYPE) GRFN_T_TASKPLAN_RCPT The internal table for recipient information 20100513
# Exception Resumable Description Created on
1 CX_GRFN_EXCEPTION Generic GRC API exception 20100524
History
Last changed by/on SAP  20141106 
SAP Release Created in 300