SAP ABAP Class /TDAG/CP_IMDS_AICL_BC_INTF (Batch Client Interface)
Hierarchy
TDAGBCA (Software Component) TechniData Basic Components
   EHS (Application Component) Environment, Health and Safety
     /TDAG/CP_IMDS_AI (Package) IMDS Advanced Interface Communication
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  /TDAG/CPIF_MSG_LOG Message Logger Interface 20100630
Properties
Class /TDAG/CP_IMDS_AICL_BC_INTF  
Short Description Batch Client Interface    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package /TDAG/CP_IMDS_AI   IMDS Advanced Interface Communication 
Created 20100617   SAP 
Last change 20141109    
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 /TDAG/CP_IMDSCL_ENV Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
2 ABAP Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
3 ESPPH Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
4 ESPRH Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
# Interface Abstract Final Description Created on
1 /TDAG/CPIF_MSG_LOG Message Logger Interface 20100630
Friends
Class /TDAG/CP_IMDS_AICL_BC_INTF has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 MC_ATTR_ERROR_CODE Constant Private Type reference (TYPE) STRING 'Error_Code' Attribute Error_Code 20100708
2 MC_ATTR_IMDSMODULEID Constant Private Type reference (TYPE) STRING 'IMDSModuleID' Attribute IMDSModuleID 20100708
3 MC_ATTR_IMDSNODEID Constant Private Type reference (TYPE) STRING 'IMDSNodeID' Attribute IMDSNodeID 20100708
4 MC_ATTR_IMDS_ID Instance attribute Private Type reference (TYPE) STRING 'IMDS_ID' Attribute IMDS_ID 20100622
5 MC_ATTR_LOC_KEYDEF Constant Private Type reference (TYPE) STRING 'LocalKeyDef' Attribute LocalKeyDef 20100629
6 MC_ATTR_LOC_KEYREF Constant Private Type reference (TYPE) STRING 'LocalKeyRef' Attribute LocalKeyRef 20100625
7 MC_ATTR_MESSAGE Constant Private Type reference (TYPE) STRING 'Message' Attribute Message 20100708
8 MC_ATTR_NAME Constant Private Type reference (TYPE) STRING 'Name' Attribute Name 20100628
9 MC_ATTR_REQUEST_ID Constant Private Type reference (TYPE) STRING 'Request_ID' Attribute name Request_ID 20100621
10 MC_ATTR_TYPE Constant Private Type reference (TYPE) STRING 'Type' Attribute Type 20100622
11 MC_ATTR_VERDICT Constant Private Type reference (TYPE) STRING 'Verdict' Attribute Verdict 20100708
12 MC_ATTR_VERSION Constant Private Type reference (TYPE) STRING 'Version' Attribute Version 20100708
13 MC_ATTR_WARNING_CODE Constant Private Type reference (TYPE) STRING 'Warning_Code' Attribute Warning_Code 20100708
14 MC_LANGU_DE Constant Private Type reference (TYPE) ESELANGU 'D' Language Key de 20100623
15 MC_LANGU_EN Constant Private Type reference (TYPE) ESELANGU 'E' Language Key en 20100623
16 MC_STATUS_EDIT Constant Private Type reference (TYPE) STRING 'Edit' Status Edit 20100629
17 MC_STATUS_INTERN Constant Private Type reference (TYPE) STRING 'Intern' Status Intern 20100629
18 MC_STATUS_PROPOSE Constant Private Type reference (TYPE) STRING 'Propose' Status Propose 20100629
19 MC_STATUS_PUBLIC Constant Private Type reference (TYPE) STRING 'Public' Status Public 20100629
20 MC_STATUS_SEND Constant Private Type reference (TYPE) STRING 'Send' Status Send 20100629
21 MC_TAG_ERROR Constant Private Type reference (TYPE) STRING 'Error' Tag Error 20100708
22 MC_TAG_RELEASECHECK Constant Private Type reference (TYPE) STRING 'ReleaseCheck' Tag ReleaseCheck 20100708
23 MC_TAG_RELEASEERROR Constant Private Type reference (TYPE) STRING 'ReleaseError' Tag ReleaseError 20100708
24 MC_TAG_RELEASEWARNING Constant Private Type reference (TYPE) STRING 'ReleaseWarning' Tag ReleaseWarning 20100708
25 MC_TAG_SUMMARY Constant Private Type reference (TYPE) STRING 'Summary' Tag Summary 20100708
26 MC_TAG_WARNING Constant Private Type reference (TYPE) STRING 'Warning' Tag Warning 20100708
27 MC_VALUE_NO Constant Private Type reference (TYPE) STRING 'No' Attribute value No 20100629
28 MC_VALUE_YES Constant Private Type reference (TYPE) STRING 'Yes' Attribute value Yes 20100629
29 MC_VERDICT_FAILURE Constant Private Type reference (TYPE) STRING 'Failure' Verdict Failure 20100708
30 MC_VERDICT_SUCCESS Constant Private Type reference (TYPE) STRING 'Success' Verdict Success 20100708
31 MO_IMDS_XML Instance attribute Private Object reference (TYPE REF TO) /TDAG/CP_IMDS_AICL_XML Instance of IMDS XML class 20100726
32 MO_MSG_LOG Instance attribute Protected Object reference (TYPE REF TO) /TDAG/CP_IMDSCL_DEF_MSG_LOG Message Log implementation 20100630
33 MR_IXML Instance attribute Private Object reference (TYPE REF TO) IF_IXML IXML Interface 20100621
34 MS_IMDS_SYST Instance attribute Private Type reference (TYPE) /TDAG/CPC_IMDSSY CP: IMDS system 20100617
35 MV_BOS_COUNT Static Attribute Private Type reference (TYPE) N Dummy Product counter 20100622
36 MV_BOS_KEY Static Attribute Private Type reference (TYPE) TV_NODEKEY 1000000 Generated BOS Key 20100622
37 MV_BOS_REGLIST Instance attribute Private Type reference (TYPE) /TDAG/CPE_REGLIST Reg List for BOS 20100622
38 MV_FLG_ABORT_ON_ERROR Instance attribute Private Type reference (TYPE) BOOLE_D Flag: Abort on error 20100628
39 MV_FLG_ERROR Instance attribute Private Type reference (TYPE) BOOLE_D Flag: An error occured 20100622
40 MV_FLG_STREAMLINE Instance attribute Private Type reference (TYPE) BOOLE_D Flag: Steamline active 20100621
41 MV_NORMVAR_INPUT Instance attribute Private Type reference (TYPE) /TDAG/CPS_NORMA_INPUT_FIELDS Normalization 20100625
42 MV_RFC_DEST Instance attribute Private Type reference (TYPE) RFCDEST Batch Client RFC Destination 20100617
43 MV_WEIGHT_TOLERANCE Instance attribute Private Type reference (TYPE) STRING '0' Weight tolerance value (customizing) 20100628
Methods
# Method Level Visibility Method type Description Created on
1 ADD_MESSAGE Instance method Public Method Upload a file to IMDS 20100630
2 BUILD_FILENAME Instance method Public Method Build a unique filename 20100701
3 CLEAR_MESSAGES Instance method Public Method Upload a file to IMDS 20100630
4 CONSTRUCTOR Instance method Public Constructor CONSTRUCTOR 20100617
5 CONVERT_FILE_TO_XSTRING Instance method Public Method Convert a file table to a XSTING value 20100708
6 CONVERT_XSTRING_TO_FILE Instance method Public Method Converts a XSTRING value to a file table 20100701
7 CREATE_BC_INTERFACE Instance method Public Method Create batch client interface 20120308
8 DELETE_RESULT_MARKERS Instance method Public Method Remove the supplied result markers 20100709
9 DELETE_UNWANTED_SIGNS Instance method Private Method remove unwanted signs from the supplied string 20100701
10 DOWNLOAD_RESULT_FILE Instance method Public Method Download the result file with the specified file name 20100708
11 DOWNLOAD_RESULT_FILE_ENTITY Instance method Public Method Download and return the result file for the specified entity 20100617
12 GET_MESSAGES Instance method Public Method Upload a file to IMDS 20100630
13 GET_RESULT_MARKERS Instance method Public Method Get the result markers for the supplied entities 20100708
14 HAS_ERROR Instance method Public Method Upload a file to IMDS 20100630
15 MARK_FILES_FOR_RESULT Instance method Public Method Mark the supplied upload file names for result file download 20100617
16 PARSE_ERROR_ELEMENT Instance method Private Method Parses an Error element 20100708
17 PARSE_RELEASE_CHECK_ELEMENT Instance method Private Method Parses an Error element 20100708
18 PARSE_RESULT_FILE Instance method Public Method Parses a result file 20100708
19 PARSE_SOURCE_ELEMENT Instance method Private Method Parses a source element of the reslut file 20100708
20 PARSE_WARNING_ELEMENT Instance method Private Method Parses a Warning element 20100708
21 REMOVE_DOCTYPE_FROM_XML Instance method Public Method Removes the DOCTYPE definition from an XML file 20101208
22 UPLOAD_FILE Instance method Public Method Upload a file to IMDS 20100618
Events
Class /TDAG/CP_IMDS_AICL_BC_INTF has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 LSY_HOMOMAT_BUFFER Private See coding linetype for homogenous material buffer 20100625 Begin of LSY_HOMOMAT_BUFFER, subid_homo TYPE esesubid, pure_decl_tab TYPE /tdag/cpys_pure_decl, message_tab TYPE /tdag/cpy_messages, END OF LSY_HOMOMAT_BUFFER
2 LTY_HOMOMAT_BUFFER Private See coding Homogenous material buffer 20100625 LTY_HOMOMAT_BUFFER TYPE HASHED TABLE OF LSY_HOMOMAT_BUFFER WITH UNIQUE KEY subid_homo
Method Signatures

