SAP ABAP Class CL_BS_PERIOD_TOOLSET_BASICS (Period Toolset - Basic Functions)

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_BASICS
Short Description	Period Toolset - Basic Functions
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	20091019	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_BS_PERIOD_TOOLSET_BASICS has no forward declaration.

Interfaces

Class CL_BS_PERIOD_TOOLSET_BASICS has no interface implemented.

Friends

Class CL_BS_PERIOD_TOOLSET_BASICS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_FFY_DATE	Constant	Public	☐	Type reference (TYPE)	BSPERIOD_DATE	'00000201'	First Feb in Year 10000	20091019
2	GC_FJY_DATE	Constant	Public	☐	Type reference (TYPE)	BSPERIOD_DATE	'00000101'	First Jan in Year 10000	20091019
3	GC_LJY_DATE	Constant	Public	☐	Type reference (TYPE)	BSPERIOD_DATE	'00010131'	Last Jan in Year 10000	20091019
4	GC_MAX_DATE	Constant	Public	☐	Type reference (TYPE)	BSPERIOD_DATE	'99991231'	Maximum Date	20091019
5	GC_MIN_DATE	Constant	Public	☐	Type reference (TYPE)	BSPERIOD_DATE	'19000101'	Minimum Date	20091019

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_DAYS_TO_DATE	Static method	Public	Method	Add Number of Days to Date	20091019
2	ADD_HOURS_TO_DATE	Static method	Public	Method	Add Number of Hours to Date/Time Combination	20091019
3	ADD_MINUTES_TO_DATE	Static method	Public	Method	Add Number of Minutes to Date/Time Combination	20091019
4	ADD_MONTHS_TO_DATE	Static method	Public	Method	Add Number of Months to Date	20091019
5	ADD_SECONDS_TO_DATE	Static method	Public	Method	Add Number of Seconds to Date/Time Combination	20091019
6	ADD_WEEKS_TO_DATE	Static method	Public	Method	Add Number of Weeks to Date	20091019
7	CHECK_PERIOD_VALIDITY	Static method	Public	Method	Check Validity of a Period	20091019
8	CONV_DATE_TO_EXTERNAL	Static method	Public	Method	Convert a Date from Internal to External Format	20091019
9	CONV_DATE_TO_INTERNAL	Static method	Public	Method	Convert a Date from External to Internal Format	20091019
10	GET_CALENDAR_WEEK	Static method	Public	Method	Determine Calendar Week (cw)	20091019
11	GET_FACTORY_DATE	Static method	Public	Method	Determine Factory Calendar Date (Using SCAL API)	20091019
12	GET_FIRST_DAY_IN_MONTH	Static method	Public	Method	Determine the first Day in a Month	20091019
13	GET_FIRST_DAY_IN_WEEK	Static method	Public	Method	Determine the first Day in a Week	20091019
14	GET_FIRST_DAY_PREV_MONTH	Static method	Public	Method	Get the first Day in previous Month	20091019
15	GET_LAST_DAY_IN_MONTH	Static method	Public	Method	Get the Last Day in a Month	20091019
16	GET_LAST_DAY_PREV_MONTH	Static method	Public	Method	Get the Last Day in previous Month	20091019
17	GET_LAST_FACTORY_DATE	Static method	Public	Method	Determine last date maintained in Factory Calendar	20091019
18	GET_WEEKDAY_NUMBER	Static method	Public	Method	Determine Number of Weekday (to be replaced by BAdI Method!)	20091019
19	SUBTRACT_DAYS_FROM_DATE	Static method	Public	Method	Subtract Number of Days from Date	20091019
20	SUBTRACT_HOURS_FROM_DATE	Static method	Public	Method	Subtract Number of Hours from Date/Time Combination	20091019
21	SUBTRACT_MINUTES_FROM_DATE	Static method	Public	Method	Subtract Number of Minutes from Date/Time Combination	20091019
22	SUBTRACT_MONTHS_FROM_DATE	Static method	Public	Method	Subtract Number of Months from Date	20091019
23	SUBTRACT_SECONDS_FROM_DATE	Static method	Public	Method	Subtract Number of Seconds from Date/Time Combination	20091019
24	SUBTRACT_WEEKS_FROM_DATE	Static method	Public	Method	Subtract Number of Weeks from Date	20091019

