SAP ABAP Interface IF_SAM_RUNTIME_ACCESS (S&AM: "Access" interface pattern)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ESI-SAM (Application Component) Status and Action Management
     ⤷ SESF_SAM_RT (Package) S&AM Runtime

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface composition (i COMPRISING i_ref)	IF_SAM_RUNTIME	S&AM runtime interface	20070924
2	Interface implementation (CLASS c. INTERFACES i_ref)	CL_SAM_RUNTIME_DYNAMIC	S&AM runtime class for dynamic scenarios	20090722
3	Interface implementation (CLASS c. INTERFACES i_ref)	CL_SAM_RUNTIME_ENGINE	class to implement runtime interface	20070809
4	Interface implementation (CLASS c. INTERFACES i_ref)	CL_SAM_RUNTIME_STATIC	S&AM runtime class for static scenarios	20100621

Properties

Interface	IF_SAM_RUNTIME_ACCESS
Short Description	S&AM: "Access" interface pattern

General Data

Package	SESF_SAM_RT	S&AM Runtime
Created	20070808	SAP
Last changed	20110908	SAP
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	IF_SAM_TYPES	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Interface IF_SAM_RUNTIME_ACCESS has no interface.

Friends

Interface IF_SAM_RUNTIME_ACCESS has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_ACTION_ALL	Constant	Public	☐	Type reference (TYPE)	SAM_ACTION_TYPE	'E'	All actions	20071031
2	CO_ACTION_ALLOWED	Constant	Public	☐	Type reference (TYPE)	SAM_ACTION_TYPE	'A'	Action is allowed	20071031
3	CO_ACTION_INHIBITED	Constant	Public	☐	Type reference (TYPE)	SAM_ACTION_RESULT	'I'	Action is inhibited	20071030
4	CO_ACTION_UNDEFINED	Constant	Public	☐	Type reference (TYPE)	SAM_ACTION_RESULT	'U'	Action is undefined	20071030
5	CO_DERIV_AGGREGATION	Constant	Public	☐	Type reference (TYPE)	SAM_DERIVATOR_TYPES	'AG'	SAM Aggregation derivator type	20071030
6	CO_DERIV_OVERALL	Constant	Public	☐	Type reference (TYPE)	SAM_DERIVATOR_TYPES	'OV'	SAM Overall derivator type	20071030
7	CO_DERIV_POPULATION	Constant	Public	☐	Type reference (TYPE)	SAM_DERIVATOR_TYPES	'PO'	SAM Population derivator type	20071030
8	CO_PROPERTY_MODE_ALL	Constant	Public	☐	Type reference (TYPE)	IF_SAM_TYPES=>TY_MODE	'A'	All instance properties	20100622
9	CO_PROPERTY_MODE_ENABLED	Constant	Public	☐	Type reference (TYPE)	IF_SAM_TYPES=>TY_MODE	'E'	Only enabled instance properties	20100622
10	CO_STGD_ACTIVE	Constant	Public	☐	Type reference (TYPE)	SAM_ERROR_RESULT	'A'	Stateguard is active	20071030
11	CO_STGD_INACTIVE	Constant	Public	☐	Type reference (TYPE)	SAM_ERROR_RESULT	'N'	Stateguard is inactive	20071030
12	CO_STGD_UNDEFINED	Constant	Public	☐	Type reference (TYPE)	SAM_ERROR_RESULT	'U'	Stateguard is undefined	20071030

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ASSIGN_NEW_PARENT	Instance method	Public	Method	Reassign a child to a new parent	20070809
2	CHECK_ACTION_PROPERTIES	Instance method	Public	Method	Check whether the given action is allowed	20070809
3	CHECK_STATEGUARD_ACTIVE	Instance method	Public	Method	Check whether the stateguard is active	20070809
4	CREATE	Instance method	Public	Method	Create S&AM instances	20070817
5	DELETE	Instance method	Public	Method	Delete S&AM instances	20070817
6	EXECUTE_ACTION	Instance method	Public	Method	Execute an action	20070809
7	EXECUTE_STATEGUARD	Instance method	Public	Method	Execute a stateguard	20070809
8	RETRIEVE	Instance method	Public	Method	Retrieve the S&AM instance data	20070808
9	RETRIEVE_ACTION_PROPERTIES	Instance method	Public	Method	Retrieves allowance of actions for list of S&AM instances	20070809
10	RETRIEVE_INSTANCE_PROPERTIES	Instance method	Public	Method		20100622
11	SWITCH_SEGMENTS	Instance method	Public	Method		20100622

