SAP ABAP Interface IF_FEH_MODEL_PLOAD_HIERARCHY (IF_FEH_MODEL_PLOAD_HIERARCHY)

Hierarchy

☛ SAP_ABA (Software Component) Cross-Application Component
   ⤷ CA-FS-ECH (Application Component) Error and Conflict Handler
     ⤷ FEH_PAYLOAD_EDITOR (Package) FEH Payload Editor (UI)

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_FEH_MODEL_PLOAD_HIERARCHY	Hierarchy (Tree) Model for Data	20100415

Properties

Interface	IF_FEH_MODEL_PLOAD_HIERARCHY
Short Description

General Data

Package	FEH_PAYLOAD_EDITOR	FEH Payload Editor (UI)
Created	20100415	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	IF_ECH_DOCUMENT_STORE	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
3	IF_FEH_PAYLOAD_PROVIDER	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Interface IF_FEH_MODEL_PLOAD_HIERARCHY has no interface.

Friends

Interface IF_FEH_MODEL_PLOAD_HIERARCHY has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_SAVE_RESULT	Constant	Public	☐	See coding				20100901
2	GC_TABLE_LINE	Constant	Public	☐	Type reference (TYPE)	FIELDNAME	'TABLE_LINE'	Token for Row/Structure of an Unstructured Table	20100415

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_ATTACHMENT	Instance method	Public	Method		20101110
2	ARE_DATAREFERENCES	Instance method	Public	Method	Are Data References Included in the Model?	20100415
3	ARE_VERSIONS_ALLOWED	Instance method	Public	Method	Do Model or Provider Support Versioning?	20100415
4	CHANGE_PAYLOAD_NOTE	Instance method	Public	Method	Change the Note	20101222
5	CHANGE_PAYLOAD_REMARK	Instance method	Public	Method	Change the Comment	20101222
6	CHANGE_VALUE	Instance method	Public	Method	Change Field Value	20100415
7	COPY_LINE_OF_TABLE	Instance method	Public	Method	Copy Table Row	20100415
8	CREATE_INITIAL_LINE_FOR_TABLE	Instance method	Public	Method	Create an Empty Table Row	20100415
9	CREATE_TRANSIENT_VERSION	Instance method	Public	Method	Create Transient Version (from Current Version)	20101110
10	DELETE_ATTACHMENT	Instance method	Public	Method		20101110
11	DELETE_LINE_OF_TABLE	Instance method	Public	Method	Delete a Table Row	20100415
12	FREE	Instance method	Public	Method		20110505
13	GET_ATTACHMENTS	Instance method	Public	Method		20110119
14	GET_ATTACHMENTS_FOR_VERSION	Instance method	Public	Method		20110119
15	GET_DATA	Instance method	Public	Method	Get Model Data	20100415
16	GET_DATA_HIERARCHY	Instance method	Public	Method	Get Data as (Node) Hierarchy	20100415
17	GET_HIERARCHY_DATA_BY_NODEKEY	Instance method	Public	Method	Get Hierarchy Data for a Node ID	20100420
18	GET_HIGHEST_VERSION_NUMBER	Instance method	Public	Method		20100730
19	GET_PAYLOAD_VERSIONS_INFO	Instance method	Public	Method	Get Info Data for All Versions	20100415
20	GET_PAYLOAD_VERSION_INFO	Instance method	Public	Method	Get Info Data for a Specific Version	20100415
21	HAS_PAYLOAD_CHANGED	Instance method	Public	Method	Did You Change Data?	20100730
22	HAS_PAYLOAD_INFO_CHANGED	Instance method	Public	Method	Did you change info data (such as the comment)?	20100729
23	INSERT_NEW_LINE_INTO_TABLE	Instance method	Public	Method	Insert a New Table Row	20100415
24	IS_ATTACHMENT_NAME_FREE	Instance method	Public	Method		20101110
25	IS_LINE_INSERTION_IN_PROGRESS	Instance method	Public	Method		20100903
26	IS_VERSION_TRANSIENT	Instance method	Public	Method		20101110
27	LOAD_PAYLOAD	Instance method	Public	Method	Load Data (Latest Version)	20100415
28	LOAD_PAYLOAD_VERSION	Instance method	Public	Method	Load a Specific Version	20100415
29	REJECT_NEW_LINE_OF_TABLE	Instance method	Public	Method	Discard a New Table Row	20100415
30	RESET_PAYLOAD	Instance method	Public	Method	Reset Data	20100415
31	SAVE_PAYLOAD_AS_NEW_VERSION	Instance method	Public	Method		20100730
32	SET_READ_ONLY	Instance method	Public	Method	Switch Change Mode On or Off	20100831
33	UPDATE_PAYLOAD_VERSION	Instance method	Public	Method		20100802