Method ADD_MESSAGE Signature

Method ADD_MESSAGE on class /TDAG/CP_IMDS_AICL_BC_INTF has no parameter.
Method ADD_MESSAGE on class /TDAG/CP_IMDS_AICL_BC_INTF has no exception.

Method BUILD_FILENAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_REQID Call by reference Type reference (TYPE) /TDAG/CPE_REQ_ID Request ID 20101124
2 Importing IV_SUBID Call by reference Type reference (TYPE) ESESUBID Substance ID 20100701
3 Returning RV_FILENAME Value transfer Type reference (TYPE) STRING File name 20100701

Method BUILD_FILENAME on class /TDAG/CP_IMDS_AICL_BC_INTF has no exception.

Method CLEAR_MESSAGES Signature

Method CLEAR_MESSAGES on class /TDAG/CP_IMDS_AICL_BC_INTF has no parameter.
Method CLEAR_MESSAGES on class /TDAG/CP_IMDS_AICL_BC_INTF has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class /TDAG/CP_IMDS_AICL_BC_INTF has no parameter.
Method CONSTRUCTOR on class /TDAG/CP_IMDS_AICL_BC_INTF has no exception.

Method CONVERT_FILE_TO_XSTRING Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_XSTRING Call by reference Type reference (TYPE) XSTRING XString value 20100708
2 Importing IT_FILE Call by reference Type reference (TYPE) /TDAG/CPY_RCGREPFILE CP: Table for binary data 20100708
3 Importing IV_FILESIZE Call by reference Type reference (TYPE) ESENUMBYTE Size of a document in bytes 20100708