Events

Class CL_BS_PERIOD_TOOLSET_BASICS has no event.

Types

Class CL_BS_PERIOD_TOOLSET_BASICS has no local type.

Method Signatures

Method ADD_DAYS_TO_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)	DATUM		Key Date	20091019
2	Importing	IV_DAYS	Call by reference	☐	Type reference (TYPE)	I		Number of Days	20091019
3	Returning	RV_DATE	Value transfer	☐	Type reference (TYPE)	DATUM		Calculated Date	20091019

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_BASICS	☐	Period Toolset Exceptions - Basic Functions	20091019

Method ADD_HOURS_TO_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		Calculated Date	20091019
2	Exporting	EV_TIME	Call by reference	☐	Type reference (TYPE)	BSPERIOD_TIME		Calculated Time	20091019
3	Importing	IV_DATE	Call by reference	☐	Type reference (TYPE)	BSPERIOD_DATE		Key Date	20091019
4	Importing	IV_HOURS	Call by reference	☐	Type reference (TYPE)	INT4		Number of Hours	20091019
5	Importing	IV_TIME	Call by reference	☐	Type reference (TYPE)	BSPERIOD_TIME		Key Time	20091019
6	Importing	IV_TIMEZONE	Call by reference	☐	Type reference (TYPE)	SYSTZONLO	SY-ZONLO	Timezone	20091019

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_BASICS	☐	Period Toolset - Exceptions for Basic Functions	20091019

Method ADD_MINUTES_TO_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		Calculated Date	20091019
2	Exporting	EV_TIME	Call by reference	☐	Type reference (TYPE)	BSPERIOD_TIME		Calculated Time	20091019
3	Importing	IV_DATE	Call by reference	☐	Type reference (TYPE)	BSPERIOD_DATE		Key Date	20091019
4	Importing	IV_MINUTES	Call by reference	☐	Type reference (TYPE)	INT4		Number of Minutes	20091019
5	Importing	IV_TIME	Call by reference	☐	Type reference (TYPE)	BSPERIOD_TIME		Key Time	20091019
6	Importing	IV_TIMEZONE	Call by reference	☐	Type reference (TYPE)	SYSTZONLO	SY-ZONLO	Timezone	20091019

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_BASICS	☐	Period Toolset - Exceptions for Basic Functions	20091019

Method ADD_MONTHS_TO_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)	DATUM		Key Date	20091019
2	Importing	IV_MONTHS	Call by reference	☐	Type reference (TYPE)	I		Number of Months	20091019
3	Returning	RV_DATE	Value transfer	☐	Type reference (TYPE)	DATUM		Calculated Date	20091019

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_BASICS	☐		20091019

Method ADD_SECONDS_TO_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		Calculated Date	20091019
2	Exporting	EV_TIME	Call by reference	☐	Type reference (TYPE)	BSPERIOD_TIME		Calculated Time	20091019
3	Importing	IV_DATE	Call by reference	☐	Type reference (TYPE)	BSPERIOD_DATE		Key Date	20091019
4	Importing	IV_SECONDS	Call by reference	☐	Type reference (TYPE)	INT4		Number of Seconds	20091019
5	Importing	IV_TIME	Call by reference	☐	Type reference (TYPE)	BSPERIOD_TIME		Key Time	20091019
6	Importing	IV_TIMEZONE	Call by reference	☐	Type reference (TYPE)	SYSTZONLO	SY-ZONLO	Timezone	20091019

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_BASICS	☐	Period Toolset - Exceptions for Basic Functions	20091019

Method ADD_WEEKS_TO_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)	DATUM		Key Date	20091019
2	Importing	IV_WEEKS	Call by reference	☐	Type reference (TYPE)	I		Number of Weeks	20091019
3	Returning	RV_DATE	Value transfer	☐	Type reference (TYPE)	DATUM		Calculated Date	20091019

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_BASICS	☐		20091019