Events

Interface IF_FEH_MODEL_PLOAD_HIERARCHY has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TS_DATA_HIERARCHY	Public	See coding		Structure Type for Data Hierarchy	20100415	begin of ts_data_hierarchy, node_key type tv_nodekey, parent_node_key type tv_nodekey, record_index type sytabix, has_changed type xfeld, component type fieldname, protected type abap_bool, ref_type_descr type ref to cl_abap_datadescr, ref_data type ref to data, corearea type abap_bool, cnt_to_references type i, node_key_references type tv_nodekey, children_have_refs type abap_bool, end of ts_data_hierarchy
2	TT_DATA_HIERARCHY	Public	See coding		Table Type for Data Hierarchy	20100415	tt_data_hierarchy type standard table of ts_data_hierarchy with key node_key with non-unique sorted key parent_node components parent_node_key
3	TY_SAVE_RESULT	Public	See coding			20100901	TY_SAVE_RESULT type c length 1

Method Signatures

Method ADD_ATTACHMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_ATTACHMENT	Call by reference	☐	Type reference (TYPE)	IF_ECH_DOCUMENT_STORE=>TS_ATTACHMENT_WRITE			20101110

#	Exception	Resumable	Description	Created on
1	CX_NWECM	☐	ECMI: Base Exception	20101110

Method ARE_DATAREFERENCES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ARE_DATAREFERENCES	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		RV_ARE_DATAREFERENCES	20100415

Method ARE_DATAREFERENCES on Interface IF_FEH_MODEL_PLOAD_HIERARCHY has no exception.

Method ARE_VERSIONS_ALLOWED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_VERSIONS_ALLOWED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		RV_VERSIONS_ALLOWED	20100415

Method ARE_VERSIONS_ALLOWED on Interface IF_FEH_MODEL_PLOAD_HIERARCHY has no exception.

Method CHANGE_PAYLOAD_NOTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_PAYLOAD_NOTE	Call by reference	☐	Type reference (TYPE)	FEH_PAYLOAD_NOTE		Notiz	20101222

Method CHANGE_PAYLOAD_NOTE on Interface IF_FEH_MODEL_PLOAD_HIERARCHY has no exception.

Method CHANGE_PAYLOAD_REMARK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_PAYLOAD_REMARK	Call by reference	☐	Type reference (TYPE)	FEH_PAYLOAD_REMARK		Kommentar	20101222

Method CHANGE_PAYLOAD_REMARK on Interface IF_FEH_MODEL_PLOAD_HIERARCHY has no exception.

Method CHANGE_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DATA	Call by reference	☐	Type reference (TYPE)	ANY		IV_DATA	20100415
2	Importing	IV_NODE_KEY	Call by reference	☐	Type reference (TYPE)	TV_NODEKEY		IV_NODE_KEY	20100415

#	Exception	Resumable	Description	Created on
1	CX_FEH_MODEL_FLD_IS_PROTECTED	☐		20100415
2	CX_FEH_MODEL_NODE_KEY_ERROR	☐		20100415
3	CX_FEH_MODEL_NODE_NOT_FOUND	☐		20100415
4	CX_FEH_MODEL_NODE_TYPE_ERROR	☐		20100415

Method COPY_LINE_OF_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NODE_KEY	Call by reference	☐	Type reference (TYPE)	TV_NODEKEY		IV_NODE_KEY	20100415
2	Returning	RT_DATA_HIERARCHY	Value transfer	☐	Type reference (TYPE)	TT_DATA_HIERARCHY		RT_DATA_HIERARCHY	20100415

#	Exception	Resumable	Description	Created on
1	CX_FEH_MODEL_IN_INSERT_MODE	☐		20100415
2	CX_FEH_MODEL_NODE_KEY_ERROR	☐		20100415
3	CX_FEH_MODEL_NODE_NOT_FOUND	☐		20100415
4	CX_FEH_MODEL_NODE_TYPE_ERROR	☐		20100415

Method CREATE_INITIAL_LINE_FOR_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NODE_KEY	Call by reference	☐	Type reference (TYPE)	TV_NODEKEY		IV_NODE_KEY	20100415
2	Returning	RT_DATA_HIERARCHY	Value transfer	☐	Type reference (TYPE)	TT_DATA_HIERARCHY		RT_DATA_HIERARCHY	20100415

#	Exception	Resumable	Description	Created on
1	CX_FEH_MODEL_IN_INSERT_MODE	☐		20100415
2	CX_FEH_MODEL_NODE_KEY_ERROR	☐		20100415
3	CX_FEH_MODEL_NODE_NOT_FOUND	☐		20100415
4	CX_FEH_MODEL_NODE_TYPE_ERROR	☐		20100415

