SAP ABAP Class CL_DIAN_FORMAT_BASE (DIAN format base class)

Hierarchy

☛ SAP_FIN (Software Component) SAP_FIN
   ⤷ FI-LOC (Application Component) Localization
     ⤷ ID-DIAN-CO (Package) DIAN: Magnetic Meida for Columbia

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_DIAN_EXTRACTION	DIAN Extraction Interface	20121206

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_DIAN_FORMAT_1001	DIAN Format 1001 Test Class	20121113
2	Inheritance (c INHERITING FROM c_ref)	CL_DIAN_FORMAT_GENERIC	Generic handle of DIAN Format	20120824

Properties

Class	CL_DIAN_FORMAT_BASE
Short Description	DIAN format base class
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	ID-DIAN-CO	DIAN: Magnetic Meida for Columbia
Created	20120810	SAP
Last change	20130531	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	CL_DIAN_EXTRACTION_INFO_HELPER	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_DIAN_EXTRACTION	☐	☐	DIAN Extraction Interface	20121206

Friends

Class CL_DIAN_FORMAT_BASE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GV_SEPARATOR	Static Attribute	Private	☐	Type reference (TYPE)	C		Folder separator	20130104
2	MC_TOTAL_LINES_PER_FILE	Constant	Public	☐	Type reference (TYPE)	I	5000		20121113
3	MI_FORMAT_SETTINGS	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_DIAN_FORMAT_SETTINGS			20120830
4	MR_DISPATCHER	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_DIAN_XRUN_DISPATCHER		DIAN Extraction Run	20130104
5	MR_FORMAT_DATA	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	DATA			20120830
6	MT_ITEMS	Instance attribute	Protected	☐	Type reference (TYPE)	BSEG_T		FI documents	20121221
7	MT_PARTNERS	Instance attribute	Protected	☐	Type reference (TYPE)	DIAN_T_PARTNER		Table type for DIAN partner data	20121221
8	MT_REF	Instance attribute	Protected	☐	Type reference (TYPE)	TTY_REF			20130117
9	MT_TAX_ITEMS	Instance attribute	Protected	☐	Type reference (TYPE)	DIAN_T_TAX_SEGMENT		Table type for DIAN tax segment	20121221
10	MT_WITHHOLDING_ITEMS	Instance attribute	Protected	☐	Type reference (TYPE)	DIAN_T_WITH_ITEM		Table type for DIAN withholding taxes	20121221
11	MV_RUN_ID	Instance attribute	Protected	☐	Type reference (TYPE)	GUID		Globally Unique Identifier	20130102

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ASSIGN_MISSING_NITS	Instance method	Protected	Method	Assign the missing NIT numbers in the cached data	20121220
2	ASSIGN_NIT	Instance method	Protected	Method	Assigns a missing NIT	20121220
3	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20130104
4	FILL_LEADING_ZEROS	Instance method	Protected	Method		20121105
5	GET_CONCEPTS	Instance method	Public	Method		20121123
6	GET_DIAN_FORMAT	Instance method	Public	Method		20121113
7	GET_FILE_NAME	Instance method	Protected	Method		20121113
8	GET_FOLDER_NAME	Instance method	Public	Method		20130103
9	GET_FORMAT_DATA	Instance method	Protected	Method	Returns the internal cache object	20120821
10	GET_FORMAT_DATA_ENTRY_INFO	Instance method	Public	Method	Gets the document information of a format data entry	20130103
11	GET_FORMAT_DATA_REF	Instance method	Public	Method	Returns a reference to the internal cache	20120821
12	GET_FORMAT_SETTINGS	Instance method	Public	Method		20121113
13	GET_FULL_FILE_NAME	Instance method	Protected	Method		20121105
14	GET_NIT_NAME	Instance method	Protected	Method	Gets the Name associated to the NIT number	20121221
15	GET_NUMBER_OF_LINES	Instance method	Public	Method		20121113
16	GET_SPLIT_FORMAT_DATA	Instance method	Protected	Method		20121106
17	GET_SUM_OVERFLOW	Instance method	Protected	Method		20121128
18	GET_TOTAL_VALUE	Instance method	Protected	Method		20121128
19	INITIALIZE_FORMAT_DATA	Instance method	Protected	Method		20121123
20	IS_NIT_MISSING	Instance method	Protected	Method	Returns true if a missing NIT has been found	20121220
21	LOAD	Instance method	Public	Method		20121113
22	LOAD_EXTRACTED_DATA	Instance method	Public	Method		20121113
23	LOAD_FORMAT_SETTINGS	Instance method	Protected	Method		20121113
24	SAVE_FILE	Instance method	Protected	Method		20121105
25	SET_FORMAT_DATA	Instance method	Protected	Method	Sets the format data internal cache object	20120821
26	SET_FORMAT_SETTINGS	Instance method	Protected	Method		20121113
27	TO_CSV	Instance method	Public	Method		20121113
28	TO_CSV_FILE	Instance method	Public	Method		20121113
29	TO_XML	Instance method	Public	Method		20121113
30	TO_XML_FILE	Instance method	Public	Method		20121113