Method CONVERT_FILE_TO_XSTRING on class /TDAG/CP_IMDS_AICL_BC_INTF has no exception.

Method CONVERT_XSTRING_TO_FILE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_FILE Call by reference Type reference (TYPE) /TDAG/CPY_RCGREPFILE CP: Table for binary data 20100701
2 Exporting EV_FILESIZE Call by reference Type reference (TYPE) ESENUMBYTE Size of a document in bytes 20100701
3 Importing IV_XSTRING Call by reference Type reference (TYPE) XSTRING 20100701

Method CONVERT_XSTRING_TO_FILE on class /TDAG/CP_IMDS_AICL_BC_INTF has no exception.

Method CREATE_BC_INTERFACE Signature

Method CREATE_BC_INTERFACE on class /TDAG/CP_IMDS_AICL_BC_INTF has no parameter.
# Exception Resumable Description Created on
1 DESTINATION_NOT_ACTIVE The defined RFC Destination is not active 20120308
2 NO_IMDS_SYSTEM No active IMDS system defined 20120308
3 NO_RFC_DESTINATION RFC Destination for IMDS not defined 20120308

Method DELETE_RESULT_MARKERS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_ENTRIES Call by reference Type reference (TYPE) /TDAG/CPY_IMDS_RES_MARK Entries for result download 20100709
2 Importing IV_CH4_GUID Call by reference Type reference (TYPE) GUID CH4 GUID 20101020
3 Importing IV_MDS_GUID Call by reference Type reference (TYPE) GUID MDS GUID 20101020