Events

Interface IF_SAM_RUNTIME_ACCESS has no event.

Types

Interface IF_SAM_RUNTIME_ACCESS has no local type.

Method Signatures

Method ASSIGN_NEW_PARENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ETS_MODIFIED_INSTANCES	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TTS_SAM_INSTANCE		Table of modified instances	20070809
2	Importing	ITS_PARENT_ASSIGNMENTS	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TTS_SAM_PARENT_ASSIGNMENT		Table of S&AM instances with new parent info	20070809

#	Exception	Resumable	Description	Created on
1	CX_SAM_INTERNAL_ERROR	☐	Exception class for system or metadata load	20070809
2	CX_SAM_PROCESSING_ERROR	☐	Exception class for operation processing	20070809

Method CHECK_ACTION_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ETS_CHECK_RESULTS	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TTS_SAM_ACTION_CHECK		Table of action check results	20070809
2	Exporting	ETS_FAILED_INSTANCES	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TTS_SAM_INSTANCE		Table of BO node for which the check failed	20071031
3	Importing	ID_ACTION_NAME	Call by reference	☐	Type reference (TYPE)	SAM_ACTION_NAME		Name of the S&AM action	20070809
4	Importing	ID_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Node to which the action belongs	20070809
5	Importing	IT_NODE_IDS	Call by reference	☐	Type reference (TYPE)	SAM_NODE_ID_TAB		Table of BO node	20070809

#	Exception	Resumable	Description	Created on
1	CX_SAM_INTERNAL_ERROR	☐	Exception class for system or metadata load	20070809
2	CX_SAM_PROCESSING_ERROR	☐	Exception class for operation processing	20070809

Method CHECK_STATEGUARD_ACTIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ETS_CHECK_RESULTS	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TTS_SAM_STATEGUARD_CHECK		Table of S&AM stateguard allowance information	20080205
2	Exporting	ETS_FAILED_INSTANCES	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TTS_SAM_INSTANCE		Table of BO instances for which check failed	20071031
3	Importing	ID_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Node to which the stateguard belongs to	20070809
4	Importing	ID_STATUS_VARIABLE	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TY_STATUS_VARIABLE		Name of the status variable	20070809
5	Importing	IT_NODE_IDS	Call by reference	☐	Type reference (TYPE)	SAM_NODE_ID_TAB		Table of BO instances	20070809

#	Exception	Resumable	Description	Created on
1	CX_SAM_INTERNAL_ERROR	☐	Exception class for system or metadata load	20070809
2	CX_SAM_PROCESSING_ERROR	☐	Exception class for operation processing	20070809

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ETS_MODIFIED_INSTANCES	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TTS_SAM_INSTANCE		Table of modified instances	20070817
2	Importing	ITS_CREATED_INSTANCES	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TTS_SAM_INSTANCE_ATTRIBUTES		Table of S&AM instances to be created	20070817

#	Exception	Resumable	Description	Created on
1	CX_SAM_INTERNAL_ERROR	☐	Exception class for system or metadata load	20070817
2	CX_SAM_PROCESSING_ERROR	☐	Exception class for operation processing	20070817

Method DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ETS_MODIFIED_INSTANCES	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TTS_SAM_INSTANCE		Table of modified S&AM instances	20070817
2	Importing	ITS_SAM_INSTANCES	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TTS_SAM_INSTANCE		Table of S&AM instances to be deleted	20070817

#	Exception	Resumable	Description	Created on
1	CX_SAM_INTERNAL_ERROR	☐	Exception class for system or metadata load	20070817
2	CX_SAM_PROCESSING_ERROR	☐	Exception class for operation processing	20070817

Method EXECUTE_ACTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ETS_MODIFIED_INSTANCES	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TTS_SAM_INSTANCE		Tbale of modified S&AM instances	20070809
2	Importing	ID_ACTION_NAME	Call by reference	☐	Type reference (TYPE)	SAM_ACTION_NAME		Name of the action to be executed	20070809
3	Importing	ID_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Node to which the action belong	20070809
4	Importing	ITS_ACTION_TRANSITIONS	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TTS_SAM_ACTION_TRANSITIONS		Table of desired action transition with S&AM instances	20070809