Events

Class CL_DIAN_FORMAT_BASE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	DIAN_FILE_T	Public	See coding			20121113	dian_file_t TYPE STANDARD TABLE OF ty_dian_file WITH DEFAULT KEY
2	LOCALFILE_T	Public	See coding			20121113	localfile_t TYPE STANDARD TABLE OF localfile WITH DEFAULT KEY
3	SPLITTED_DATA_T	Public	See coding			20121127	splitted_data_t TYPE STANDARD TABLE OF ty_splitted_data WITH DEFAULT KEY
4	TTY_REF	Protected	See coding			20130117	tty_ref TYPE TABLE OF dian_a_extr_info
5	TY_DIAN_FILE	Public	See coding			20121113	BEGIN OF ty_dian_file, file_name TYPE string, file_content TYPE xstring, END OF ty_dian_file
6	TY_SPLITTED_DATA	Public	See coding			20121127	BEGIN OF ty_splitted_data, total_value TYPE dian_d_amount, data_ref TYPE REF TO data, END OF ty_splitted_data

Method Signatures

Method ASSIGN_MISSING_NITS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COMPANY_CODE	Call by reference	☐	Type reference (TYPE)	BUKRS		Company Code	20121221
2	Importing	IV_YEAR	Call by reference	☐	Type reference (TYPE)	GJAHR		Fiscal Year	20121221

Method ASSIGN_MISSING_NITS on class CL_DIAN_FORMAT_BASE has no exception.

Method ASSIGN_NIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_VALUE	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20121220
2	Importing	IV_COMPANY_CODE	Call by reference	☐	Type reference (TYPE)	BUKRS		Company Code	20121221
3	Importing	IV_YEAR	Call by reference	☐	Type reference (TYPE)	GJAHR		Fiscal Year	20121221

Method ASSIGN_NIT on class CL_DIAN_FORMAT_BASE has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_DIAN_FORMAT_BASE has no parameter.
Method CLASS_CONSTRUCTOR on class CL_DIAN_FORMAT_BASE has no exception.

Method FILL_LEADING_ZEROS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_VALUE	Call by reference	☐	Type reference (TYPE)	CLIKE			20121105

Method FILL_LEADING_ZEROS on class CL_DIAN_FORMAT_BASE has no exception.

Method GET_CONCEPTS Signature

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

Method GET_CONCEPTS on class CL_DIAN_FORMAT_BASE has no exception.

Method GET_DIAN_FORMAT Signature

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

Method GET_DIAN_FORMAT on class CL_DIAN_FORMAT_BASE has no exception.

Method GET_FILE_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	II_OPTIONS	Call by reference	☐	Object reference (TYPE REF TO)	IF_DIAN_EXTRACTION_OPTIONS			20121113
2	Importing	IV_FILE_NUMBER	Call by reference	☑	Type reference (TYPE)	I			20121113
3	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	STRING			20121113

Method GET_FILE_NAME on class CL_DIAN_FORMAT_BASE has no exception.