Method CREATE_TRANSIENT_VERSION Signature

Method CREATE_TRANSIENT_VERSION on Interface IF_FEH_MODEL_PLOAD_HIERARCHY has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_NWECM	☐	ECMI: Base Exception	20101111

Method DELETE_ATTACHMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ATTACHMENT_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20101110

#	Exception	Resumable	Description	Created on
1	CX_NWECM	☐	ECMI: Base Exception	20101110

Method DELETE_LINE_OF_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NODE_KEY	Call by reference	☐	Type reference (TYPE)	TV_NODEKEY		IV_NODE_KEY	20100415
2	Returning	RT_DATA_HIERARCHY	Value transfer	☐	Type reference (TYPE)	TT_DATA_HIERARCHY		RT_DATA_HIERARCHY	20100415

#	Exception	Resumable	Description	Created on
1	CX_FEH_MODEL_IN_INSERT_MODE	☐		20100415
2	CX_FEH_MODEL_NODE_KEY_ERROR	☐		20100415
3	CX_FEH_MODEL_NODE_NOT_FOUND	☐		20100415
4	CX_FEH_MODEL_NODE_TYPE_ERROR	☐		20100415

Method FREE Signature

Method FREE on Interface IF_FEH_MODEL_PLOAD_HIERARCHY has no parameter.
Method FREE on Interface IF_FEH_MODEL_PLOAD_HIERARCHY has no exception.

Method GET_ATTACHMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_ATTACHMENT	Value transfer	☐	Type reference (TYPE)	IF_ECH_DOCUMENT_STORE=>TT_ATTACHMENT_READ			20110119

#	Exception	Resumable	Description	Created on
1	CX_NWECM	☐		20110121

Method GET_ATTACHMENTS_FOR_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_ATTACHMENT	Value transfer	☐	Type reference (TYPE)	IF_ECH_DOCUMENT_STORE=>TT_ATTACHMENT_READ			20110119

#	Exception	Resumable	Description	Created on
1	CX_NWECM	☐	ECMI: Base Exception	20110119

Method GET_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_DATA	Value transfer	☐	Object reference (TYPE REF TO)	DATA		RR_DATA	20100415

Method GET_DATA on Interface IF_FEH_MODEL_PLOAD_HIERARCHY has no exception.

Method GET_DATA_HIERARCHY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_DATA_HIERARCHY	Value transfer	☐	Type reference (TYPE)	TT_DATA_HIERARCHY		RT_DATA_HIERARCHY	20100415

Method GET_DATA_HIERARCHY on Interface IF_FEH_MODEL_PLOAD_HIERARCHY has no exception.

Method GET_HIERARCHY_DATA_BY_NODEKEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NODEKEY	Call by reference	☐	Type reference (TYPE)	TV_NODEKEY		Tree Control: Schlüssel eines Knotens	20100420
2	Returning	RS_DATA	Value transfer	☐	Type reference (TYPE)	TS_DATA_HIERARCHY		Hierarchiedaten eines Knotens	20100420

#	Exception	Resumable	Description	Created on
1	CX_FEH_MODEL_NODE_KEY_ERROR	☐	Ausnahme: Ungültige Knoten ID	20100420

Method GET_HIGHEST_VERSION_NUMBER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_HIGHEST_VERSION	Value transfer	☐	Type reference (TYPE)	FEH_VERSION		Version des FEH-Payload	20100730

Method GET_HIGHEST_VERSION_NUMBER on Interface IF_FEH_MODEL_PLOAD_HIERARCHY has no exception.

Method GET_PAYLOAD_VERSIONS_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_PAYLOAD_VERSIONS	Value transfer	☐	Type reference (TYPE)	IF_FEH_PAYLOAD_PROVIDER=>TY_T_VERSION_INFO		RT_PAYLOAD_VERSIONS	20100415

#	Exception	Resumable	Description	Created on
1	CX_FEH_PAYLOAD_PROVIDER	☐	CX_FEH_PAYLOAD_PROVIDER	20100415

Method GET_PAYLOAD_VERSION_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_PAYLOAD_VERSION_INFO	Value transfer	☐	Type reference (TYPE)	IF_FEH_PAYLOAD_PROVIDER=>TY_S_VERSION_INFO		RS_PAYLOAD_VERSION_INFO	20100415

Method GET_PAYLOAD_VERSION_INFO on Interface IF_FEH_MODEL_PLOAD_HIERARCHY has no exception.

