SAP ABAP Interface IF_GRFN_API_AM_JOB (AM - Job)
Hierarchy
☛
GRCFND_A (Software Component) GRC Foundation ABAP
⤷
GRC (Application Component) Governance, Risk and Compliance
⤷
GRFN_ENTITY_API (Package) GRC Foundation API
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_AM_JOB | AM Job Entity | 20100527 |
Properties
| Interface | IF_GRFN_API_AM_JOB | |
| Short Description | AM - Job |
General Data
| Package | GRFN_ENTITY_API | GRC Foundation API |
| Created | 20100527 | 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 IF_GRFN_API_AM_JOB has no interface.
Friends
Interface IF_GRFN_API_AM_JOB has no friend.
Attributes
Interface IF_GRFN_API_AM_JOB has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ACTION_ALLOWED |
Instance method | Public | Method | Whether the actions are allowed | 20100622 |
| 2 | ACTION_CANCEL |
Instance method | Public | Method | Cancel this Job | 20100622 |
| 3 | CREATE |
Static method | Public | Method | Job Create | 20100616 |
| 4 | QUERY |
Static method | Public | Method | Job query | 20100527 |
| 5 | RETRIEVE |
Instance method | Public | Method | Job Retrieve | 20100527 |
| 6 | UPDATE |
Instance method | Public | Method | Job Update | 20100527 |
Events
Interface IF_GRFN_API_AM_JOB has no event.
Types
Interface IF_GRFN_API_AM_JOB has no local type.
Method Signatures
Method ACTION_ALLOWED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
EV_ALLOW_CANCEL | Call by reference | Type reference (TYPE) | BOOLEAN | Boolean Variable (X=True, Space=False) | 20100622 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100623 |
Method ACTION_CANCEL Signature
Method ACTION_CANCEL on Interface IF_GRFN_API_AM_JOB has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100622 |
Method CREATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IO_SESSION | Call by reference | Object reference (TYPE REF TO) | CL_GRFN_API_SESSION | Session Management for GRC APIs | 20100616 | ||
| 2 | Importing |
IS_JOB | Call by reference | Type reference (TYPE) | GRFN_S_API_JOB | AMF - Job | 20100616 | ||
| 3 | Importing |
IT_JOB_SHARED_REG | Call by reference | Type reference (TYPE) | GRFN_T_API_OBJECT_ID | Job Shared Regulations | 20100616 | ||
| 4 |  Returning |
RV_JOB_ID | Value transfer | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20100616 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100616 |
Method QUERY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_JOB | Call by reference | Type reference (TYPE) | GRFN_T_API_JOB | Job list | 20100527 | ||
| 2 | Exporting |
ET_JOBSTEP_COUNT | Call by reference | Type reference (TYPE) | GRFN_T_JOBSTEP_COUNT | Job Step Count | 20100826 | ||
| 3 | Importing |
IO_SESSION | Call by reference | Object reference (TYPE REF TO) | CL_GRFN_API_SESSION | Session Management for GRC APIs | 20100527 | ||
| 4 | Importing |
IT_STATUS | Call by reference | Type reference (TYPE) | GRFN_T_JOBSTATUS | Job Status | 20100622 | ||
| 5 | Importing |
IV_BR_ID | Call by reference | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20120810 | ||
| 6 | Importing |
IV_EXEC_TYPE | Call by reference | Type reference (TYPE) | GRFN_JOBEXECTYPE | Job: Execution type (X/D/E/S/B) | 20100622 | ||
| 7 | Importing |
IV_FREQUENCY | Call by reference | Type reference (TYPE) | GRFN_TF_FREQUENCY | Timeframe Frequency | 20100528 | ||
| 8 | Importing |
IV_JOBNAME | Call by reference | Type reference (TYPE) | BTCJOB | Background job name | 20100527 | ||
| 9 | Importing |
IV_JOB_TYPE | Call by reference | Type reference (TYPE) | GRFN_JOBTYPE | Job Type | 20100622 | ||
| 10 | Importing |
IV_MAXROWS | Call by reference | Type reference (TYPE) | GRFN_MAXROWS | 50 | Job Max Rows | 20100527 | |
| 11 | Importing |
IV_TARGET_CONNECTOR | Call by reference | Type reference (TYPE) | GRFN_CONNECTORID | Target Connector Id | 20100622 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100528 |
Method RETRIEVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ES_JOB | Call by reference | Type reference (TYPE) | GRFN_S_API_JOB | Job | 20100527 | ||
| 2 | Exporting |
ES_JOBSTEP_COUNT | Call by reference | Type reference (TYPE) | GRFN_S_JOBSTEP_COUNT | Job Step Counter | 20100826 | ||
| 3 | Exporting |
ET_JOBSTEP_ID | Call by reference | Type reference (TYPE) | GRFN_T_API_OBJECT_ID | Job Step Object ID table | 20100607 | ||
| 4 | Exporting |
ET_SHARED_REG | Call by reference | Type reference (TYPE) | GRFN_T_API_OBJECT_ID | Job Step Regulation Sharing | 20100603 | ||
| 5 | Importing |
IV_EDITABLE | Call by reference | Type reference (TYPE) | GRFN_BOOLEAN | ABAP_FALSE | Boolean | 20100527 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100617 |
Method UPDATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_CHANGED | Call by reference | Type reference (TYPE) | GRFN_S_JOBCHANGED | Job Changed | 20100529 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100527 |
History
| Last changed by/on | SAP | 20141106 |
| SAP Release Created in | 600 |
