SAP ABAP Class CL_BS_PERIOD_TOOLSET_API (Period Toolset - Period Tool API)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-EPT (Application Component) Processes and Tools for Enterprise Applications
     ⤷ BS_PERIOD_API (Package) API for period toolset

Properties

Class	CL_BS_PERIOD_TOOLSET_API
Short Description	Period Toolset - Period Tool API
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	BS_PERIOD_API	API for period toolset
Created	20091020	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)

Interfaces

Class CL_BS_PERIOD_TOOLSET_API has no interface implemented.

Friends

Class CL_BS_PERIOD_TOOLSET_API has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_BOP	Constant	Private	☐	Type reference (TYPE)	BSPERIOD_FRQ_MAP_CAT	'BOP'	Begin of Period	20091021
2	GC_EOP	Constant	Private	☐	Type reference (TYPE)	BSPERIOD_FRQ_MAP_CAT	'EOP'	End of Period	20091021
3	GC_FRQ_COMP	Constant	Private	☐	Type reference (TYPE)	STRING	'123'	ISO Date Type String	20091021
4	GC_INIT_YEAR	Constant	Private	☐	Type reference (TYPE)	CHAR4	'0001'	First Year in Calendar	20091021
5	GC_MAP_1_N	Constant	Private	☐	Type reference (TYPE)	NUMC1	'1'	Mapping Entity 1 : n	20091105
6	GC_MAP_N_1	Constant	Private	☐	Type reference (TYPE)	NUMC1	'0'	Mapping Entity n : 1	20091105
7	GC_MAX_DATE	Constant	Private	☐	Type reference (TYPE)	BSPERIOD_DATE	'99991231'	Minimum Date Value	20091021
8	GC_MAX_FACTOR	Constant	Private	☐	Type reference (TYPE)	BSPERIOD_FRQ_FACTOR	255	Frequency Factor	20091021
9	GC_MAX_TIME	Constant	Private	☐	Type reference (TYPE)	BSPERIOD_TIME	'235959'	Maximum Time Value	20091021
10	GC_MIN_DATE	Constant	Private	☐	Type reference (TYPE)	BSPERIOD_DATE	'19000101'	Maximum Date Value	20091021
11	GC_MIN_TIME	Constant	Private	☐	Type reference (TYPE)	BSPERIOD_TIME	'000000'	Minimum Time Value	20091021
12	GC_SAP	Constant	Private	☐	Type reference (TYPE)	BSPERIOD_APPL_AREA	'SAP'	Default Application Area	20091026
13	MR_CUSTOMIZING	Static Attribute	Private	☐	Object reference (TYPE REF TO)	LIF_CUSTOMIZING			20120322

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_PERIOD_TO_START_DATE	Static method	Public	Method	Add Duration to Start Date	20091104
2	BUILD_PERIOD	Static method	Public	Method	Build single Period	20091021
3	BUILD_PERIOD_INFO	Static method	Public	Method	Build Period & Due Date Information	20091021
4	BUILD_PERIOD_LIST	Static method	Public	Method	Build Period List	20091021
5	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20120322
6	GET_DUE_DATE	Static method	Public	Method	Determine Due Date using a Due Date Rule	20091021
7	MAP_PERIOD	Static method	Public	Method	Map Single Source Period to Destination Period	20091021
8	SET_BEGDA	Static method	Private	Method	set start date for period list determination	20120327
9	SET_PERIOD_START_DATE	Static method	Public	Method	Adjust Start Date for Period Build	20091021
10	SUB_PERIOD_FROM_START_DATE	Static method	Public	Method	Subtract Duration from Start Date	20091104

Events

Class CL_BS_PERIOD_TOOLSET_API has no event.

Types

Class CL_BS_PERIOD_TOOLSET_API has no local type.

Method Signatures