Method DELETE_RESULT_MARKERS on class /TDAG/CP_IMDS_AICL_BC_INTF has no exception.

Method DELETE_UNWANTED_SIGNS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing XV_STRING Call by reference Type reference (TYPE) ANY String value 20100701

Method DELETE_UNWANTED_SIGNS on class /TDAG/CP_IMDS_AICL_BC_INTF has no exception.

Method DOWNLOAD_RESULT_FILE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_FILE Call by reference Type reference (TYPE) /TDAG/CPY_RCGREPFILE CP: Table for binary data 20100708
2 Exporting EV_FILESIZE Call by reference Type reference (TYPE) ESENUMBYTE Size of a document in bytes 20100708
3 Exporting EV_FLG_FOUND Call by reference Type reference (TYPE) BOOLE_D Flag: file found 20100708
4 Importing IV_FILENAME Call by reference Type reference (TYPE) FILEEXTERN File name 20100708

Method DOWNLOAD_RESULT_FILE on class /TDAG/CP_IMDS_AICL_BC_INTF has no exception.

Method DOWNLOAD_RESULT_FILE_ENTITY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_FILE Call by reference Type reference (TYPE) /TDAG/CPY_RCGREPFILE CP: Table for binary data 20100617
2 Exporting EV_FILE_SIZE Call by reference Type reference (TYPE) ESENUMBYTE Size of a document in bytes 20100618
3 Exporting EV_FLG_FOUND Call by reference Type reference (TYPE) BOOLE_D Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20100617
4 Importing IS_ENTITY Call by reference Type reference (TYPE) /TDAG/CPS_IMDS_ENTITY_KEY Identifies an Entity (MDS/Request) and a Recipient (Chap 4) 20100617

Method DOWNLOAD_RESULT_FILE_ENTITY on class /TDAG/CP_IMDS_AICL_BC_INTF has no exception.

Method GET_MESSAGES Signature

Method GET_MESSAGES on class /TDAG/CP_IMDS_AICL_BC_INTF has no parameter.
Method GET_MESSAGES on class /TDAG/CP_IMDS_AICL_BC_INTF has no exception.

Method GET_RESULT_MARKERS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_ENTRIES Call by reference Type reference (TYPE) /TDAG/CPY_IMDS_RES_MARK Entries for result download 20100708
2 Importing IT_MDS Call by reference Type reference (TYPE) /TDAG/CPY_IMDS_ENTITY_KEY Identify a number of enities (MDSs/requests) and chapter 4 20100708
3 Importing IV_FLG_SAME_FILE Call by reference Type reference (TYPE) BOOLE_D ABAP_FALSE Flag: add all entries with the same file 20100708

Method GET_RESULT_MARKERS on class /TDAG/CP_IMDS_AICL_BC_INTF has no exception.

Method HAS_ERROR Signature

Method HAS_ERROR on class /TDAG/CP_IMDS_AICL_BC_INTF has no parameter.
Method HAS_ERROR on class /TDAG/CP_IMDS_AICL_BC_INTF has no exception.

Method MARK_FILES_FOR_RESULT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_ENTRIES Call by reference Type reference (TYPE) /TDAG/CPY_IMDS_RES_MARK Entries for result download 20100617

Method MARK_FILES_FOR_RESULT on class /TDAG/CP_IMDS_AICL_BC_INTF has no exception.

Method PARSE_ERROR_ELEMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_ERROR Call by reference Object reference (TYPE REF TO) IF_IXML_ELEMENT Error element 20100708
2 Changing XS_RESULT Call by reference Type reference (TYPE) /TDAG/CPS_IMDS_RESULT_CONT IMDS Result file content 20100708

