SAP ABAP Class IF_EPM_ATTACHMENT_HEADER (EPM: Attachment Header Node Interface)
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Interface composition (i COMPRISING i_ref)  IF_EPM_ATTACHMENT EPM: Attachment BO Interface 20091209
2 Interface implementation (CLASS c. INTERFACES i_ref)  CL_EPM_ATTACHMENT EPM: Business Object Attachment 20091215
Properties
Class IF_EPM_ATTACHMENT_HEADER  
Short Description EPM: Attachment Header Node Interface    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package      
Created 20091209   SAP 
Last change 20110908   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
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_EPM_ATTACHMENT Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
3 IF_EPM_ATTACHMENT_HEADER Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
4 IF_EPM_BO Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
5 IF_EPM_PRODUCT Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
6 IF_EPM_PRODUCT_HEADER Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
Interfaces
Class IF_EPM_ATTACHMENT_HEADER has no interface implemented.
Friends
Class IF_EPM_ATTACHMENT_HEADER has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 GC_BO_NAME Constant Public Type reference (TYPE) IF_EPM_BO=>TY_BO_NAME IF_EPM_ATTACHMENT=>GC_BO_NAME The BO name 20091209
2 GC_BO_NODE_NAME Constant Public Type reference (TYPE) IF_EPM_BO=>TY_BO_NODE_NAME 'IF_EPM_ATTACHMENT_HEADER' The BO node name 20091209
3 GC_CREATE Constant Public Type reference (TYPE) IF_EPM_BO=>TY_TABLE_FIELD_NAME 'CREATE' Type of a table field name 20091209
4 GC_DB_TABLE_NAME Constant Public Type reference (TYPE) IF_EPM_BO=>TY_DB_TABLE_NAME 'SNWD_ECMA' Type of a data base table name 20091209
5 GC_DELETE Constant Public Type reference (TYPE) IF_EPM_BO=>TY_TABLE_FIELD_NAME 'DELETE' Type of a table field name 20091209
6 GC_FIELD_NAME_CHANGED_BY_USER Constant Public Type reference (TYPE) IF_EPM_BO=>TY_TABLE_FIELD_NAME 'CHANGED_BY_USER' Type of a table field name 20091209
7 GC_FIELD_NAME_CHANGE_DATE_TIME Constant Public Type reference (TYPE) IF_EPM_BO=>TY_TABLE_FIELD_NAME 'CHANGED_TSTAMP' Type of a table field name 20091209
8 GC_FIELD_NAME_CONSUMER_NKEY Constant Public Type reference (TYPE) IF_EPM_BO=>TY_TABLE_FIELD_NAME 'CONS_NODE_KEY' Type of a table field name 20091209
9 GC_FIELD_NAME_CONSUMER_NODE Constant Public Type reference (TYPE) IF_EPM_BO=>TY_TABLE_FIELD_NAME 'CONS_NODE_NAME' Type of a table field name 20091209
10 GC_FIELD_NAME_CONTENT_SIZE Constant Public Type reference (TYPE) IF_EPM_BO=>TY_TABLE_FIELD_NAME 'CONTENT_SIZE' Type of a table field name 20091209
11 GC_FIELD_NAME_CONTENT_URL Constant Public Type reference (TYPE) IF_EPM_BO=>TY_TABLE_FIELD_NAME 'CONTENT_URL' Type of a table field name 20091209
12 GC_FIELD_NAME_CREATED_BY_USER Constant Public Type reference (TYPE) IF_EPM_BO=>TY_TABLE_FIELD_NAME 'CREATED_BY_USER' Type of a table field name 20091209
13 GC_FIELD_NAME_CREA_DATE_TIME Constant Public Type reference (TYPE) IF_EPM_BO=>TY_TABLE_FIELD_NAME 'CREATED_TSTAMP' Type of a table field name 20091209
14 GC_FIELD_NAME_DISPLAY_NAME Constant Public Type reference (TYPE) IF_EPM_BO=>TY_TABLE_FIELD_NAME 'DISPLAY_NAME' Type of a table field name 20091209
15 GC_FIELD_NAME_ECM_ID Constant Public Type reference (TYPE) IF_EPM_BO=>TY_TABLE_FIELD_NAME 'ECM_ID' Type of a table field name 20091209
16 GC_FIELD_NAME_IS_FOLDER Constant Public Type reference (TYPE) IF_EPM_BO=>TY_TABLE_FIELD_NAME 'IS_FOLDER' Type of a table field name 20091209
17 GC_FIELD_NAME_IS_HIDDEN Constant Public Type reference (TYPE) IF_EPM_BO=>TY_TABLE_FIELD_NAME 'IS_HIDDEN' Type of a table field name 20091209
18 GC_FIELD_NAME_IS_READ_ONLY Constant Public Type reference (TYPE) IF_EPM_BO=>TY_TABLE_FIELD_NAME 'IS_READ_ONLY' Type of a table field name 20091209
19 GC_FIELD_NAME_IS_SYSTEM Constant Public Type reference (TYPE) IF_EPM_BO=>TY_TABLE_FIELD_NAME 'IS_SYSTEM' Type of a table field name 20091215
20 GC_FIELD_NAME_MIME_TYPE Constant Public Type reference (TYPE) IF_EPM_BO=>TY_TABLE_FIELD_NAME 'MIME_TYPE' Type of a table field name 20091209
21 GC_FIELD_NAME_PARENT_FOLDER Constant Public Type reference (TYPE) IF_EPM_BO=>TY_TABLE_FIELD_NAME 'PARENT_FOLDER' Type of a table field name 20091218
22 GC_FIELD_NAME_PATH Constant Public Type reference (TYPE) IF_EPM_BO=>TY_TABLE_FIELD_NAME 'PATH' Type of a table field name 20091209
23 GC_FIELD_NAME_PRIM_NODE_TYPE Constant Public Type reference (TYPE) IF_EPM_BO=>TY_TABLE_FIELD_NAME 'PRIMARY_NODE_TYP' Type of a table field name 20091209
24 GC_PARENT_BO_NODE_NAME Constant Public Type reference (TYPE) IF_EPM_BO=>TY_BO_NODE_NAME SPACE The BO node name 20091209
25 GC_RETRIEVE Constant Public Type reference (TYPE) IF_EPM_BO=>TY_TABLE_FIELD_NAME 'RETRIEVE' Type of a table field name 20091209
26 GC_UPDATE Constant Public Type reference (TYPE) IF_EPM_BO=>TY_TABLE_FIELD_NAME 'UPDATE' Type of a table field name 20091209
Methods
# Method Level Visibility Method type Description Created on
1 ACTION_CONSISTENCY_CHECK Instance method Public Method Consistency check: attachments ( folders ) <=> consumers 20091215
2 ACTION_UPLOAD_CONTENT Instance method Public Method Upload attachment content to a Content Management System 20091222
3 CREATE Instance method Public Method CREATE a node element 20091215
4 DELETE Instance method Public Method DELETE a set of node elements 20091215
5 GET_VALID_CHARACTER_SET Instance method Public Method Get valid character set from Content Management System 20091215
6 NAVIGATE_TO_CHILDREN Instance method Public Method Navigate to child node elements 20091215
7 NAVIGATE_TO_PARENT Instance method Public Method Navigate to parent node elements 20091215
8 QUERY_BY_HEADER Instance method Public Method Query node elements according to node field criteria 20091215
9 RETRIEVE Instance method Public Method RETRIEVE a set of node elements 20091215
10 UPDATE Instance method Public Method UPDATE a set of node elements 20091215
Events
Class IF_EPM_ATTACHMENT_HEADER has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 TT_NODE_DATA Public See coding Table of attachment header node elements 20091209 tt_node_data type standard table of ty_node_data with default key
2 TT_PARAMS_CONTENT_UPLOAD Public See coding 20091222 tt_params_content_upload type standard table of ty_param_content_upload with default key
3 TT_SEL_PAR_CONSUMERS Public See coding Query selection parameter: Attachment consumers 20091215 tt_sel_par_consumers type range of if_epm_bo=>ty_bo_node_name
4 TT_SEL_PAR_CONTENT_SIZES Public See coding Query selection parameter: Attachment content sizes 20091215 tt_sel_par_content_sizes type range of snwd_size
5 TT_SEL_PAR_DATES Public See coding Query selection parameter: Attachment Dates 20091215 tt_sel_par_dates type range of sydatum
6 TT_SEL_PAR_DISPLAY_NAMES Public See coding Query selection parameter: Attachment (folder) display names 20091215 tt_sel_par_display_names type range of snwd_string
7 TT_SEL_PAR_MIME_TYPES Public See coding Query selection parameter: Attachment Mime types 20091215 tt_sel_par_mime_types type range of snwd_string
8 TT_SEL_PAR_USER_NAMES Public See coding Query selection parameter: Attachment User names 20091215 tt_sel_par_user_names type range of snwd_id
9 TY_NODE_DATA Public Type reference (TYPE) SNWD_ECMA Attachment header node element structure 20091209
10 TY_PARAMS_CONSISTENCY_CHECK Public See coding Parameters for action 'ACTION_CONSISTENCY_CHECK' 20091215 begin of ty_params_consistency_check, cleanup_inconsistencies type abap_bool, end of ty_params_consistency_check
11 TY_PARAM_CONTENT_UPLOAD Public See coding 20091222 begin of ty_param_content_upload, node_key type snwd_node_key, content type ref to snwd_xstring, end of ty_param_content_upload
Method Signatures