Method CHECK_PERIOD_VALIDITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_PERIOD	Call by reference	☐	Type reference (TYPE)	BSPERIOD_S_PERIOD		BS Period Toolset - Period Structure	20091019

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_BASICS	☐		20091019

Method CONV_DATE_TO_EXTERNAL 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		Date (Internal Format)	20091019
2	Returning	RV_DATE	Value transfer	☐	Type reference (TYPE)	BSPERIOD_DATE_EXTERNAL		Date (External Format)	20091019

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_BASICS	☐	Period Toolset - Exceptions for Basic Functions	20091020

Method CONV_DATE_TO_INTERNAL 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_EXTERNAL		Date (External Format)	20091019
2	Returning	RV_DATE	Value transfer	☐	Type reference (TYPE)	BSPERIOD_DATE		Date (Internal Format)	20091019

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_BASICS	☐		20091019

Method GET_CALENDAR_WEEK 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	20091019
2	Returning	RV_WEEK	Value transfer	☐	Type reference (TYPE)	BSPERIOD_WEEK		Calendar Week	20091019

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_BASICS	☐		20091019

Method GET_FACTORY_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		Factory Calendar Date	20091019
2	Exporting	EV_WD_IND	Call by reference	☐	Type reference (TYPE)	SCAL-INDICATOR		Fatory calendar flag	20091019
3	Importing	IV_DATE	Call by reference	☐	Type reference (TYPE)	BSPERIOD_DATE	SY-DATUM	Key Date	20091019
4	Importing	IV_FCAL_ID	Call by reference	☐	Type reference (TYPE)	SCAL-FCALID	'01'	Factory Calendar ID	20091019
5	Importing	IV_FCAL_IND	Call by reference	☐	Type reference (TYPE)	SCAL-INDICATOR	'+'	Fatory calendar flag (+ / -)	20091019

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_BASICS	☐		20091019

Method GET_FIRST_DAY_IN_MONTH 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	20091019
2	Returning	RV_DATE	Value transfer	☐	Type reference (TYPE)	BSPERIOD_DATE		First Day in Month	20091019

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_BASICS	☐		20091019

Method GET_FIRST_DAY_IN_WEEK 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_BEGDA		Key Date	20091019
2	Returning	RV_DATE	Value transfer	☐	Type reference (TYPE)	BSPERIOD_ENDDA		First Day in Week	20091019

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_BASICS	☐		20091019

Method GET_FIRST_DAY_PREV_MONTH 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	20091019
2	Returning	RV_DATE	Value transfer	☐	Type reference (TYPE)	BSPERIOD_DATE		First Day in pervious Month	20091019

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_BASICS	☐	Period Toolset - Exceptions for Basic Functions	20091019

Method GET_LAST_DAY_IN_MONTH 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	20091019
2	Returning	RV_DATE	Value transfer	☐	Type reference (TYPE)	BSPERIOD_DATE		Last Day in Month	20091019

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_BASICS	☐	Period Toolset - Exceptions for Basic Functions	20091019

Method GET_LAST_DAY_PREV_MONTH 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	20091019
2	Returning	RV_DATE	Value transfer	☐	Type reference (TYPE)	BSPERIOD_DATE		Result Date	20091019

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_BASICS	☐	Period Toolset - Exceptions for Basic Functions	20091020

Method GET_LAST_FACTORY_DATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FCAL_ID	Call by reference	☐	Type reference (TYPE)	SCAL-FCALID		Factory Calendar ID	20091019
2	Returning	RV_DATE	Value transfer	☐	Type reference (TYPE)	BSPERIOD_DATE		Last Factory Calendar Date	20091019

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_BASICS	☐	Period Toolset - Exceptions for Basic Functions	20091019

Method GET_WEEKDAY_NUMBER 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	20091019
2	Returning	RV_WEEKDAY	Value transfer	☐	Type reference (TYPE)	I		Weekday Number	20091019

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_BASICS	☐		20091019