Method ADD_PERIOD_TO_START_DATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DATE	Call by reference	☐	Type reference (TYPE)	BSPERIOD_DATE		Key Date	20091104
2	Importing	IV_FACTOR	Call by reference	☐	Type reference (TYPE)	BSPERIOD_FRQ_FACTOR		Frequency Factor (1..255)	20091104
3	Importing	IV_UNIT	Call by reference	☐	Type reference (TYPE)	BSPERIOD_FRQ_UNIT		Frequency Unit (1 = Day, 2 = Week, 3 = Month)	20091104
4	Returning	RV_DATE	Value transfer	☐	Type reference (TYPE)	BSPERIOD_DATE		Result Date	20091104

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_API	☐	Period Toolset - Exceptions for Period Functions	20091104

Method BUILD_PERIOD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_PERIOD	Call by reference	☐	Type reference (TYPE)	BSPERIOD_S_PERIOD		Period Structure	20091021
2	Importing	IV_APPL_AREA	Call by reference	☐	Type reference (TYPE)	BSPERIOD_APPL_AREA		Application Area	20091022
3	Importing	IV_DATE	Call by reference	☐	Type reference (TYPE)	BSPERIOD_DATE		Key Date	20091021
4	Importing	IV_FRQ_TYPE	Call by reference	☐	Type reference (TYPE)	BSPERIOD_FRQ_TYPE		Frequency Type	20091021

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_API	☐	Period Toolset - Exceptions for Period Functions	20091021

Method BUILD_PERIOD_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_PERIOD_INFO	Call by reference	☐	Type reference (TYPE)	BSPERIOD_T_PERIOD_INFO		Period Information Table Structure	20091021
2	Importing	IS_PERIOD	Call by reference	☐	Type reference (TYPE)	BSPERIOD_S_PERIOD		Selection Period	20091021
3	Importing	IV_APPL_AREA	Call by reference	☐	Type reference (TYPE)	BSPERIOD_APPL_AREA		Application Area	20091023
4	Importing	IV_CUST_OPT	Call by reference	☐	Type reference (TYPE)	BSPERIOD_FLAG	ABAP_FALSE	Include Customizing Options	20091021
5	Importing	IV_DDR_TYPE	Call by reference	☑	Type reference (TYPE)	BSPERIOD_DDR_TYPE		Due Date Rule Type (or SXP Type)	20091021
6	Importing	IV_MAP_TYPE	Call by reference	☐	Type reference (TYPE)	BSPERIOD_FRQ_MAP_TYPE		Frequency Mapping Type (or SXP Type)	20091021
7	Importing	IV_PERMAX	Call by reference	☑	Type reference (TYPE)	BSPERIOD_PERMAX		Maximum Number of Periods (Source Type)	20091021
8	Importing	IV_YEARMAX	Call by reference	☑	Type reference (TYPE)	BSPERIOD_YEARMAX		Maximum Number of Years to be generated	20091021

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_API	☐	Period Toolset - Exceptions for Period Functions	20091021

Method BUILD_PERIOD_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_PERIOD	Call by reference	☐	Type reference (TYPE)	BSPERIOD_T_PERIOD		Period Table Structure	20091021
2	Importing	IS_PERIOD	Call by reference	☐	Type reference (TYPE)	BSPERIOD_S_PERIOD		Selection Period	20091021
3	Importing	IV_APPL_AREA	Call by reference	☐	Type reference (TYPE)	BSPERIOD_APPL_AREA		Application Area	20091022
4	Importing	IV_FRQ_TYPE	Call by reference	☐	Type reference (TYPE)	BSPERIOD_FRQ_TYPE		Frequency Type	20091021
5	Importing	IV_PERMAX	Call by reference	☑	Type reference (TYPE)	BSPERIOD_PERMAX		Maximum Number of Periods	20091021
6	Importing	IV_YEARMAX	Call by reference	☑	Type reference (TYPE)	BSPERIOD_YEARMAX		Maximum Number of Years	20091021

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_API	☐	Period Toolset - Exceptions for Period Functions	20091022

Method CLASS_CONSTRUCTOR Signature

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