Method ACTION_CONSISTENCY_CHECK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_DATA Call by reference Type reference (TYPE) TT_NODE_DATA Table of attachment header node elements 20091215
2 Exporting ET_NODE_KEY_INFO Call by reference Type reference (TYPE) IF_EPM_BO=>TT_NODE_KEY_INFO Set of node element specific operation information 20091215
3 Importing II_MESSAGE_BUFFER Call by reference Object reference (TYPE REF TO) IF_EPM_MESSAGE_BUFFER EPM: Message buffer interface 20091215
4 Importing IS_ACTION_PARAMETERS Call by reference Type reference (TYPE) TY_PARAMS_CONSISTENCY_CHECK Parameters for action 'ACTION_CONSISTENCY_CHECK' 20091215
5 Importing IT_NODE_KEYS Call by reference Type reference (TYPE) IF_EPM_BO=>TT_NODE_KEYS Set of generic node element keys 20091215
# Exception Resumable Description Created on
1 CX_EPM_API_EXCEPTION EPM: API exception class 20091215
2 CX_EPM_SYSTEM_EXCEPTION EPM: System exception class 20091215

Method ACTION_UPLOAD_CONTENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_DATA Call by reference Type reference (TYPE) TT_NODE_DATA Table of attachment header node elements 20091222
2 Exporting ET_NODE_KEY_INFO Call by reference Type reference (TYPE) IF_EPM_BO=>TT_NODE_KEY_INFO Set of node element specific operation information 20091222
3 Importing II_MESSAGE_BUFFER Call by reference Object reference (TYPE REF TO) IF_EPM_MESSAGE_BUFFER EPM: Message buffer interface 20091222
4 Importing IT_ACTION_PARAMETERS Call by reference Type reference (TYPE) TT_PARAMS_CONTENT_UPLOAD Action parameters ( node keys + content ) 20091222
# Exception Resumable Description Created on
1 CX_EPM_API_EXCEPTION EPM: API exception class 20091222
2 CX_EPM_SYSTEM_EXCEPTION EPM: System exception class 20091222