Method SUBTRACT_DAYS_FROM_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	20091019
2	Importing	IV_DAYS	Call by reference	☐	Type reference (TYPE)	I		Number of Days	20091019
3	Returning	RV_DATE	Value transfer	☐	Type reference (TYPE)	BSPERIOD_DATE		Calculated Date	20091019

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_BASICS	☐	Period Toolset - Exceptions for Basic Functions	20091019

Method SUBTRACT_HOURS_FROM_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		Calculated Date	20091019
2	Exporting	EV_TIME	Call by reference	☐	Type reference (TYPE)	BSPERIOD_TIME		Calculated Time	20091019
3	Importing	IV_DATE	Call by reference	☐	Type reference (TYPE)	BSPERIOD_DATE		Key Date	20091019
4	Importing	IV_HOURS	Call by reference	☐	Type reference (TYPE)	INT4		Number of Hours	20091019
5	Importing	IV_TIME	Call by reference	☐	Type reference (TYPE)	BSPERIOD_TIME		Key Time	20091019
6	Importing	IV_TIMEZONE	Call by reference	☐	Type reference (TYPE)	SYSTZONLO	SY-ZONLO	Timezone	20091019

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_BASICS	☐	Period Toolset - Exceptions for Basic Functions	20091019

Method SUBTRACT_MINUTES_FROM_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		Calculated Date	20091019
2	Exporting	EV_TIME	Call by reference	☐	Type reference (TYPE)	BSPERIOD_TIME		Calculated Time	20091019
3	Importing	IV_DATE	Call by reference	☐	Type reference (TYPE)	BSPERIOD_DATE		Key Date	20091019
4	Importing	IV_MINUTES	Call by reference	☐	Type reference (TYPE)	INT4		Number of Minutes	20091019
5	Importing	IV_TIME	Call by reference	☐	Type reference (TYPE)	BSPERIOD_TIME		Key Time	20091019
6	Importing	IV_TIMEZONE	Call by reference	☐	Type reference (TYPE)	SYSTZONLO	SY-ZONLO	Timezone	20091019

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_BASICS	☐	Period Toolset - Exceptions for Basic Functions	20091019

Method SUBTRACT_MONTHS_FROM_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	20091019
2	Importing	IV_MONTHS	Call by reference	☐	Type reference (TYPE)	I		Number of Months	20091019
3	Returning	RV_DATE	Value transfer	☐	Type reference (TYPE)	BSPERIOD_DATE		Calculated Date	20091019

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_BASICS	☐	Period Toolset - Exceptions for Basic Functions	20091019

Method SUBTRACT_SECONDS_FROM_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		Calculated Date	20091019
2	Exporting	EV_TIME	Call by reference	☐	Type reference (TYPE)	BSPERIOD_TIME		Calculated Time	20091019
3	Importing	IV_DATE	Call by reference	☐	Type reference (TYPE)	BSPERIOD_DATE		Key Date	20091019
4	Importing	IV_SECONDS	Call by reference	☐	Type reference (TYPE)	INT4		Number of Seconds	20091019
5	Importing	IV_TIME	Call by reference	☐	Type reference (TYPE)	BSPERIOD_TIME		Key Time	20091019
6	Importing	IV_TIMEZONE	Call by reference	☐	Type reference (TYPE)	SYSTZONLO	SY-ZONLO	Timezone	20091019

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_BASICS	☐	Period Toolset - Exceptions for Basic Functions	20091020

Method SUBTRACT_WEEKS_FROM_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	20091019
2	Importing	IV_WEEKS	Call by reference	☐	Type reference (TYPE)	I		Number of Weeks	20091019
3	Returning	RV_DATE	Value transfer	☐	Type reference (TYPE)	BSPERIOD_DATE		Calculated Date	20091019

#	Exception	Resumable	Description	Created on
1	CX_BS_PERIOD_TOOLSET_BASICS	☐	Period Toolset - Exceptions for Basic Functions	20091019

History

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