SAP ABAP Class /BSAM/IF_SAM_RUN_TIME (Interface for STM runtime)
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface composition (i COMPRISING i_ref) | /BSAM/IF_SAM_MEMORY_STATES | Interface for multiple memory states | 20081127 |
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | /BSAM/CL_SAM_RUNTIME | Controller class for application to access STM | 20081127 |
Properties
| Class | /BSAM/IF_SAM_RUN_TIME | |
| Short Description | Interface for STM runtime | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | ||
| Created | 20081127 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class /BSAM/IF_SAM_RUN_TIME has no forward declaration.
Interfaces
Class /BSAM/IF_SAM_RUN_TIME has no interface implemented.
Friends
Class /BSAM/IF_SAM_RUN_TIME has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ACTION_ALLOWED |
Constant | Public | Type reference (TYPE) | /BSAM/SAM_ACTION_RESULT | 'A' | Result type for check action allowed | 20081127 | |
| 2 | ACTION_INHIBITED |
Constant | Public | Type reference (TYPE) | /BSAM/SAM_ACTION_RESULT | 'I' | Result type for check action allowed | 20081127 | |
| 3 | ACTION_NOT_USED |
Constant | Public | Type reference (TYPE) | /BSAM/SAM_ACTION_RESULT | 'N' | Result type for check action allowed | 20081127 | |
| 4 | ACTION_UNDEFINED |
Constant | Public | Type reference (TYPE) | /BSAM/SAM_ACTION_RESULT | 'U' | Result type for check action allowed | 20081127 | |
| 5 | AGGREGATION |
Constant | Public | Type reference (TYPE) | /BSAM/SAM_DERIVATOR_TYPES | 'AG' | SAM Derivator type | 20081127 | |
| 6 | AGGREGATION_INBOUND |
Constant | Public | Type reference (TYPE) | /BSAM/SAM_DERIVATOR_TYPES | 'AI' | SAM Derivator type | 20081127 | |
| 7 | AGGREGATION_OUTBOUND |
Constant | Public | Type reference (TYPE) | /BSAM/SAM_DERIVATOR_TYPES | 'AO' | SAM Derivator type | 20081127 | |
| 8 | ALLOWED |
Constant | Public | Type reference (TYPE) | /BSAM/SAM_ACTION_TYPE | 'A' | Specifies whether to return all actions or allowed actions | 20081127 | |
| 9 | ALL_EXISTING |
Constant | Public | Type reference (TYPE) | /BSAM/SAM_ACTION_TYPE | 'E' | Specifies whether to return all actions or allowed actions | 20081127 | |
| 10 | CHILD |
Constant | Public | Type reference (TYPE) | /BSAM/SAM_RETRIEVE_BY_REF | 'C' | Data element to determine whether to retrieve by association | 20081127 | |
| 11 | OVERALL |
Constant | Public | Type reference (TYPE) | /BSAM/SAM_DERIVATOR_TYPES | 'OV' | SAM Derivator type | 20081127 | |
| 12 | PARENT |
Constant | Public | Type reference (TYPE) | /BSAM/SAM_RETRIEVE_BY_REF | 'P' | Data element to determine whether to retrieve by association | 20081127 | |
| 13 | POPULATION |
Constant | Public | Type reference (TYPE) | /BSAM/SAM_DERIVATOR_TYPES | 'PO' | SAM Derivator type | 20081127 | |
| 14 | POPULATION_INBOUND |
Constant | Public | Type reference (TYPE) | /BSAM/SAM_DERIVATOR_TYPES | 'PI' | SAM Derivator type | 20081127 | |
| 15 | POPULATION_OUTBOUND |
Constant | Public | Type reference (TYPE) | /BSAM/SAM_DERIVATOR_TYPES | 'PO' | SAM Derivator type | 20081127 | |
| 16 | SAM_FALSE |
Constant | Public | Type reference (TYPE) | /BSAM/SAM_CHAR1 | SPACE | False value | 20081127 | |
| 17 | SAM_TRUE |
Constant | Public | Type reference (TYPE) | /BSAM/SAM_CHAR1 | 'X' | True value | 20081127 | |
| 18 | STGD_ACTIVE |
Constant | Public | Type reference (TYPE) | /BSAM/SAM_ERROR_RESULT | 'A' | Data element for different Error result | 20081127 | |
| 19 | STGD_ALL_EXISTING |
Constant | Public | Type reference (TYPE) | /BSAM/SAM_STATEGUARD_TYPE | 'E' | Specifies whether to return all stateguards or active ones | 20081127 | |
| 20 | STGD_NOT_ACTIVE |
Constant | Public | Type reference (TYPE) | /BSAM/SAM_ERROR_RESULT | 'N' | Data element for different Error result | 20081127 | |
| 21 | STGD_NOT_DEFINED |
Constant | Public | Type reference (TYPE) | /BSAM/SAM_ERROR_RESULT | 'D' | Data element for different Error result | 20081127 | |
| 22 | STGD_ONLY_ACTIVE |
Constant | Public | Type reference (TYPE) | /BSAM/SAM_STATEGUARD_TYPE | 'A' | Specifies whether to return all stateguards or active ones | 20081127 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ACTION_RESULT |
Instance method | Public | Method | Gives back the resulting status of an action | 20081127 |
| 2 | CHECK_ACTION_ALLOWED |
Instance method | Public | Method | Checks whether an action is allowed | 20081127 |
| 3 | CLEANUP |
Instance method | Public | Method | Cleans up buffers at the end of transactions | 20081127 |
| 4 | CREATE |
Instance method | Public | Method | Creates the status instance of a BO node | 20081127 |
| 5 | DELETE |
Instance method | Public | Method | Deletes status | 20081127 |
| 6 | RETRIEVE_ACTIONS |
Instance method | Public | Method | Retrieves actions | 20081127 |
| 7 | RETRIEVE_STATUS |
Instance method | Public | Method | Retrieves status | 20081127 |
| 8 | SAVE |
Instance method | Public | Method | Saves status | 20081127 |
Events
Class /BSAM/IF_SAM_RUN_TIME has no event.
Types
Class /BSAM/IF_SAM_RUN_TIME has no local type.
Method Signatures
Method ACTION_RESULT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_LIST_OF_NODES_MODIFIED | Call by reference | Type reference (TYPE) | /BSAM/T_SAM_LIST_OF_NODES | Table type for SAM list of nodes | 20081127 | ||
| 2 |  Importing |
IT_LIST_OF_NODES_ACTION_RESULT | Call by reference | Type reference (TYPE) | /BSAM/T_SAM_LIST_OF_NODES_ST | Table type for list of nodes with option to set status | 20081127 | ||
| 3 | Importing |
IV_ACTION_NAME | Call by reference | Type reference (TYPE) | /BSAM/SAM_ACTION | Proxy Generation: Name of an Object in R/3 | 20081127 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  /BSAM/CX_SAM_ACTION_DISALLOW |
20081127 | ||
| 2 | /BSAM/CX_SAM_ACTION_UNDEF |
20081127 | ||
| 3 | /BSAM/CX_SAM_CANNOT_PERF_ACT |
Exptn signifying the requested action could not be performed | 20081127 | |
| 4 | /BSAM/CX_SAM_DATA_NOT_FOUND |
Exception class for data not found | 20081127 | |
| 5 | /BSAM/CX_SAM_INC_INPUT_PARAM |
Exception class for incorrect input | 20081127 | |
| 6 | /BSAM/CX_SAM_NO_PERSIST_REF |
No reference to IF_SAM_PERSISTENCE is available | 20081127 | |
| 7 | /BSAM/CX_SAM_SCHEMA_UNAVLBL |
Exptn signifying that the model specified is unavailable. | 20081127 |
Method CHECK_ACTION_ALLOWED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_LIST_OF_NODE_ACTION_INHIBIT | Call by reference | Type reference (TYPE) | /BSAM/T_SAM_OBJ_ACTION_INH | Table type for statuses inhibiting an action | 20081127 | ||
| 2 | Exporting |
ET_LIST_OF_NODE_RESULT | Call by reference | Type reference (TYPE) | /BSAM/T_SAM_OBJ_ACTION_RESLT | Table type for Action check result | 20081127 | ||
| 3 | Exporting |
EV_ERROR_RESULT | Value transfer | Type reference (TYPE) | XFELD | Indicator showing action is not valid for atleast one node | 20081127 | ||
| 4 | Importing |
IT_LIST_OF_NODES | Call by reference | Type reference (TYPE) | /BSAM/T_SAM_LIST_OF_NODES | Table type for SAM list of nodes | 20081127 | ||
| 5 | Importing |
IV_ACTION_NAME | Call by reference | Type reference (TYPE) | /BSAM/SAM_ACTION | Proxy Generation: Name of an Object in R/3 | 20081127 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /BSAM/CX_SAM_DATA_NOT_FOUND |
Exception class for data not found | 20081127 | |
| 2 | /BSAM/CX_SAM_INC_INPUT_PARAM |
Exception class for incorrect input | 20081127 | |
| 3 | /BSAM/CX_SAM_NO_PERSIST_REF |
No reference to IF_SAM_PERSISTENCE is available | 20081127 | |
| 4 | /BSAM/CX_SAM_SCHEMA_UNAVLBL |
Exptn signifying that the model specified is unavailable. | 20081127 |
Method CLEANUP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_LIST_OF_NODES | Call by reference | Type reference (TYPE) | /BSAM/T_SAM_LIST_OF_NODES | Table type for SAM list of nodes | 20081127 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /BSAM/CX_SAM_INC_INPUT_PARAM |
Exception class for incorrect input | 20081127 |
Method CREATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_LIST_OF_NODES_MODIFIED | Call by reference | Type reference (TYPE) | /BSAM/T_SAM_LIST_OF_NODES | Table type for SAM list of nodes | 20081127 | ||
| 2 | Importing |
IT_LIST_OF_NODES_CREATE | Call by reference | Type reference (TYPE) | /BSAM/T_SAM_NODES_CREATE | Table for list of nodes for create | 20081127 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /BSAM/CX_SAM_INC_INPUT_PARAM |
Exception class for incorrect input | 20081127 |
Method DELETE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_LIST_OF_NODES_MODIFIED | Call by reference | Type reference (TYPE) | /BSAM/T_SAM_LIST_OF_NODES | Table type for SAM list of nodes | 20081127 | ||
| 2 | Importing |
IT_LIST_OF_NODES | Call by reference | Type reference (TYPE) | /BSAM/T_SAM_LIST_OF_NODES | Table type for SAM list of nodes | 20081127 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /BSAM/CX_SAM_CHILD_EXISTS |
Delete is not allowed since child nodes exist | 20081127 | |
| 2 | /BSAM/CX_SAM_DATA_NOT_FOUND |
Exception class for data not found | 20081127 | |
| 3 | /BSAM/CX_SAM_DELETE_FAILED |
Exception class for failure of deletion | 20081127 | |
| 4 | /BSAM/CX_SAM_INC_INPUT_PARAM |
Exception class for incorrect input | 20081127 | |
| 5 | /BSAM/CX_SAM_NO_PERSIST_REF |
No reference to IF_SAM_PERSISTENCE is available | 20081127 | |
| 6 | /BSAM/CX_SAM_SCHEMA_UNAVLBL |
Exptn signifying that the model specified is unavailable. | 20081127 |
Method RETRIEVE_ACTIONS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_NODES_ACTIONS_ALLOWED | Call by reference | Type reference (TYPE) | /BSAM/T_SAM_CMPLX_ACTION_RES | Table type for Action check result | 20081127 | ||
| 2 | Importing |
IT_LIST_OF_ACTIONS_FOR_CHECK | Call by reference | Type reference (TYPE) | /BSAM/T_SAM_ACTION | Table type for STM Action Name | 20081127 | ||
| 3 | Importing |
IT_LIST_OF_NODES | Call by reference | Type reference (TYPE) | /BSAM/T_SAM_LIST_OF_NODES | Table type for SAM list of nodes | 20081127 | ||
| 4 | Importing |
IV_MODE | Value transfer | Type reference (TYPE) | /BSAM/SAM_ACTION_TYPE | Specifies whether to return all actions or allowed actions | 20081127 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /BSAM/CX_SAM_DATA_NOT_FOUND |
Exception class for data not found | 20081127 | |
| 2 | /BSAM/CX_SAM_INC_INPUT_PARAM |
Exception class for incorrect input | 20081127 | |
| 3 | /BSAM/CX_SAM_NO_PERSIST_REF |
No reference to IF_SAM_PERSISTENCE is available | 20081127 | |
| 4 | /BSAM/CX_SAM_SCHEMA_UNAVLBL |
Exptn signifying that the model specified is unavailable. | 20081127 |
Method RETRIEVE_STATUS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_LIST_OF_NODE_PROPERTY | Call by reference | Type reference (TYPE) | /BSAM/T_SAM_OBJ_INST_BUF | Table type for SAM instance buffer structure | 20081127 | ||
| 2 | Exporting |
ET_LIST_OF_NODE_STATUS_VALUES | Call by reference | Type reference (TYPE) | /BSAM/T_SAM_OBJ_STAT_INST_BF | Table type for SAM status instance value buffer | 20081127 | ||
| 3 | Importing |
IT_LIST_OF_NODES | Call by reference | Type reference (TYPE) | /BSAM/T_SAM_LIST_OF_NODES | Table type for SAM list of nodes | 20081127 | ||
| 4 | Importing |
IV_REQUEST_BEFORE_IMAGE | Value transfer | Type reference (TYPE) | SESF_BOOLEAN | Checkbox | 20081127 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /BSAM/CX_SAM_DATA_NOT_FOUND |
Exception class for data not found | 20081127 | |
| 2 | /BSAM/CX_SAM_INC_INPUT_PARAM |
Exception class for incorrect input | 20081127 | |
| 3 | /BSAM/CX_SAM_NO_PERSIST_REF |
No reference to IF_SAM_PERSISTENCE is available | 20081127 |
Method SAVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_LIST_OF_NODES | Call by reference | Type reference (TYPE) | /BSAM/T_SAM_LIST_OF_NODES | Table type for SAM list of nodes | 20081127 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /BSAM/CX_SAM_DB_UPDATE_FAIL |
Exception class for DB update | 20081127 | |
| 2 | /BSAM/CX_SAM_INC_INPUT_PARAM |
Exception class for incorrect input | 20081127 | |
| 3 | /BSAM/CX_SAM_NO_PERSIST_REF |
No reference to IF_SAM_PERSISTENCE is available | 20081127 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in |