Method HAS_PAYLOAD_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_IS_CHANGED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		RV_IS_CHANGED	20100730

Method HAS_PAYLOAD_CHANGED on Interface IF_FEH_MODEL_PLOAD_HIERARCHY has no exception.

Method HAS_PAYLOAD_INFO_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_IS_CHANGED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20100729

Method HAS_PAYLOAD_INFO_CHANGED on Interface IF_FEH_MODEL_PLOAD_HIERARCHY has no exception.

Method INSERT_NEW_LINE_INTO_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DATA_HIERARCHY_DELETED	Call by reference	☐	Type reference (TYPE)	TT_DATA_HIERARCHY		ET_DATA_HIERARCHY_DELETED	20100415
2	Exporting	ET_DATA_HIERARCHY_INSERTED	Call by reference	☐	Type reference (TYPE)	TT_DATA_HIERARCHY		ET_DATA_HIERARCHY_INSERTED	20100415
3	Exporting	EV_LINE_INSERTED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		EV_LINE_INSERTED	20100415

#	Exception	Resumable	Description	Created on
1	CX_FEH_MODEL_IN_INSERT_MODE	☐		20100415
2	CX_FEH_MODEL_NODE_NOT_FOUND	☐		20100415

Method IS_ATTACHMENT_NAME_FREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ATTACHMENT_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20101110
2	Returning	RV_FREE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20101110

#	Exception	Resumable	Description	Created on
1	CX_NWECM	☐	ECMI: Base Exception	20101110

Method IS_LINE_INSERTION_IN_PROGRESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20100903

Method IS_LINE_INSERTION_IN_PROGRESS on Interface IF_FEH_MODEL_PLOAD_HIERARCHY has no exception.

Method IS_VERSION_TRANSIENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TRANSIENT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20101110

Method IS_VERSION_TRANSIENT on Interface IF_FEH_MODEL_PLOAD_HIERARCHY has no exception.

Method LOAD_PAYLOAD Signature

Method LOAD_PAYLOAD on Interface IF_FEH_MODEL_PLOAD_HIERARCHY has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_FEH_MODEL_IN_INSERT_MODE	☐		20100415
2	CX_FEH_PAYLOAD_PROVIDER	☐	CX_FEH_PAYLOAD_PROVIDER	20100415

Method LOAD_PAYLOAD_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_VERSION	Call by reference	☐	Type reference (TYPE)	FEH_VERSION			20100415

#	Exception	Resumable	Description	Created on
1	CX_FEH_MODEL_IN_INSERT_MODE	☐		20101129
2	CX_FEH_PAYLOAD_PROVIDER	☐		20100415

Method REJECT_NEW_LINE_OF_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_DATA_HIERARCHY	Value transfer	☐	Type reference (TYPE)	TT_DATA_HIERARCHY		RT_DATA_HIERARCHY	20100415

#	Exception	Resumable	Description	Created on
1	CX_FEH_PAYLOAD_EDITOR_FAILURE	☐	CX_FEH_PAYLOAD_EDITOR_FAILURE	20100415

Method RESET_PAYLOAD Signature

Method RESET_PAYLOAD on Interface IF_FEH_MODEL_PLOAD_HIERARCHY has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_NWECM	☐		20110126

Method SAVE_PAYLOAD_AS_NEW_VERSION Signature

Method SAVE_PAYLOAD_AS_NEW_VERSION on Interface IF_FEH_MODEL_PLOAD_HIERARCHY has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_FEH_PAYLOAD_PROVIDER	☐	Aktion nicht unterstützt vom Payload Provider	20120321
2	CX_FEH_PE_SAVE_NOT_ALLOWED	☐	Sichern nicht möglich	20101103
3	CX_NWECM	☐	ECMI: Base Exception	20101103

Method SET_READ_ONLY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_READ_ONLY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		IV_READ_ONLY	20100831

Method SET_READ_ONLY on Interface IF_FEH_MODEL_PLOAD_HIERARCHY has no exception.

Method UPDATE_PAYLOAD_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_SAVE_RESULT	Value transfer	☐	Type reference (TYPE)	TY_SAVE_RESULT			20100901

#	Exception	Resumable	Description	Created on
1	CX_FEH_MODEL_IN_INSERT_MODE	☐		20100802
2	CX_FEH_PAYLOAD_PROVIDER	☐	CX_FEH_PAYLOAD_PROVIDER	20100802
3	CX_FEH_PE_SAVE_NOT_ALLOWED	☐	Sichern nicht möglich	20100928
4	CX_NWECM	☐	ECMI: Base Exception	20101103

History

Last changed by/on	SAP	20130531
SAP Release Created in	730