Method GET_FOLDER_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CCODE	Call by reference	☐	Type reference (TYPE)	BKPF-BUKRS			20130103
2	Importing	IV_SENDYEAR	Call by reference	☐	Type reference (TYPE)	GJAHR			20130103
3	Returning	RV_FOLDER_NAME	Value transfer	☐	Type reference (TYPE)	STRING			20130103

Method GET_FOLDER_NAME on class CL_DIAN_FORMAT_BASE has no exception.

Method GET_FORMAT_DATA 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)	ANY TABLE			20121106

Method GET_FORMAT_DATA on class CL_DIAN_FORMAT_BASE has no exception.

Method GET_FORMAT_DATA_ENTRY_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LINE_ID	Call by reference	☐	Type reference (TYPE)	GUID		Globally Unique Identifier	20130103
2	Returning	RT_RESULT	Value transfer	☐	Type reference (TYPE)	CL_DIAN_EXTRACTION_INFO_HELPER=>DIAN_S_EXTR_INFO_T		Documents information related to the extracted DIAN data	20130103

Method GET_FORMAT_DATA_ENTRY_INFO on class CL_DIAN_FORMAT_BASE has no exception.

Method GET_FORMAT_DATA_REF Signature

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

Method GET_FORMAT_DATA_REF on class CL_DIAN_FORMAT_BASE has no exception.

Method GET_FORMAT_SETTINGS Signature

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

Method GET_FORMAT_SETTINGS on class CL_DIAN_FORMAT_BASE has no exception.

Method GET_FULL_FILE_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DIAN_FOLDER	Call by reference	☐	Type reference (TYPE)	STRING			20130103
2	Importing	IV_FILE_EXT	Call by reference	☐	Type reference (TYPE)	STRING			20121105
3	Importing	IV_FILE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20121105
4	Importing	IV_FILE_PATH	Call by reference	☐	Type reference (TYPE)	LOCALFILE			20121105
5	Importing	IV_FOLDER_SEPARATOR	Call by reference	☐	Type reference (TYPE)	C			20130103
6	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	LOCALFILE			20121105

Method GET_FULL_FILE_NAME on class CL_DIAN_FORMAT_BASE has no exception.

Method GET_NIT_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_VALUE	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20121221
2	Returning	RS_RESULT	Value transfer	☐	Type reference (TYPE)	DIAN_S_NIT_NAMES			20130206

Method GET_NIT_NAME on class CL_DIAN_FORMAT_BASE has no exception.

Method GET_NUMBER_OF_LINES Signature

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

Method GET_NUMBER_OF_LINES on class CL_DIAN_FORMAT_BASE has no exception.

Method GET_SPLIT_FORMAT_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_RESULT	Value transfer	☐	Type reference (TYPE)	SPLITTED_DATA_T			20121106

Method GET_SPLIT_FORMAT_DATA on class CL_DIAN_FORMAT_BASE has no exception.

Method GET_SUM_OVERFLOW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_VALUE1	Call by reference	☐	Type reference (TYPE)	DIAN_D_AMOUNT			20121128
2	Importing	IV_VALUE2	Call by reference	☐	Type reference (TYPE)	DIAN_D_AMOUNT			20121128
3	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	DIAN_D_AMOUNT			20121128

Method GET_SUM_OVERFLOW on class CL_DIAN_FORMAT_BASE has no exception.

Method GET_TOTAL_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_DATA	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20121128
2	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	DIAN_D_AMOUNT			20121128

Method GET_TOTAL_VALUE on class CL_DIAN_FORMAT_BASE has no exception.

Method INITIALIZE_FORMAT_DATA Signature

Method INITIALIZE_FORMAT_DATA on class CL_DIAN_FORMAT_BASE has no parameter.
Method INITIALIZE_FORMAT_DATA on class CL_DIAN_FORMAT_BASE has no exception.

Method IS_NIT_MISSING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_VALUE	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20121220
2	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20121220

Method IS_NIT_MISSING on class CL_DIAN_FORMAT_BASE has no exception.

Method LOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FORMAT_CODE	Value transfer	☐	Type reference (TYPE)	DIAN_D_FORMAT			20121113
2	Importing	IV_YEAR	Value transfer	☐	Type reference (TYPE)	GJAHR			20121113