Method CREATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_DATA Call by reference Type reference (TYPE) TY_NODE_DATA EPM: Attachment Header Table 20091215
2 Exporting ET_PROPERTIES Call by reference Type reference (TYPE) IF_EPM_BO=>TT_PROPERTIES Property Handling: Properties 20091215
3 Exporting EV_SUCCESS Call by reference Type reference (TYPE) ABAP_BOOL Flag: Operation was successful (yes/no) 20091215
4 Importing II_MESSAGE_BUFFER Call by reference Object reference (TYPE REF TO) IF_EPM_MESSAGE_BUFFER EPM: Message buffer interface 20091215
5 Importing IV_CONSUMER_NODE_KEY Call by reference Type reference (TYPE) SNWD_NODE_KEY EPM: Generic Node Key 20091218
6 Importing IV_CONSUMER_NODE_NAME Call by reference Type reference (TYPE) IF_EPM_BO=>TY_BO_NODE_NAME The BO node name 20091218
7 Importing IV_DISPLAY_NAME Call by reference Type reference (TYPE) SNWD_STRING EPM: String 20091218
8 Importing IV_IS_FOLDER Call by reference Type reference (TYPE) SNWD_BOOL Flag: Is folder (yes/no) 20091218
9 Importing IV_PARENT_FOLDER_KEY Call by reference Type reference (TYPE) SNWD_NODE_KEY EPM: Generic Node Key 20091218
# Exception Resumable Description Created on
1 CX_EPM_API_EXCEPTION EPM: API exception class 20091215
2 CX_EPM_SYSTEM_EXCEPTION EPM: System exception class 20091215