Method PARSE_ERROR_ELEMENT on class /TDAG/CP_IMDS_AICL_BC_INTF has no exception.

Method PARSE_RELEASE_CHECK_ELEMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_RC Call by reference Object reference (TYPE REF TO) IF_IXML_ELEMENT Release Check element 20100708
2 Importing IV_FLG_FAILURE Call by reference Type reference (TYPE) BOOLE_D ABAP_FALSE Flag: verdict is failure 20100714
3 Importing IV_LOCAL_KEY_DEF Call by reference Type reference (TYPE) STRING Local Key Definition 20100714
4 Importing IV_NODE_OLD Call by reference Type reference (TYPE) STRING Old node id 20100714
5 Changing XT_RESULT Call by reference Type reference (TYPE) /TDAG/CPY_IMDS_RESULT_CONT IMDS Result file content 20100714

Method PARSE_RELEASE_CHECK_ELEMENT on class /TDAG/CP_IMDS_AICL_BC_INTF has no exception.

Method PARSE_RESULT_FILE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_RESULT Call by reference Type reference (TYPE) /TDAG/CPY_IMDS_RESULT_CONT IMDS result file content 20100708
2 Importing IT_FILE Call by reference Type reference (TYPE) /TDAG/CPY_RCGREPFILE Result file 20100708
3 Importing IV_FILESIZE Call by reference Type reference (TYPE) ESENUMBYTE Size of a document in bytes 20100708

Method PARSE_RESULT_FILE on class /TDAG/CP_IMDS_AICL_BC_INTF has no exception.

Method PARSE_SOURCE_ELEMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_ELEMENT Call by reference Object reference (TYPE REF TO) IF_IXML_ELEMENT Source_Element element 20100708
2 Changing XT_RESULT Call by reference Type reference (TYPE) /TDAG/CPY_IMDS_RESULT_CONT IMDS result file content 20100708

Method PARSE_SOURCE_ELEMENT on class /TDAG/CP_IMDS_AICL_BC_INTF has no exception.

Method PARSE_WARNING_ELEMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_WARNING Call by reference Object reference (TYPE REF TO) IF_IXML_ELEMENT Warning element 20100708
2 Changing XS_RESULT Call by reference Type reference (TYPE) /TDAG/CPS_IMDS_RESULT_CONT IMDS Result file content 20100708

Method PARSE_WARNING_ELEMENT on class /TDAG/CP_IMDS_AICL_BC_INTF has no exception.

Method REMOVE_DOCTYPE_FROM_XML Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_FILE Call by reference Type reference (TYPE) /TDAG/CPY_RCGREPFILE XML File without DOCTYPE definition 20101208
2 Exporting EV_FILESIZE Call by reference Type reference (TYPE) ESENUMBYTE Size of outgoing file 20101208
3 Importing IT_FILE Call by reference Type reference (TYPE) /TDAG/CPY_RCGREPFILE XML File with DOCTYPE definition 20101208
4 Importing IV_FILESIZE Call by reference Type reference (TYPE) ESENUMBYTE Size of incoming file 20101208

Method REMOVE_DOCTYPE_FROM_XML on class /TDAG/CP_IMDS_AICL_BC_INTF has no exception.

Method UPLOAD_FILE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_MSG Call by reference Type reference (TYPE) BAL_T_MSG Message table 20100705
2 Exporting EV_FLG_ERROR Call by reference Type reference (TYPE) BOOLE_D Flag: error occured 20100618
3 Importing IT_FILE Call by reference Type reference (TYPE) /TDAG/CPY_RCGREPFILE File to be uploaded 20100618
4 Importing IV_FILE_NAME Call by reference Type reference (TYPE) STRING File name 20100701
5 Importing IV_FILE_SIZE Call by reference Type reference (TYPE) ESENUMBYTE Size of a document in bytes 20100618

Method UPLOAD_FILE on class /TDAG/CP_IMDS_AICL_BC_INTF has no exception.
History
Last changed by/on SAP  20141109 
SAP Release Created in 200_600