Method LOAD on class CL_DIAN_FORMAT_BASE has no exception.

Method LOAD_EXTRACTED_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	II_FILTERS	Call by reference	☐	Object reference (TYPE REF TO)	IF_DIAN_EXTRACTION_FILTERS			20121113

Method LOAD_EXTRACTED_DATA on class CL_DIAN_FORMAT_BASE has no exception.

Method LOAD_FORMAT_SETTINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FORMAT_CODE	Value transfer	☐	Type reference (TYPE)	DIAN_D_FORMAT			20121113
2	Importing	IV_YEAR	Value transfer	☐	Type reference (TYPE)	GJAHR			20121113
3	Returning	RI_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	IF_DIAN_FORMAT_SETTINGS			20121113

Method LOAD_FORMAT_SETTINGS on class CL_DIAN_FORMAT_BASE has no exception.

Method SAVE_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FILE_CONTENT	Call by reference	☐	Type reference (TYPE)	XSTRING			20121105
2	Importing	IV_FILE_PATH	Call by reference	☐	Type reference (TYPE)	LOCALFILE			20121105

Method SAVE_FILE on class CL_DIAN_FORMAT_BASE has no exception.

Method SET_FORMAT_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_VALUE	Call by reference	☐	Type reference (TYPE)	ANY TABLE			20121106

Method SET_FORMAT_DATA on class CL_DIAN_FORMAT_BASE has no exception.

Method SET_FORMAT_SETTINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	II_VALUE	Call by reference	☐	Object reference (TYPE REF TO)	IF_DIAN_FORMAT_SETTINGS			20121113

Method SET_FORMAT_SETTINGS on class CL_DIAN_FORMAT_BASE has no exception.

Method TO_CSV Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	II_OPTIONS	Call by reference	☐	Object reference (TYPE REF TO)	IF_DIAN_EXTRACTION_OPTIONS			20121113
2	Returning	RT_RESULT	Value transfer	☐	Type reference (TYPE)	DIAN_FILE_T			20121113

Method TO_CSV on class CL_DIAN_FORMAT_BASE has no exception.

Method TO_CSV_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	II_FILTERS	Call by reference	☐	Object reference (TYPE REF TO)	IF_DIAN_EXTRACTION_FILTERS		Filters of DIAN Extraction	20130103
2	Importing	II_OPTIONS	Call by reference	☐	Object reference (TYPE REF TO)	IF_DIAN_EXTRACTION_OPTIONS			20121113
3	Importing	IV_FILEPATH	Call by reference	☐	Type reference (TYPE)	LOCALFILE			20121113
4	Importing	IV_FOLDER_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20130104
5	Returning	RT_RESULT	Value transfer	☐	Type reference (TYPE)	LOCALFILE_T			20121113

Method TO_CSV_FILE on class CL_DIAN_FORMAT_BASE has no exception.

Method TO_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	II_OPTIONS	Call by reference	☐	Object reference (TYPE REF TO)	IF_DIAN_EXTRACTION_OPTIONS			20121113
2	Returning	RT_RESULT	Value transfer	☐	Type reference (TYPE)	DIAN_FILE_T			20121113

Method TO_XML on class CL_DIAN_FORMAT_BASE has no exception.

Method TO_XML_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	II_FILTERS	Call by reference	☐	Object reference (TYPE REF TO)	IF_DIAN_EXTRACTION_FILTERS		Filters of DIAN Extraction	20130103
2	Importing	II_OPTIONS	Call by reference	☐	Object reference (TYPE REF TO)	IF_DIAN_EXTRACTION_OPTIONS			20121113
3	Importing	IV_FILEPATH	Call by reference	☐	Type reference (TYPE)	LOCALFILE			20121113
4	Importing	IV_FOLDER_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20130104
5	Returning	RT_RESULT	Value transfer	☐	Type reference (TYPE)	LOCALFILE_T			20121113

Method TO_XML_FILE on class CL_DIAN_FORMAT_BASE has no exception.

History

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