Method DELETE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_NODE_KEY_INFO Call by reference Type reference (TYPE) IF_EPM_BO=>TT_NODE_KEY_INFO Set of node element specific operation information 20091215
2 Importing II_MESSAGE_BUFFER Call by reference Object reference (TYPE REF TO) IF_EPM_MESSAGE_BUFFER EPM: Message buffer interface 20091215
3 Importing IT_NODE_KEYS Call by reference Type reference (TYPE) IF_EPM_BO=>TT_NODE_KEYS Set of node element keys 20091215
# Exception Resumable Description Created on
1 CX_EPM_API_EXCEPTION EPM: API exception class 20091215
2 CX_EPM_SYSTEM_EXCEPTION EPM: System exception class 20091215

Method GET_VALID_CHARACTER_SET Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_VALID_CHARACTER_SET Value transfer Type reference (TYPE) SNWD_STRING The set of valid characters accepted by the CMS 20091215
# Exception Resumable Description Created on
1 CX_EPM_SYSTEM_EXCEPTION EPM: System exception class 20091215

Method NAVIGATE_TO_CHILDREN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_DATA Call by reference Type reference (TYPE) IF_EPM_ATTACHMENT_HEADER=>TT_NODE_DATA Table of attachment header node elements 20091215
2 Exporting ET_LINK_TABLE Call by reference Type reference (TYPE) IF_EPM_BO=>TT_NODE_KEY_LINKS Set of association links (source => target node elements) 20091215
3 Exporting ET_PROPERTIES Call by reference Type reference (TYPE) IF_EPM_BO=>TT_PROPERTIES Property Handling: Properties 20091218
4 Importing II_MESSAGE_BUFFER Call by reference Object reference (TYPE REF TO) IF_EPM_MESSAGE_BUFFER EPM: Message buffer interface 20091215
5 Importing IT_SOURCE_NODE_KEYS Call by reference Type reference (TYPE) IF_EPM_BO=>TT_NODE_KEYS Set of generic node element keys 20091215
6 Importing IV_EDIT_MODE Call by reference Type reference (TYPE) IF_EPM_BO=>TY_EDIT_MODE IF_EPM_BO=>GC_READ_ONLY Edit mode of a BO node element 20091215
# Exception Resumable Description Created on
1 CX_EPM_API_EXCEPTION EPM: API exception class 20091215
2 CX_EPM_SYSTEM_EXCEPTION EPM: System exception class 20091215

Method NAVIGATE_TO_PARENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_DATA Call by reference Type reference (TYPE) IF_EPM_ATTACHMENT_HEADER=>TT_NODE_DATA Table of attachment header node elements 20091215
2 Exporting ET_LINK_TABLE Call by reference Type reference (TYPE) IF_EPM_BO=>TT_NODE_KEY_LINKS Set of association links (source => target node elements) 20091215
3 Exporting ET_PROPERTIES Call by reference Type reference (TYPE) IF_EPM_BO=>TT_PROPERTIES Property Handling: Properties 20091218
4 Importing II_MESSAGE_BUFFER Call by reference Object reference (TYPE REF TO) IF_EPM_MESSAGE_BUFFER EPM: Message buffer interface 20091215
5 Importing IT_SOURCE_NODE_KEYS Call by reference Type reference (TYPE) IF_EPM_BO=>TT_NODE_KEYS Set of generic node element keys 20091215
6 Importing IV_EDIT_MODE Call by reference Type reference (TYPE) IF_EPM_BO=>TY_EDIT_MODE IF_EPM_BO=>GC_READ_ONLY Edit mode of a BO node element 20091215
# Exception Resumable Description Created on
1 CX_EPM_API_EXCEPTION EPM: API exception class 20091215
2 CX_EPM_SYSTEM_EXCEPTION EPM: System exception class 20091215

