SAP ABAP Class CL_GHO_PP_ALLOCATION_IF (Interface PP - Allocation)
Hierarchy
☛
SAP_APPL (Software Component) Logistics and Accounting
⤷
PP-PN-NOP (Application Component) Network Operations
⤷
APPL_GHO_PP_ALLOCATION_IF_SC (Package) GHO PP Allocation Interface
⤷
⤷
Properties
| Class | CL_GHO_PP_ALLOCATION_IF | |
| Short Description | Interface PP - Allocation | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | APPL_GHO_PP_ALLOCATION_IF_SC | GHO PP Allocation Interface |
| Created | 20091029 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CL_GHO_PP_ALLOCATION_IF has no forward declaration.
Interfaces
Class CL_GHO_PP_ALLOCATION_IF has no interface implemented.
Friends
Class CL_GHO_PP_ALLOCATION_IF has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Static Attribute | Public | Object reference (TYPE REF TO) | CL_GHO_DB_NETOBJ | Buffer class for network objects | 20091214 | |||
| 2 | Instance attribute | Public | Object reference (TYPE REF TO) | CL_GHO_PP_CONSTANTS | Class for global PP constants | 20091116 | |||
| 3 | Instance attribute | Public | Type reference (TYPE) | GHO_T_ALLOC_RESULT_PP | Table type to store PP related allocation result | 20091123 | |||
| 4 | Instance attribute | Public | Type reference (TYPE) | GHO_ALLOC_RUN_ID | Identifier for an instance of the allocation engine run | 20091029 | |||
| 5 | Instance attribute | Public | Type reference (TYPE) | GHO_ALLOC_TYPE | Allocation Type | 20091029 | |||
| 6 | Instance attribute | Public | Type reference (TYPE) | GHO_ALLOC_DIRECTION | Allocation Direction. | 20091204 | |||
| 7 | Instance attribute | Public | Type reference (TYPE) | GHO_ALLOC_PURPOSE | Allocation Purpose | 20091204 | |||
| 8 | Instance attribute | Public | Type reference (TYPE) | GHO_ALLOC_RUN_ID | Identifier instance batch allocation run | 20091116 | |||
| 9 | Instance attribute | Public | Type reference (TYPE) | GHO_NETID | Production Network Identification | 20091029 | |||
| 10 | Instance attribute | Public | Type reference (TYPE) | GHO_PP_NETVERID | Production Network Version Identification | 20091029 | |||
| 11 | Instance attribute | Public | Type reference (TYPE) | GHO_ALLOC_FREQUENCY | Period of Time | 20091029 | |||
| 12 | Instance attribute | Public | Type reference (TYPE) | GHO_ALLOC_FREQUENCY | Period of Time of the Planning Horizon | 20091029 | |||
| 13 | Instance attribute | Public | Type reference (TYPE) | GHO_NETOBJ_ID | Network Object ID Production Network | 20091214 | |||
| 14 | Instance attribute | Public | Type reference (TYPE) | TIMESTAMP | UTC Time Stamp in Short Form (YYYYMMDDhhmmss) | 20091116 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Constructor | CLASS_CONSTRUCTOR | 20091214 | |
| 2 | Instance method | Public | Constructor | CONSTRUCTOR | 20091116 | |
| 3 | Instance method | Public | Method | Get allocation results | 20091123 | |
| 4 | Instance method | Public | Method | Get allocation status | 20100126 | |
| 5 | Instance method | Private | Method | Read allocation results | 20091123 | |
| 6 | Instance method | Public | Method | Trigger Capacity Allocation Run | 20091030 |
Events
Class CL_GHO_PP_ALLOCATION_IF has no event.
Types
Class CL_GHO_PP_ALLOCATION_IF has no local type.
Method Signatures
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class CL_GHO_PP_ALLOCATION_IF has no parameter.
Method CLASS_CONSTRUCTOR on class CL_GHO_PP_ALLOCATION_IF has no exception.
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ALLOCATION_TYPE | Value transfer | Type reference (TYPE) | GHO_ALLOC_TYPE | Allocation Type | 20100125 | |||
| 2 | IV_ALLOC_DIRECTION | Value transfer | Type reference (TYPE) | GHO_ALLOC_DIRECTION | GHO: Allocation Direction (Top Down or Buttom Up) | 20100125 | |||
| 3 | IV_ALLOC_PURPOSE | Value transfer | Type reference (TYPE) | GHO_ALLOC_PURPOSE | Allocation Purpose (Simulation or PP-Update) | 20100125 | |||
| 4 | IV_NETID | Value transfer | Type reference (TYPE) | GHO_NETID | GHO Production Network Identification | 20100125 | |||
| 5 | IV_NETVER_ID | Value transfer | Type reference (TYPE) | GHO_PP_NETVERID | GHO Production Network Version Identification | 20100125 | |||
| 6 | IV_PERIOD | Value transfer | Type reference (TYPE) | GHO_ALLOC_FREQUENCY | Time of Period for the Alloaction Run | 20100125 | |||
| 7 | IV_PLANNING_HORIZON | Value transfer | Type reference (TYPE) | GHO_ALLOC_FREQUENCY | Time of Period for the Planning Horizon | 20100125 | |||
| 8 | IV_PN_NETOBJ_ID | Value transfer | Type reference (TYPE) | GHO_NETOBJ_ID | GHO: Network Object ID of the Production Network | 20100125 | |||
| 9 | IV_TS_PERIOD_START_DATE | Value transfer | Type reference (TYPE) | TIMESTAMP | Time Stamp of the Period Start Date and Time | 20100125 |
Method CONSTRUCTOR on class CL_GHO_PP_ALLOCATION_IF has no exception.
Method GET_ALLOCATION_RESULTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ALLOCATION_RUN_ID | Call by reference | Type reference (TYPE) | GHO_ALLOC_RUN_ID | Identifier for an instance of the allocation engine run | 20091124 | |||
| 2 | XT_ALLOC_RESULTS | Call by reference | Type reference (TYPE) | GHO_T_ALLOC_RESULT_PP | Table type to store PP related allocation result | 20091123 |
Method GET_ALLOCATION_RESULTS on class CL_GHO_PP_ALLOCATION_IF has no exception.
Method GET_ALLOCATION_STATUS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_ALLOC_STATUS | Call by reference | Type reference (TYPE) | GHO_T_ALLOC_RESULT_H | Table type to hold allocation result header information | 20100126 | |||
| 2 | ET_MEDIUMS | Call by reference | Type reference (TYPE) | GHO_T_MEDIUM | Mediums used in the Production Network | 20100126 | |||
| 3 | EV_ALLOCATION_RUN_ID | Call by reference | Type reference (TYPE) | GHO_ALLOC_RUN_ID | Allocation Run ID for which the status were read | 20100126 | |||
| 4 | EV_NOT_ALL_STATUS_READ | Call by reference | Type reference (TYPE) | FLAG | Not all status for all mediums read | 20100126 | |||
| 5 | IV_MAX_LOOP_COUNT | Value transfer | Type reference (TYPE) | I | Maximum number of repetitions for reading allocation status | 20100126 | |||
| 6 | IV_WAITING_SECONDS | Value transfer | Type reference (TYPE) | I | 5 | Waiting time (in seconds) between the repetitions | 20100126 |
Method GET_ALLOCATION_STATUS on class CL_GHO_PP_ALLOCATION_IF has no exception.
Method READ_ALLOCATION_RESULTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ALLOCATION_RUN_ID | Call by reference | Type reference (TYPE) | GHO_ALLOC_RUN_ID | Identifier for asl instance of a single allocation run | 20091123 | |||
| 2 | IV_BATCH_ALLOC_RUN_ID | Call by reference | Type reference (TYPE) | GHO_ALLOC_RUN_ID | Identifier for an instance of the batch allocation run | 20091123 | |||
| 3 | XT_ALLOC_RESULTS | Call by reference | Type reference (TYPE) | GHO_T_ALLOC_RESULT_PP | Table type to store PP related allocation result | 20091123 |
Method READ_ALLOCATION_RESULTS on class CL_GHO_PP_ALLOCATION_IF has no exception.
Method TRIGGER_ALLOCATION_RUN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_ALLOCATION_RUN_ID | Value transfer | Type reference (TYPE) | GHO_ALLOC_RUN_ID | Globally Unique Identifier | 20091214 | |||
| 2 | EV_PN_NETOBJ_ID | Value transfer | Type reference (TYPE) | GHO_NETOBJ_ID | GHO: Network Object ID | 20091214 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Exceptions GHO API PP - Allocation | 20091116 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 605 |