#	Exception	Resumable	Description	Created on
1	CX_SAM_INTERNAL_ERROR	☐	Exception class for system or metadata load	20070809
2	CX_SAM_PROCESSING_ERROR	☐	Exception class for operation processing	20070809

Method EXECUTE_STATEGUARD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ETS_MODIFIED_INSTANCES	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TTS_SAM_INSTANCE		Table of modified S&AM instances	20070809
2	Importing	ID_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name of the node	20070809
3	Importing	ID_STATUS_VARIABLE	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TY_STATUS_VARIABLE		Name of the status variable	20070809
4	Importing	ITS_STATEGUARD_TRANSITIONS	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TTS_SAM_STATEGUARD_TRANSITIONS		Table of S&AM instances along with desired transitions	20070809

#	Exception	Resumable	Description	Created on
1	CX_SAM_INTERNAL_ERROR	☐	Exception class for system or metadata load	20070809
2	CX_SAM_PROCESSING_ERROR	☐	Exception class for operation processing	20070809

Method RETRIEVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ETS_FAILED_INSTANCES	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TTS_SAM_INSTANCE		Table of S&AM instances for which no data found	20070809
2	Exporting	ETS_SAM_INSTANCE_DATA	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TTS_SAM_INSTANCE_DATA		Table of S&AM instance data	20070809
3	Importing	ID_REQUESTED_IMAGE	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TY_IMAGE	IF_SAM_TYPES=>CO_IMAGE_TRANSACTIONAL_BUFFER	Type of dataset image to retrieve the data from	20070809
4	Importing	ITS_SAM_INSTANCES	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TTS_SAM_INSTANCE		Table of S&AM Instances	20070809

#	Exception	Resumable	Description	Created on
1	CX_SAM_INTERNAL_ERROR	☐	Exception class for system or metadata load error	20070809
2	CX_SAM_PROCESSING_ERROR	☐	Exception class for operation processing	20070809

Method RETRIEVE_ACTION_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ETS_ACTION_PROPERTIES	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TTS_ACTION_PROPERTIES		Table of S&AM action properties	20090805
2	Exporting	ETS_FAILED_INSTANCES	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TTS_SAM_INSTANCE		Table of S&AM instances for which no data found	20071030
3	Importing	ID_MODE	Call by reference	☐	Type reference (TYPE)	SAM_ACTION_TYPE		Specifies whether to return all actions or allowed actions	20070809
4	Importing	ID_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Node name of the instance	20070809
5	Importing	ID_REQUESTED_IMAGE	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TY_IMAGE	IF_SAM_TYPES=>CO_IMAGE_TRANSACTIONAL_BUFFER	Type of dataset image to retrieve the data from	20070809
6	Importing	IT_NODE_IDS	Call by reference	☐	Type reference (TYPE)	SAM_NODE_ID_TAB		Table of S&AM instances	20070810

#	Exception	Resumable	Description	Created on
1	CX_SAM_INTERNAL_ERROR	☐	Exception class for system or metadata load error	20070809
2	CX_SAM_PROCESSING_ERROR	☐	Exception class for operation processing	20070809

Method RETRIEVE_INSTANCE_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ETS_FAILED_INSTANCES	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TTS_SAM_INSTANCE			20100622
2	Exporting	ET_INSTANCE_PROPERTIES	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TY_PROPERTIES			20100622
3	Importing	ID_MODE	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TY_MODE			20100622
4	Importing	ID_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100622
5	Importing	ID_REQUESTED_IMAGE	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TY_IMAGE	IF_SAM_TYPES=>CO_IMAGE_TRANSACTIONAL_BUFFER		20100622
6	Importing	IT_NODE_IDS	Call by reference	☐	Type reference (TYPE)	SAM_NODE_ID_TAB			20100622

#	Exception	Resumable	Description	Created on
1	CX_SAM_INTERNAL_ERROR	☐		20100622
2	CX_SAM_PROCESSING_ERROR	☐		20100622

Method SWITCH_SEGMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ETS_MODIFIED_INSTANCES	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TTS_SAM_INSTANCE			20100622
2	Importing	ITS_SWITCH_SEGMENTS	Call by reference	☐	Type reference (TYPE)	IF_SAM_TYPES=>TTS_SAM_SWITCH_SEGMENTS			20100622

#	Exception	Resumable	Description	Created on
1	CX_SAM_INTERNAL_ERROR	☐		20100622
2	CX_SAM_PROCESSING_ERROR	☐		20100622

History

Last changed by/on	SAP	20110908
SAP Release Created in	710