Method QUERY_BY_HEADER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_DATA Call by reference Type reference (TYPE) TT_NODE_DATA Table of node element data that match the selection criteria 20091215
2 Exporting ET_NODE_KEYS Call by reference Type reference (TYPE) IF_EPM_BO=>TT_NODE_KEYS Node keys of node elements that match the selection criteria 20091215
3 Exporting EV_NR_OF_ROWS_FOUND Call by reference Type reference (TYPE) IF_EPM_BO=>TY_QUERY_NR_OF_ROWS_FOUND Query: Size of overall query result set ( number of rows ) 20091215
4 Importing IS_PAGING_OPTIONS Call by reference Type reference (TYPE) IF_EPM_BO=>TY_QUERY_PAGING_OPTIONS Query: Paging options 20091215
5 Importing IT_SEL_PAR_CHANGED_BY_USERS Call by reference Type reference (TYPE) TT_SEL_PAR_USER_NAMES Query selection parameter: Attachment User names 20091215
6 Importing IT_SEL_PAR_CHANGE_DATES Call by reference Type reference (TYPE) TT_SEL_PAR_DATES Query selection parameter: Attachment Dates 20091215
7 Importing IT_SEL_PAR_CONSUMERS Call by reference Type reference (TYPE) TT_SEL_PAR_CONSUMERS Query selection parameter: Attachment consumers 20091215
8 Importing IT_SEL_PAR_CONTENT_SIZES Call by reference Type reference (TYPE) TT_SEL_PAR_CONTENT_SIZES Query selection parameter: Attachment content sizes 20091215
9 Importing IT_SEL_PAR_CREATED_BY_USERS Call by reference Type reference (TYPE) TT_SEL_PAR_USER_NAMES Query selection parameter: Attachment User names 20091215
10 Importing IT_SEL_PAR_CREATE_DATES Call by reference Type reference (TYPE) TT_SEL_PAR_DATES Query selection parameter: Attachment Dates 20091215
11 Importing IT_SEL_PAR_DISPLAY_NAMES Call by reference Type reference (TYPE) TT_SEL_PAR_DISPLAY_NAMES Query selection parameter: Attachment (folder) display names 20091215
12 Importing IT_SEL_PAR_MIME_TYPES Call by reference Type reference (TYPE) TT_SEL_PAR_MIME_TYPES Query selection parameter: Attachment Mime types 20091215
13 Importing IT_SORTING_OPTIONS Call by reference Type reference (TYPE) IF_EPM_BO=>TT_QUERY_SORT_OPTIONS Query: Set of sorting options 20091215
14 Importing IV_MAX_ROWS Call by reference Type reference (TYPE) IF_EPM_BO=>TY_QUERY_MAX_ROWS IF_EPM_BO=>GC_DEFAULT_MAX_ROWS Query: Maximum number of rows to select 20091215
# Exception Resumable Description Created on
1 CX_EPM_API_EXCEPTION EPM: API exception class 20091215
2 CX_EPM_SYSTEM_EXCEPTION EPM: System exception class 20091215

Method RETRIEVE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_DATA Call by reference Type reference (TYPE) TT_NODE_DATA Set of attachment header node element data 20091215
2 Exporting ET_FAILED_KEYS Call by reference Type reference (TYPE) IF_EPM_BO=>TT_NODE_KEYS Set of node element keys 20091215
3 Exporting ET_PROPERTIES Call by reference Type reference (TYPE) IF_EPM_BO=>TT_PROPERTIES Set of node element properties 20091215
4 Importing II_MESSAGE_BUFFER Call by reference Object reference (TYPE REF TO) IF_EPM_MESSAGE_BUFFER EPM: Message buffer interface 20091215
5 Importing IT_NODE_KEYS Call by reference Type reference (TYPE) IF_EPM_BO=>TT_NODE_KEYS Set of node element keys 20091215
6 Importing IV_EDIT_MODE Call by reference Type reference (TYPE) IF_EPM_BO=>TY_EDIT_MODE IF_EPM_BO=>GC_READ_ONLY Edit mode of a BO node element 20091215
# Exception Resumable Description Created on
1 CX_EPM_API_EXCEPTION EPM: API exception class 20091215
2 CX_EPM_SYSTEM_EXCEPTION EPM: System exception class 20091215

Method UPDATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_NODE_KEY_INFO Call by reference Type reference (TYPE) IF_EPM_BO=>TT_NODE_KEY_INFO Set of node element specific operation information 20091215
2 Importing II_MESSAGE_BUFFER Call by reference Object reference (TYPE REF TO) IF_EPM_MESSAGE_BUFFER EPM: Message buffer interface 20091215
3 Importing ITH_CHANGED_FIELDS Call by reference Type reference (TYPE) IF_EPM_BO=>TT_CHANGED_FIELDS Names of fields whose values have changed 20091215
4 Importing IT_DATA Call by reference Type reference (TYPE) TT_NODE_DATA Table of attachment header node elements 20091215
# Exception Resumable Description Created on
1 CX_EPM_API_EXCEPTION EPM: API exception class 20091215
2 CX_EPM_SYSTEM_EXCEPTION EPM: System exception class 20091215
History
Last changed by/on SAP  20110908 
SAP Release Created in