SAP ABAP Class CL_GHO_ALLOC_API (Class for Allocation-Related APIs)
Hierarchy
☛
SAP_APPL (Software Component) Logistics and Accounting
⤷
PP-PN-ALN (Application Component) Production Allocation
⤷
APPL_GHO_ALLOC_BE (Package) Backend Logic for Allocation
SAP_APPL (Software Component) Logistics and Accounting⤷
PP-PN-ALN (Application Component) Production Allocation⤷
APPL_GHO_ALLOC_BE (Package) Backend Logic for AllocationProperties
| Class | CL_GHO_ALLOC_API | |
| Short Description | Class for Allocation-Related APIs | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | APPL_GHO_ALLOC_BE | Backend Logic for Allocation |
| Created | 20091109 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CL_GHO_ALLOC_API has no forward declaration.
Interfaces
Class CL_GHO_ALLOC_API has no interface implemented.
Friends
Class CL_GHO_ALLOC_API has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GS_SOURCE_HEADER |
Static Attribute | Public | Type reference (TYPE) | GHO_S_ALLOC_HEADER | Header for Allocation | 20111116 | ||
| 2 | GT_SOURCE_RESULTS |
Static Attribute | Public | Type reference (TYPE) | GHO_T_SOURCE_RESULT | Table type to store allocation source results | 20110930 | ||
| 3 | MO_DB |
Static Attribute | Private | Object reference (TYPE REF TO) | CL_GHO_ALLOC_DB | DB layer | 20100820 | ||
| 4 | MO_DB_NETOBJ |
Static Attribute | Private | Object reference (TYPE REF TO) | CL_GHO_DB_NETOBJ | Buffer Class for Network Objects | 20100825 | ||
| 5 | MV_LOG_HANDLE |
Static Attribute | Private | Type reference (TYPE) | BALLOGHNDL | Application Log: Log Handle | 20100907 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CALC_INTRA_PERIOD_QTY |
Instance method | Public | Method | Calculate intra-period quantity for nodes/wc | 20110123 |
| 2 | FETCH_DATE_ON_FREQUENCY |
Static method | Public | Method | Fetch the previous date from the frequency set | 20100907 |
| 3 | FETCH_INTRMNTH_STRUC_CHANGES |
Instance method | Public | Method | To fetch intra month Structural changes | 20110127 |
| 4 | GET_ALLOCATION_DETAILS |
Static method | Public | Method | Get allocation details for given node rule,NW rule,etc | 20100922 |
| 5 | GET_ALLOC_DATE_DETAILS |
Static method | Public | Method | Get allocation date details for given nodes (API for NWM) | 20100817 |
| 6 | GET_ALLOC_RULES_FOR_NW_NODES |
Static method | Public | Method | Get allocation rules for given nw nodes. | 20100820 |
| 7 | GET_MEDIUM_FOR_NETWORK |
Static method | Public | Method | Fetch medium for network from object links | 20091113 |
| 8 | GET_MRH_RULE_DETAILS |
Static method | Public | Method | Get all the details related to MRH (API for GIS) | 20101129 |
| 9 | GET_PN_OBJLINK_STATUS |
Static method | Public | Method | Get the network object link status (API for PNM) | 20091216 |
| 10 | GET_PP_ALLOC_RUN_ID |
Static method | Public | Method | Fetch allocation run id's for batch run id (API for PP) | 20091116 |
| 11 | GET_QTY_CATEGORY |
Static method | Public | Method | Get quantity category information | 20091109 |
| 12 | GET_WC_ESTIMATED_PRODUCTION |
Static method | Public | Method | Get all well completion estimated quantity (Ownership API) | 20101224 |
| 13 | GET_WORKBENCH_STATUS |
Static method | Public | Method | Get the status for allocation workbench | 20091109 |
| 14 | READ_ALLOC_FACTORS |
Static method | Public | Method | Read allocation source results (API for allocation) | 20110215 |
| 15 | READ_OBJLINK_RESULTS |
Static method | Public | Method | Read allocatio PP results (API for allocation) | 20091116 |
| 16 | READ_PP_ALLOC_RESULTS |
Static method | Public | Method | Read PP related allocation results (API for PP) | 20091113 |
| 17 | READ_PP_ALLOC_STATUS |
Static method | Public | Method | Read the allocation run status (API for PP) | 20091113 |
| 18 | READ_SOURCE_RESULTS |
Static method | Public | Method | Read allocation source results (API for allocation) | 20091116 |
| 19 | SET_PPN_INDICATOR |
Static method | Public | Method | Set PPN indicator | 20100922 |
| 20 | SET_PP_OBJ_LINK_STATUS |
Static method | Public | Method | Mark the object link as processed (API for PP) | 20091113 |
| 21 | TRIGGER_ALLOC_RUN |
Static method | Public | Method | Trigger allocation run | 20091113 |
| 22 | TRIGGER_RECEIVE_ALLOC_RESULTS |
Static method | Public | Method | Trigger and receive allocation results | 20100914 |
Events
Class CL_GHO_ALLOC_API has no event.
Types
Class CL_GHO_ALLOC_API has no local type.
Method Signatures
Method CALC_INTRA_PERIOD_QTY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IS_ALLOC_HEADER | Call by reference | Type reference (TYPE) | GHO_S_ALLOC_HEADER | Header for Allocation | 20110123 | ||
| 2 | Importing |
IT_LINKS | Call by reference | Type reference (TYPE) | GHO_T_LINK | Table of Object Links | 20110123 | ||
| 3 | Importing |
IT_NW_STR | Call by reference | Type reference (TYPE) | GHO_T_NW_STR | Network Table used for allocation | 20110123 | ||
| 4 | Importing |
IT_OBJECTS | Call by reference | Type reference (TYPE) | GHO_T_OBJECT | Table of Network Objects | 20110123 | ||
| 5 | Importing |
IV_FROM_TSTMP | Call by reference | Type reference (TYPE) | TIMESTAMP | UTC Time Stamp in Short Form (YYYYMMDDhhmmss) | 20110123 | ||
| 6 | Importing |
IV_TO_TSTMP | Call by reference | Type reference (TYPE) | TIMESTAMP | UTC Time Stamp in Short Form (YYYYMMDDhhmmss) | 20110123 | ||
| 7 |  Changing |
XT_QUANTITY | Call by reference | Type reference (TYPE) | GHO_T_NODE_QUANTITY | Table Type for Node Quanities | 20110123 | ||
| 8 | Changing |
XT_RESULT | Call by reference | Type reference (TYPE) | GHO_T_ALLOC_RES_I_ITEMIZED | Table type for structure GHO_S_ALLOC_RES_I_ITEMIZED | 20110123 |
Method CALC_INTRA_PERIOD_QTY on class CL_GHO_ALLOC_API has no exception.
Method FETCH_DATE_ON_FREQUENCY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
EV_DATE | Call by reference | Type reference (TYPE) | DATS | Field of type DATS | 20100907 | ||
| 2 | Exporting |
EV_TIME | Call by reference | Type reference (TYPE) | TIMS | Field of type TIMS | 20100907 | ||
| 3 | Importing |
IS_ALLOC_HEADER | Call by reference | Type reference (TYPE) | GHO_S_ALLOC_HEADER | Header for Allocation | 20100907 |
Method FETCH_DATE_ON_FREQUENCY on class CL_GHO_ALLOC_API has no exception.
Method FETCH_INTRMNTH_STRUC_CHANGES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_ALLOC_INTRMNTH_DATA | Call by reference | Type reference (TYPE) | GHO_T_ALLOC_INTRMNTH_NW_CHANGE | Intra month changes for production network | 20110127 | ||
| 2 | Importing |
IT_INET_LOG | Call by reference | Type reference (TYPE) | GHO_INET_LOG_TT | Table type for table GHO_INET_LOG | 20110127 | ||
| 3 | Importing |
IT_LINKS | Call by reference | Type reference (TYPE) | GHO_T_LINK | Table of Object Links | 20110128 | ||
| 4 | Importing |
IT_OBJECTS | Call by reference | Type reference (TYPE) | GHO_T_OBJECT | Table of Network Objects | 20110128 | ||
| 5 | Importing |
IV_ALLOC_ENDDATE_TS | Call by reference | Type reference (TYPE) | TIMESTAMP | UTC Time Stamp in Short Form (YYYYMMDDhhmmss) | 20110127 | ||
| 6 | Importing |
IV_ALLOC_STARTDATE_TS | Call by reference | Type reference (TYPE) | TIMESTAMP | UTC Time Stamp in Short Form (YYYYMMDDhhmmss) | 20110127 | ||
| 7 | Importing |
IV_TIMEZONE | Call by reference | Type reference (TYPE) | SY-ZONLO | Time Zone of Current User | 20110127 |
Method FETCH_INTRMNTH_STRUC_CHANGES on class CL_GHO_ALLOC_API has no exception.
Method GET_ALLOCATION_DETAILS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_RES_HDR | Call by reference | Type reference (TYPE) | GHO_T_ALLOC_RESULT_H | Table type to hold allocation result header information | 20100922 | ||
| 2 | Importing |
IV_ALLOC_PURPOSE | Value transfer | Type reference (TYPE) | GHO_ALLOC_PURPOSE | Allocation Purpose | 20100922 | ||
| 3 | Importing |
IV_ALLOC_TYPE | Value transfer | Type reference (TYPE) | GHO_ALLOC_TYPE | Allocation Type | 20100922 | ||
| 4 | Importing |
IV_FINAL_IND | Value transfer | Type reference (TYPE) | GHO_FINAL_IND | 'X' | Final Indicator for Allocation Results | 20100922 | |
| 5 | Importing |
IV_FREQUENCY | Value transfer | Type reference (TYPE) | GHO_ALLOC_FREQUENCY | Allocation Frequency | 20100922 | ||
| 6 | Importing |
IV_FROM_DATE | Value transfer | Type reference (TYPE) | GHO_START_DATE_ALLOC | Production Start Date | 20100922 | ||
| 7 | Importing |
IV_FROM_TIME | Value transfer | Type reference (TYPE) | GHO_START_TIME_ALLOC | Production Start Time | 20110408 | ||
| 8 | Importing |
IV_MEDIUM | Value transfer | Type reference (TYPE) | GHO_PRODUCT | Product on which Allocation is Performed (Oil, Gas, Water) | 20100922 | ||
| 9 | Importing |
IV_NETID | Value transfer | Type reference (TYPE) | GHO_NETOBJ_ID | Network Object ID | 20100922 | ||
| 10 | Importing |
IV_TO_DATE | Value transfer | Type reference (TYPE) | GHO_END_DATE_ALLOC | Production Start Time | 20100922 | ||
| 11 | Importing |
IV_TO_TIME | Value transfer | Type reference (TYPE) | GHO_END_TIME_ALLOC | End of Test Time | 20110408 |
Method GET_ALLOCATION_DETAILS on class CL_GHO_ALLOC_API has no exception.
Method GET_ALLOC_DATE_DETAILS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Changing |
CT_ALLOC_RES | Call by reference | Type reference (TYPE) | GHO_T_ALLOC_RESULT_NWM | test table type for NWM | 20100823 | ||
| 2 | Exporting |
ET_MESSAGE | Call by reference | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20100817 | ||
| 3 | Importing |
IV_NETID | Call by reference | Type reference (TYPE) | GHO_NETOBJ_ID | Network Object ID | 20100817 |
Method GET_ALLOC_DATE_DETAILS on class CL_GHO_ALLOC_API has no exception.
Method GET_ALLOC_RULES_FOR_NW_NODES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_ALLOC_NODES_PP | Call by reference | Type reference (TYPE) | GHO_T_PP_ALLOC_NODES | Table type for Allocation rules to hold PP | 20100825 | ||
| 2 | Exporting |
ET_MESSAGES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20110107 | ||
| 3 | Importing |
IV_MEDIUM | Call by reference | Type reference (TYPE) | GHO_PRODUCT | Product on which Allocation is Performed (Oil, Gas, Water) | 20100820 | ||
| 4 | Importing |
IV_NETID | Call by reference | Type reference (TYPE) | GHO_NETOBJ_ID | Network Object ID | 20100820 | ||
| 5 | Importing |
IV_SIMU_ID | Call by reference | Type reference (TYPE) | GHO_SIMU_ID | Simulation ID | 20101130 | ||
| 6 | Importing |
IV_VALID_FROM | Call by reference | Type reference (TYPE) | GHO_PP_HORIZON_START | Start of Planning Horizon for GHO PP | 20100825 | ||
| 7 | Importing |
IV_VALID_TO | Call by reference | Type reference (TYPE) | GHO_PP_HORIZON_END | ENd of Planning Horizon for GHO PP | 20100825 |
Method GET_ALLOC_RULES_FOR_NW_NODES on class CL_GHO_ALLOC_API has no exception.
Method GET_MEDIUM_FOR_NETWORK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_MEDIUMS | Call by reference | Type reference (TYPE) | GHO_T_MEDIUM | Mediums used in a Production Network | 20091116 | ||
| 2 | Importing |
IV_ALLOC_DIRECTION | Call by reference | Type reference (TYPE) | GHO_ALLOC_DIRECTION | GHO: Allocation Direction. | 20091113 | ||
| 3 | Importing |
IV_ALLOC_PURPOSE | Call by reference | Type reference (TYPE) | GHO_ALLOC_PURPOSE | '02' | Allocation Purpose | 20091113 | |
| 4 | Importing |
IV_ALLOC_TYPE | Call by reference | Type reference (TYPE) | GHO_ALLOC_TYPE | Allocation Type | 20091113 | ||
| 5 | Importing |
IV_NETID | Call by reference | Type reference (TYPE) | GHO_NETOBJ_ID | GHO Production Network identification | 20091113 | ||
| 6 | Importing |
IV_PERIOD | Call by reference | Type reference (TYPE) | GHO_ALLOC_FREQUENCY | Allocation Frequency | 20091113 | ||
| 7 | Importing |
IV_PERIOD_START_TS | Call by reference | Type reference (TYPE) | TIMESTAMP | UTC Time Stamp in Short Form (YYYYMMDDhhmmss) | 20091113 | ||
| 8 | Importing |
IV_PLANNING_HORIZON | Call by reference | Type reference (TYPE) | GHO_ALLOC_FREQUENCY | Allocation Frequency | 20091113 |
Method GET_MEDIUM_FOR_NETWORK on class CL_GHO_ALLOC_API has no exception.
Method GET_MRH_RULE_DETAILS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
FORMULA_ID | Call by reference | Type reference (TYPE) | FDT_UUID | FDT: Universal Unique Identifier | 20101129 | ||
| 2 | Importing |
IT_ALLOC_TYPE | Call by reference | Type reference (TYPE) | RSDSSELOPT_T | Table Type of RSDSSELOPT | 20101129 | ||
| 3 | Importing |
IT_FREQUENCY | Call by reference | Type reference (TYPE) | RSDSSELOPT_T | Table Type of RSDSSELOPT | 20101129 | ||
| 4 | Importing |
IT_MATERIAL | Call by reference | Type reference (TYPE) | RSDSSELOPT_T | Table Type of RSDSSELOPT | 20101129 | ||
| 5 | Importing |
IT_MEDIUM | Call by reference | Type reference (TYPE) | RSDSSELOPT_T | Table Type of RSDSSELOPT | 20101129 | ||
| 6 | Importing |
IT_NET_ID | Call by reference | Type reference (TYPE) | RSDSSELOPT_T | Table Type of RSDSSELOPT | 20101129 | ||
| 7 | Importing |
IT_PROD_DATE | Call by reference | Type reference (TYPE) | RSDSSELOPT_T | Table Type of RSDSSELOPT | 20101217 | ||
| 8 | Exporting |
MRH_RULE_ID | Call by reference | Type reference (TYPE) | GHO_MRH_RULE_ID | MRH Rule ID | 20101129 | ||
| 9 | Exporting |
SEQUENCE_ID | Call by reference | Type reference (TYPE) | GHO_MRH_SEQ_NO | MRH Sequence Number | 20101129 | ||
| 10 | Exporting |
SOURCE_MP | Call by reference | Type reference (TYPE) | IMRC_POINT | Measuring Point | 20101129 | ||
| 11 | Exporting |
SOURCE_NODE | Call by reference | Type reference (TYPE) | GHO_NETOBJ_ID | Network Object ID | 20101129 | ||
| 12 | Exporting |
SOURCE_TYPE | Call by reference | Type reference (TYPE) | GHO_RULE_SOURCE_TYPE | Source Type for MRH Rules | 20101129 | ||
| 13 | Exporting |
TARGET_MP | Call by reference | Type reference (TYPE) | IMRC_POINT | Measuring Point | 20101129 | ||
| 14 | Exporting |
TARGET_NODE | Call by reference | Type reference (TYPE) | GHO_NETOBJ_ID | Network Object ID | 20101129 |
Method GET_MRH_RULE_DETAILS on class CL_GHO_ALLOC_API has no exception.
Method GET_PN_OBJLINK_STATUS 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 | 20091216 | ||
| 2 | Exporting |
EV_STATUS | Call by reference | Type reference (TYPE) | CHAR1 | Single-Character Indicator | 20091216 | ||
| 3 | Importing |
IV_DATE | Call by reference | Type reference (TYPE) | SY-DATUM | Current Date of Application Server | 20091216 | ||
| 4 | Importing |
IV_FROM_NODE | Call by reference | Type reference (TYPE) | GHO_NETOBJ_ID | GHO: Network Object ID | 20091216 | ||
| 5 | Importing |
IV_MEDIUM | Call by reference | Type reference (TYPE) | GHO_PRODUCT | Product on which allocation is performed (Oil, Gas, Water..) | 20091216 | ||
| 6 | Importing |
IV_NETID | Call by reference | Type reference (TYPE) | GHO_NETOBJ_ID | GHO: Network Object ID | 20091216 | ||
| 7 | Importing |
IV_OBJLINK_ID | Call by reference | Type reference (TYPE) | GHO_LINK_ID | Id of the link between two nodes | 20091216 | ||
| 8 | Importing |
IV_TO_NODE | Call by reference | Type reference (TYPE) | GHO_NETOBJ_ID | GHO: Network Object ID | 20091216 |
Method GET_PN_OBJLINK_STATUS on class CL_GHO_ALLOC_API has no exception.
Method GET_PP_ALLOC_RUN_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_ALLOC_HDR | Call by reference | Type reference (TYPE) | GHO_T_ALLOC_RESULT_H | Table type to hold allocation result header information | 20091116 | ||
| 2 | Importing |
IV_BATCH_RUN_ID | Call by reference | Type reference (TYPE) | GUID | Globally Unique Identifier | 20091116 |
Method GET_PP_ALLOC_RUN_ID on class CL_GHO_ALLOC_API has no exception.
Method GET_QTY_CATEGORY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_DISPOSITIONS | Call by reference | Type reference (TYPE) | GHO_T_DISPOSITION | Table type to hold disposition data | 20091109 | ||
| 2 | Importing |
IV_QTY_TYPE | Call by reference | Type reference (TYPE) | GHO_QTY_TYPE | GHO - Quantity Type | 20091109 |
Method GET_QTY_CATEGORY on class CL_GHO_ALLOC_API has no exception.
Method GET_WC_ESTIMATED_PRODUCTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_MESSAGES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20101224 | ||
| 2 | Exporting |
ET_RESULT | Call by reference | Type reference (TYPE) | GHO_T_ALLOC_RES_I_ITEMIZED | Table type for structure GHO_S_ALLOC_RES_I_ITEMIZED | 20101224 | ||
| 3 | Exporting |
ET_WC_PROD_QTY | Call by reference | Type reference (TYPE) | OPM_T_GLG | Table type for gas lift gas | 20101224 | ||
| 4 | Importing |
IS_ALLOC_HEADER | Call by reference | Type reference (TYPE) | GHO_S_ALLOC_HEADER | Header for Allocation | 20101224 |
Method GET_WC_ESTIMATED_PRODUCTION on class CL_GHO_ALLOC_API has no exception.
Method GET_WORKBENCH_STATUS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_MESSAGES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20091109 | ||
| 2 | Exporting |
EV_INPUT_DATA_STATUS | Call by reference | Type reference (TYPE) | CHAR1 | Single-Character Indicator | 20091109 | ||
| 3 | Exporting |
EV_NODE_RULE_STATUS | Call by reference | Type reference (TYPE) | CHAR1 | Single-Character Indicator | 20091109 | ||
| 4 | Exporting |
EV_NW_RULE_STATUS | Call by reference | Type reference (TYPE) | CHAR1 | Single-Character Indicator | 20091109 | ||
| 5 | Exporting |
EV_NW_STATUS | Call by reference | Type reference (TYPE) | CHAR1 | Single-Character Indicator | 20091109 | ||
| 6 | Exporting |
EV_OWN_STATUS | Call by reference | Type reference (TYPE) | CHAR1 | Single-Character Indicator | 20101013 | ||
| 7 | Exporting |
EV_UOM_RULE_STATUS | Call by reference | Type reference (TYPE) | CHAR1 | Single-Character Indicator | 20091109 | ||
| 8 | Exporting |
EV_WC_DATA_STATUS | Call by reference | Type reference (TYPE) | CHAR1 | Single-Character Indicator | 20091127 | ||
| 9 | Importing |
IS_ALLOC_HEADER | Call by reference | Type reference (TYPE) | GHO_S_ALLOC_HEADER | Header for Allocation | 20091109 |
Method GET_WORKBENCH_STATUS on class CL_GHO_ALLOC_API has no exception.
Method READ_ALLOC_FACTORS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_ALLOC_FACTOR | Call by reference | Type reference (TYPE) | GHO_T_ALLOC_FACTOR | Table type to store allocation source results | 20110215 | ||
| 2 | Importing |
IS_ALLOC_HEADER | Call by reference | Type reference (TYPE) | GHO_S_ALLOC_HEADER | Header for Allocation | 20110215 |
Method READ_ALLOC_FACTORS on class CL_GHO_ALLOC_API has no exception.
Method READ_OBJLINK_RESULTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_OBJLINK_RESULTS | Call by reference | Type reference (TYPE) | GHO_T_OBJLINK_RESULT | Table type to hold object link results for allocation | 20091116 | ||
| 2 | Importing |
IS_ALLOC_HEADER | Call by reference | Type reference (TYPE) | GHO_S_ALLOC_HEADER | Header for Allocation | 20091116 |
Method READ_OBJLINK_RESULTS on class CL_GHO_ALLOC_API has no exception.
Method READ_PP_ALLOC_RESULTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ALLOC_RUN_ID | Call by reference | Type reference (TYPE) | GUID | Globally Unique Identifier | 20091113 | ||
| 2 | Importing |
IV_BATCH_RUN_ID | Call by reference | Type reference (TYPE) | GUID | Globally Unique Identifier | 20091113 | ||
| 3 | Changing |
XT_ALLOC_RES_PP | Call by reference | Type reference (TYPE) | GHO_T_ALLOC_RESULT_PP | Table type for structure GHO_S_ALLOC_RES_I | 20091113 |
Method READ_PP_ALLOC_RESULTS on class CL_GHO_ALLOC_API has no exception.
Method READ_PP_ALLOC_STATUS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_ALLOC_STATUS | Call by reference | Type reference (TYPE) | GHO_T_ALLOC_RESULT_H | Table type for table that stores allocation results | 20091113 | ||
| 2 | Importing |
IV_ALLOC_RUN_ID | Call by reference | Type reference (TYPE) | GUID | Globally Unique Identifier | 20091113 | ||
| 3 | Importing |
IV_BATCH_RUN_ID | Call by reference | Type reference (TYPE) | GUID | Globally Unique Identifier | 20091113 |
Method READ_PP_ALLOC_STATUS on class CL_GHO_ALLOC_API has no exception.
Method READ_SOURCE_RESULTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_SOURCE_RESULTS | Call by reference | Type reference (TYPE) | GHO_T_SOURCE_RESULT | Table type to store allocation source results | 20091119 | ||
| 2 | Exporting |
ET_SOURCE_RESULTS_HDR | Call by reference | Type reference (TYPE) | GHO_T_ALLOC_RESULT_H | Table type to hold allocation result header information | 20101005 | ||
| 3 | Exporting |
ET_SOURCE_RESULTS_ITEM | Call by reference | Type reference (TYPE) | GHO_T_ALLOC_RESULT | Table type for table that stores allocation results | 20101005 | ||
| 4 | Importing |
IS_ALLOC_HEADER | Call by reference | Type reference (TYPE) | GHO_S_ALLOC_HEADER | Header for Allocation | 20091119 |
Method READ_SOURCE_RESULTS on class CL_GHO_ALLOC_API has no exception.
Method SET_PPN_INDICATOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_ALLOC_HDR | Value transfer | Type reference (TYPE) | GHO_T_ALLOC_RESULT_H | Table type to hold allocation result header information | 20100922 |
Method SET_PPN_INDICATOR on class CL_GHO_ALLOC_API has no exception.
Method SET_PP_OBJ_LINK_STATUS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_OBJECT_LINK | Call by reference | Type reference (TYPE) | GHO_T_LINK | Id of the link between two nodes | 20091113 | ||
| 2 | Importing |
IV_ALLOC_RUN_ID | Call by reference | Type reference (TYPE) | GHO_ALLOC_RUN_ID | Identifier for an instance of the allocation engine run | 20091113 |
Method SET_PP_OBJ_LINK_STATUS on class CL_GHO_ALLOC_API has no exception.
Method TRIGGER_ALLOC_RUN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EV_ALLOC_RUN_ID | Call by reference | Type reference (TYPE) | GHO_ALLOC_RUN_ID | Identifier for an instance of the allocation engine run | 20091113 | ||
| 2 | Exporting |
EV_BATCH_RUN_ID | Call by reference | Type reference (TYPE) | GHO_ALLOC_RUN_ID | Identifier for an instance of the allocation engine run | 20091113 | ||
| 3 | Importing |
IV_ALLOC_DIRECTION | Call by reference | Type reference (TYPE) | GHO_ALLOC_DIRECTION | GHO: Allocation Direction. | 20091113 | ||
| 4 | Importing |
IV_ALLOC_FREQUENCY | Call by reference | Type reference (TYPE) | GHO_ALLOC_FREQUENCY | Allocation Frequency | 20091113 | ||
| 5 | Importing |
IV_ALLOC_PURPOSE | Call by reference | Type reference (TYPE) | GHO_ALLOC_PURPOSE | Allocation Purpose | 20091113 | ||
| 6 | Importing |
IV_ALLOC_TYPE | Call by reference | Type reference (TYPE) | GHO_ALLOC_TYPE | Allocation Type | 20091113 | ||
| 7 | Importing |
IV_FINAL_IND | Call by reference | Type reference (TYPE) | CHAR1 | 'X' | Single-Character Indicator | 20091118 | |
| 8 | Importing |
IV_MEDIUM | Call by reference | Type reference (TYPE) | MEDIU | Medium | 20091113 | ||
| 9 | Importing |
IV_NETID | Call by reference | Type reference (TYPE) | GHO_NETOBJ_ID | Id of the Production Flow Network | 20091113 | ||
| 10 | Importing |
IV_PLANNING_HORIZON | Call by reference | Type reference (TYPE) | GHO_ALLOC_FREQUENCY | Allocation Frequency | 20091113 | ||
| 11 | Importing |
IV_PROD_START_TS | Call by reference | Type reference (TYPE) | TIMESTAMP | UTC Time Stamp in Short Form (YYYYMMDDhhmmss) | 20091113 |
Method TRIGGER_ALLOC_RUN on class CL_GHO_ALLOC_API has no exception.
Method TRIGGER_RECEIVE_ALLOC_RESULTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_MESSAGES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20110110 | ||
| 2 | Importing |
IV_ALLOC_DIRECTION | Call by reference | Type reference (TYPE) | GHO_ALLOC_DIRECTION | Allocation Direction | 20100914 | ||
| 3 | Importing |
IV_ALLOC_FREQUENCY | Call by reference | Type reference (TYPE) | GHO_ALLOC_FREQUENCY | Allocation Frequency | 20100914 | ||
| 4 | Importing |
IV_ALLOC_PURPOSE | Call by reference | Type reference (TYPE) | GHO_ALLOC_PURPOSE | Allocation Purpose | 20100914 | ||
| 5 | Importing |
IV_ALLOC_TYPE | Call by reference | Type reference (TYPE) | GHO_ALLOC_TYPE | Allocation Type | 20100914 | ||
| 6 | Importing |
IV_MEDIUM | Call by reference | Type reference (TYPE) | GHO_PRODUCT | Product on which Allocation is Performed (Oil, Gas, Water) | 20100914 | ||
| 7 | Importing |
IV_NETID | Call by reference | Type reference (TYPE) | GHO_NETOBJ_ID | Network Object ID | 20100914 | ||
| 8 | Importing |
IV_PL_HORIZON_END | Call by reference | Type reference (TYPE) | GHO_PP_HORIZON_END | ENd of Planning Horizon for GHO PP | 20100914 | ||
| 9 | Importing |
IV_PL_HORIZON_START | Call by reference | Type reference (TYPE) | GHO_PP_HORIZON_START | Start of Planning Horizon for GHO PP | 20100914 | ||
| 10 | Importing |
IV_SIMU_ID | Call by reference | Type reference (TYPE) | GHO_SIMU_ID | Simulation ID | 20101130 | ||
| 11 | Changing |
XT_ALLOC_RES_PP | Call by reference | Type reference (TYPE) | GHO_T_ALLOC_RES_PP | Table type to hold planning results | 20100914 |
Method TRIGGER_RECEIVE_ALLOC_RESULTS on class CL_GHO_ALLOC_API has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 605 |
