SAP ABAP Interface IF_OAF_AGENT_CONTROLLER (Agenten Framework: Controller)
Hierarchy
☛
SAP_ABA (Software Component) Cross-Application Component
⤷
FS-FND-AF (Application Component) Agent Framework
⤷
FS_OAF_CORE (Package) Core of the OAF
SAP_ABA (Software Component) Cross-Application Component⤷
FS-FND-AF (Application Component) Agent Framework⤷
FS_OAF_CORE (Package) Core of the OAF
Properties
| Interface | IF_OAF_AGENT_CONTROLLER | |
| Short Description | Agenten Framework: Controller |
General Data
| Package | FS_OAF_CORE | Core of the OAF |
| Created | 20080211 | SAP |
| Last changed | 20130531 | SAP |
| 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_OAF_AGENT_DLG | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
Interface IF_OAF_AGENT_CONTROLLER has no interface.
Friends
Interface IF_OAF_AGENT_CONTROLLER has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_EXPOBJ_IMPERFECTLY | Constant | Public | Type reference (TYPE) | OAF_AGENT_EXPOBJ_STATUS | 'I' | 20081014 | ||
| 2 | GC_EXPOBJ_LOCKED | Constant | Public | Type reference (TYPE) | OAF_AGENT_EXPOBJ_STATUS | 'L' | 20081017 | ||
| 3 | GC_EXPOBJ_PROCESSED | Constant | Public | Type reference (TYPE) | OAF_AGENT_EXPOBJ_STATUS | 'P' | 20081014 | ||
| 4 | GC_EXPOBJ_SKIPPED | Constant | Public | Type reference (TYPE) | OAF_AGENT_EXPOBJ_STATUS | 'S' | 20081017 | ||
| 5 | GC_EXPOBJ_UNPROCESSED | Constant | Public | Type reference (TYPE) | OAF_AGENT_EXPOBJ_STATUS | 'U' | 20081014 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | FREE |
Instance method | Public | Method | 20080625 | |
| 2 | GET_STATUS_EXPOBJS |
Instance method | Public | Method | 20081014 | |
| 3 | PROCESS_AGENTS |
Instance method | Public | Method | 20080320 | |
| 4 | SELECT_PACKAGE_BY_EXPOBJS |
Instance method | Public | Method | 20081014 | |
| 5 | SELECT_PACKAGE_BY_NO |
Instance method | Public | Method | 20081014 | |
| 6 | SET_AGENTS |
Instance method | Public | Method | 20080328 | |
| 7 | SET_PROCESS_PARAMETER |
Instance method | Public | Method | 20080326 |
Events
Interface IF_OAF_AGENT_CONTROLLER has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TS_EXPOBJ | Public | Type reference (TYPE) | IF_CNS_HB_EXTRACTOR=>TY_S_EXPOBJ | 20081106 | |
|
| 2 | TS_EXPOBJ_STATUS | Public | See coding | 20081014 | BEGIN OF ts_expobj_status,
appl_id TYPE cns_dte_appl_id,
expobjtype TYPE cns_dte_expobjtype,
expobjkey TYPE cns_dte_expobjkey,
status TYPE oaf_agent_expobj_status,
END OF ts_expobj_status
|
||
| 3 | TT_EXPOBJ | Public | Type reference (TYPE) | IF_CNS_HB_EXTRACTOR=>TY_T_EXPOBJ | 20081106 | |
|
| 4 | TT_EXPOBJ_STATUS | Public | See coding | 20081014 | tt_expobj_status TYPE STANDARD TABLE OF ts_expobj_status WITH DEFAULT KEY
|
Method Signatures
Method FREE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IO_AGENT_LOG | Call by reference | Object reference (TYPE REF TO) | IF_OAF_AGENT_LOG | CL_OAF_AGENT_DLG=>GO_NULL | Logging Interface des Agenten Frameworks | 20080626 |
Method FREE on Interface IF_OAF_AGENT_CONTROLLER has no exception.
Method GET_STATUS_EXPOBJS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_AGENT_LOG | Call by reference | Object reference (TYPE REF TO) | IF_OAF_AGENT_LOG | CL_OAF_AGENT_DLG=>GO_NULL | Logging Interface des Agenten Frameworks | 20081015 | |
| 2 |  Returning |
RT_EXPOBJ_STATUS | Value transfer | Type reference (TYPE) | TT_EXPOBJ_STATUS | Tablle mit Status der Exportobjkte | 20081014 |
Method GET_STATUS_EXPOBJS on Interface IF_OAF_AGENT_CONTROLLER has no exception.
Method PROCESS_AGENTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_AGENT_LOG | Call by reference | Object reference (TYPE REF TO) | IF_OAF_AGENT_LOG | CL_OAF_AGENT_DLG=>GO_NULL | Logging Interface des Agenten Frameworks | 20080320 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_OAF_NO_CNS_EXTRACTOR_FOUND |
kein Extraktor vorhandenr | 20080416 |
Method SELECT_PACKAGE_BY_EXPOBJS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_AGENT_LOG | Call by reference | Object reference (TYPE REF TO) | IF_OAF_AGENT_LOG | CL_OAF_AGENT_DLG=>GO_NULL | Logging Interface des Agenten Frameworks | 20081014 | |
| 2 | Importing |
IT_EXPOBJ | Call by reference | Type reference (TYPE) | TT_EXPOBJ | Tabelle mit Schlüsseln für Exportobjekte | 20081106 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_OAF_NO_CNS_EXTRACTOR_FOUND |
kein Extraktor vorhandenr | 20081014 |
Method SELECT_PACKAGE_BY_NO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_AGENT_LOG | Call by reference | Object reference (TYPE REF TO) | IF_OAF_AGENT_LOG | CL_OAF_AGENT_DLG=>GO_NULL | Logging Interface des Agenten Frameworks | 20081014 | |
| 2 | Importing |
IV_PACKAGE_NO | Call by reference | Type reference (TYPE) | OAF_AGENT_PACKAGE_NO | 1 | Nummer eines Paketes des Arbeitsvorrates | 20081014 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_OAF_NO_CNS_EXTRACTOR_FOUND |
kein Extraktor vorhandenr | 20081014 |
Method SET_AGENTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_AGENT_LOG | Call by reference | Object reference (TYPE REF TO) | IF_OAF_AGENT_LOG | CL_OAF_AGENT_DLG=>GO_NULL | Logging Interface des Agenten Frameworks | 20080409 | |
| 2 | Importing |
ITR_AGENT | Call by reference | Type reference (TYPE) | OAF_TR_AGENT | Agenten von bis | 20080328 | ||
| 3 | Importing |
IV_ADD_SEL | Call by reference | Type reference (TYPE) | CNS_DTE_ADD_SEL | Anwendungsspezifisches Selektionsfeld | 20081014 | ||
| 4 | Importing |
IV_CREATED_OBJECTS_ONLY | Call by reference | Type reference (TYPE) | OAF_AGENT_CREATED_OBJECTS_ONLY | ABAP_FALSE | Nur neu erzeugte Exportobjekte lesen | 20120216 | |
| 5 | Importing |
IV_PACKAGE_COUNT | Call by reference | Type reference (TYPE) | OAF_AGENT_PACKAGES_COUNT | 1 | Paketanzahl | 20081010 | |
| 6 | Importing |
IV_TO_CREATED_ON | Call by reference | Type reference (TYPE) | CNS_DTE_TIMST_CREATED_ON | bis zum Erstellungszeitpunkt lesen | 20110803 | ||
| 7 | Returning |
RV_FLG_NO_AGENTS_SPECIFIED | Value transfer | Type reference (TYPE) | ABAP_BOOL | Keine aktiven Agenten vorhanden nein/ja | 20080409 |
Method SET_AGENTS on Interface IF_OAF_AGENT_CONTROLLER has no exception.
Method SET_PROCESS_PARAMETER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_AGENT_LOG | Call by reference | Object reference (TYPE REF TO) | IF_OAF_AGENT_LOG | CL_OAF_AGENT_DLG=>GO_NULL | Logging Interface des Agenten Frameworks | 20080624 | |
| 2 | Importing |
IV_FLG_MAINTAIN_STATUS | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Status soll gepflegt werden | 20081016 | |
| 3 | Importing |
IV_FLG_REALTIME | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | sofortige Verarbeitung nein/ja | 20080410 | |
| 4 | Importing |
IV_FLG_SIMULATION_RUN | Call by reference | Type reference (TYPE) | OAF_AGENT_SIMULATION_RUN | ABAP_TRUE | Prozess simulieren | 20090422 | |
| 5 | Importing |
IV_FLG_TRACE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Detailierte Infos zum Ablauf ins Protokoll schreiben | 20080624 | |
| 6 | Importing |
IV_FLG_UPDATE_TASK | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Verbuchung nein/ja | 20080409 | |
| 7 | Importing |
IV_OBJS_PER_COMMIT | Call by reference | Type reference (TYPE) | OAF_AGENT_OBJ_PER_COMMIT | Anzahl Objekte pro Commit Work | 20080326 |
Method SET_PROCESS_PARAMETER on Interface IF_OAF_AGENT_CONTROLLER has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 300 |