Method GET_DUE_DATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_DATE	Call by reference	☐	Type reference (TYPE)	BSPERIOD_DATE		Due Date	20091021
2	Exporting	EV_SCAL_IND	Call by reference	☐	Type reference (TYPE)	BSPERIOD_SCAL_INDICATOR		Factory Calendar Indicator	20091021
3	Importing	IS_DDR_CUST	Call by reference	☑	Type reference (TYPE)	BSPERIOD_S_DDR_TYPE		Due Date Rule Customizing (alternative)	20091021
4	Importing	IS_PERIOD	Call by reference	☐	Type reference (TYPE)	BSPERIOD_S_PERIOD		Payment Period	20091021
5	Importing	IS_VALUES	Call by reference	☑	Type reference (TYPE)	ANY		Value Structure for Return Value Determination	20091021
6	Importing	IV_APPL_AREA	Call by reference	☐	Type reference (TYPE)	BSPERIOD_APPL_AREA		BS PTS - Application Area	20091023
7	Importing	IV_DDR_TYPE	Call by reference	☑	Type reference (TYPE)	BSPERIOD_DDR_TYPE		Due Date Rule Type	20091021

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_API	☐	Period Toolset - Exceptions for Period Functions	20091021

Method MAP_PERIOD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_PERIOD	Call by reference	☐	Type reference (TYPE)	BSPERIOD_S_PERIOD		Destination Period Structure	20091021
2	Importing	IS_MAP_CUST	Call by reference	☑	Type reference (TYPE)	BSPERIOD_S_FRQ_MAP_TYPE		Frequency Mapping Type Structure	20091021
3	Importing	IS_PERIOD	Call by reference	☐	Type reference (TYPE)	BSPERIOD_S_PERIOD		Source Period Structure	20091021
4	Importing	IS_VALUES	Call by reference	☑	Type reference (TYPE)	ANY		Value Structure for Return Value Determination	20091021
5	Importing	IV_APPL_AREA	Call by reference	☐	Type reference (TYPE)	BSPERIOD_APPL_AREA		Application Area	20091023
6	Importing	IV_MAP_TYPE	Call by reference	☐	Type reference (TYPE)	BSPERIOD_FRQ_MAP_TYPE		Frequency Mapping Type	20091021

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_API	☐	Period Toolset - Exceptions for Period Functions	20091021

Method SET_BEGDA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_FRQ_TYPE_INFO	Call by reference	☐	Type reference (TYPE)	BSPERIOD_S_FRQ_TYPE		BS PTS - Structure for Frequency Types	20120327
2	Importing	IS_PERIOD	Call by reference	☐	Type reference (TYPE)	BSPERIOD_S_PERIOD		BS PTS - Structure for Periods	20120327
3	Returning	RV_BEGDA	Value transfer	☐	Type reference (TYPE)	DATUM		Date	20120327

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_API	☐	Period Toolset - Exceptions for Period Functions	20120405

Method SET_PERIOD_START_DATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DATE	Call by reference	☐	Type reference (TYPE)	BSPERIOD_DATE		Period Start Date	20091021
2	Importing	IV_UNIT	Call by reference	☐	Type reference (TYPE)	BSPERIOD_FRQ_UNIT		Frequency Unit	20091021
3	Returning	RV_DATE	Value transfer	☐	Type reference (TYPE)	BSPERIOD_DATE		Result Date	20091021

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_API	☐	Period Toolset - Exceptions for Period Functions	20091021

Method SUB_PERIOD_FROM_START_DATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DATE	Call by reference	☐	Type reference (TYPE)	BSPERIOD_DATE		Key Date	20091104
2	Importing	IV_FACTOR	Call by reference	☐	Type reference (TYPE)	BSPERIOD_FRQ_FACTOR		Frequency Factor (1..255)	20091104
3	Importing	IV_UNIT	Call by reference	☐	Type reference (TYPE)	BSPERIOD_FRQ_UNIT		Frequency Unit (1 = Day, 2 = Week, 3 = Month)	20091104
4	Returning	RV_DATE	Value transfer	☐	Type reference (TYPE)	BSPERIOD_DATE		Result Date	20091104

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_API	☐	Period Toolset - Exceptions for Period Functions	20091104

History

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