SAP ABAP Class CL_GRFN_API_TIMEFRAME (GRC Timeframes API)

Hierarchy

☛ GRCFND_A (Software Component) GRC Foundation ABAP
   ⤷ GRC (Application Component) Governance, Risk and Compliance
     ⤷ GRFN_API_SERVICES (Package) GRC Foundation API Services

Properties

Class	CL_GRFN_API_TIMEFRAME
Short Description	GRC Timeframes API
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	GRFN_API_SERVICES	GRC Foundation API Services
Created	20080129	SAP
Last change	20141106
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_GRFN_API_TIMEFRAME has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_GRFN_FREQUENCY_STANDARD	☐	20090113	Standard DB-based implementation

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CV_PERS_KEY	Constant	Private	☐	Type reference (TYPE)	SPERS_KEY	'GRFN_TIMEFRAME'	Personalization object key	20080410
2	GC_PARAM_YEARS_AFTER	Constant	Public	☐	Type reference (TYPE)	GRRM_PARAM_ID	'003'	Parameter ID	20100812
3	GC_PARAM_YEARS_BEFORE	Constant	Public	☐	Type reference (TYPE)	GRRM_PARAM_ID	'002'	Parameter ID	20100812
4	GV_DATE_FOREVER	Constant	Public	☐	Type reference (TYPE)	GRFN_DATE_TO	'99991231'	Date Forever	20080724
5	GV_FREQUENCY_ANY	Constant	Public	☐	Type reference (TYPE)	GRFN_TF_FREQUENCY	'0SAP_ANY'	Frequency - Any	20100429
6	GV_FREQUENCY_DAILY	Constant	Public	☐	Type reference (TYPE)	GRFN_TF_FREQUENCY	'0SAP_DAY'	Frequency - Daily	20100429
7	GV_FREQUENCY_FROMD	Constant	Public	☐	Type reference (TYPE)	GRFN_TF_FREQUENCY	'0SAP_FROMD'	Frequency - From day till forever	20100626
8	GV_FREQUENCY_HOURLY	Constant	Public	☐	Type reference (TYPE)	GRFN_TF_FREQUENCY	'0SAP_HOUR'	Frequency - Hourly	20100429
9	GV_FREQUENCY_MONTHLY	Constant	Public	☐	Type reference (TYPE)	GRFN_TF_FREQUENCY	'0SAP_MONTH'	Frequency - Monthly	20100429
10	GV_FREQUENCY_WEEKLY	Constant	Public	☐	Type reference (TYPE)	GRFN_TF_FREQUENCY	'0SAP_WEEK'	Frequency - Weekly	20100429
11	GV_FREQUENCY_YEARLY	Constant	Public	☐	Type reference (TYPE)	GRFN_TF_FREQUENCY	'0SAP_YEAR'	Frequency - Yearly	20100429
12	MV_FIRST_YEAR	Static Attribute	Private	☐	Type reference (TYPE)	GRFN_TF_YEAR		Timeframe Year	20090714
13	T_FREQUENCY	Static Attribute	Private	☐	Type reference (TYPE)	YT_FREQUENCY		Frequencies	20080129
14	T_FREQ_POOL	Static Attribute	Private	☐	Type reference (TYPE)	YT_FREQ_POOL			20080129

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_FREQ	Static method	Private	Method		20080129
2	COMPLETE_DATES	Static method	Private	Method		20080410
3	DATES	Static method	Public	Method	Get the attributes of the single timeframe	20080414
4	DATE_INTERVAL	Static method	Public	Method	PC Compatibility: Date & Timeframe of Session	20080414
5	DEFAULT	Static method	Public	Method	Get timeframe for the given date	20080207
6	EXPAND	Static method	Public	Method	Get timeframes for the frequency and parent timeframe	20080129
7	FREQUENCIES	Static method	Public	Method	Get list of the frequencies	20080129
8	FREQUENCY	Static method	Public	Method	Get frequency from timeframe	20080724
9	FREQUENCY_TEXT	Static method	Public	Method	Get text of a specified frequency	20100423
10	GET	Static method	Public	Method	Get personalized timeframe	20080409
11	GET_FREQ	Static method	Private	Method		20080129
12	NEXT	Static method	Public	Method	Get next timeframe	20080129
13	PREV	Static method	Public	Method	Get previous timeframe	20080129
14	RESOLVE	Static method	Public	Method	Get timeframe for the given date	20080129
15	RESOLVE_DAILY	Static method	Public	Method	Get timeframe for the given date	20080516
16	RETRIEVE	Static method	Public	Method	Get the attributes of the single timeframe	20080129
17	SET	Static method	Public	Method	Set personalized timeframe	20080409
18	TIMEFRAMES	Static method	Public	Method	Get list of timeframes	20080409
19	TIMEFRAME_LABEL	Static method	Public	Method	Get time frame label in fromat TIMEFRAME / YEAR	20111003
20	TIMEFRAME_TEXT	Static method	Public	Method	Get text of a specified timeframe	20100423
21	YEARS	Static method	Public	Method	Get list of years	20081106

Events

Class CL_GRFN_API_TIMEFRAME has no event.

Types

Class CL_GRFN_API_TIMEFRAME has no local type.

Method Signatures

Method CHECK_FREQ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	IF_GRFN_FREQUENCY		The fixed frequency logic	20080129
2	Importing	I_FREQUENCY	Value transfer	☐	Type reference (TYPE)	GRFN_TF_FREQUENCY		Timeframe Frequency	20080129

Method CHECK_FREQ on class CL_GRFN_API_TIMEFRAME has no exception.

Method COMPLETE_DATES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DATES	Value transfer	☐	Type reference (TYPE)	GRFN_S_TF_DATES		Timeframe details	20080410
2	Returning	RS_DATES	Value transfer	☐	Type reference (TYPE)	GRFN_S_TF_DATES		Timeframe details	20080410

Method COMPLETE_DATES on class CL_GRFN_API_TIMEFRAME has no exception.

Method DATES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ES_RESULT	Value transfer	☐	Type reference (TYPE)	GRFN_S_TF_DATES		Dates	20080414
2	Importing	IV_TF_YEAR	Value transfer	☐	Type reference (TYPE)	GRFN_TF_YEAR		Timeframe Year	20080414
3	Importing	IV_TIMEFRAME	Value transfer	☐	Type reference (TYPE)	GRFN_TIMEFRAME		Timeframe	20080414

Method DATES on class CL_GRFN_API_TIMEFRAME has no exception.

Method DATE_INTERVAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TF_YEAR	Value transfer	☐	Type reference (TYPE)	GRFN_TF_YEAR		Timeframe Year	20080414
2	Importing	IV_TIMEFRAME	Value transfer	☐	Type reference (TYPE)	GRFN_TIMEFRAME		Timeframe	20080414
3	Returning	RS_DATES	Value transfer	☐	Type reference (TYPE)	GRFN_S_DATE_INTERVAL		PC Compatibility: Date and Timeframe	20080414

Method DATE_INTERVAL on class CL_GRFN_API_TIMEFRAME has no exception.

Method DEFAULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_TF_YEAR	Value transfer	☐	Type reference (TYPE)	GRFN_TF_YEAR		Timeframe Year	20080207
2	Exporting	E_TIMEFRAME	Value transfer	☐	Type reference (TYPE)	GRFN_TIMEFRAME		Timeframe	20080207
3	Importing	I_TF_YEAR	Value transfer	☑	Type reference (TYPE)	GRFN_TF_YEAR			20080207
4	Importing	I_TIMEFRAME	Value transfer	☑	Type reference (TYPE)	GRFN_TIMEFRAME			20080207

Method DEFAULT on class CL_GRFN_API_TIMEFRAME has no exception.

Method EXPAND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_RESULT	Value transfer	☐	Type reference (TYPE)	GRFN_T_TF_TIMEFRAME		Timeframe Details	20080129
2	Importing	I_FREQUENCY	Value transfer	☐	Type reference (TYPE)	GRFN_TF_FREQUENCY		Timeframe Frequency	20080129
3	Importing	I_NO_YEAR	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Do not add year to timeframe name	20090226
4	Importing	I_TF_YEAR	Value transfer	☐	Type reference (TYPE)	GRFN_TF_YEAR		Timeframe Year	20080129
5	Importing	I_TIMEFRAME	Value transfer	☐	Type reference (TYPE)	GRFN_TIMEFRAME		Timeframe	20080129

Method EXPAND on class CL_GRFN_API_TIMEFRAME has no exception.

Method FREQUENCIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_RESULT	Value transfer	☐	Type reference (TYPE)	GRFN_T_TF_FREQUENCY		Frequencies	20080129
2	Importing	IV_DROPDOWN	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20081022
3	Importing	IV_INCLUDE_ANY	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Whether Any Frequency will be returned	20100429
4	Importing	IV_INCLUDE_HOURLY	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Whether hourly will be returned; Not included by default	20100315

Method FREQUENCIES on class CL_GRFN_API_TIMEFRAME has no exception.

Method FREQUENCY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TIMEFRAME	Value transfer	☐	Type reference (TYPE)	GRFN_TIMEFRAME		Timeframe	20080724
2	Returning	RV_FREQUENCY	Value transfer	☐	Type reference (TYPE)	GRFN_TF_FREQUENCY		Timeframe Frequency	20080724

Method FREQUENCY on class CL_GRFN_API_TIMEFRAME has no exception.

Method FREQUENCY_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FREQUENCY	Call by reference	☐	Type reference (TYPE)	GRFN_TF_FREQUENCY		Frequency ID	20100423
2	Returning	RV_TEXT	Value transfer	☐	Type reference (TYPE)	GRFN_TF_TEXT		Frequency Text	20100423

Method FREQUENCY_TEXT on class CL_GRFN_API_TIMEFRAME has no exception.

Method GET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_DATES	Value transfer	☐	Type reference (TYPE)	GRFN_S_TF_DATES		Timeframe details	20080409

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20080409

Method GET_FREQ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_FREQUENCY	Value transfer	☐	Object reference (TYPE REF TO)	IF_GRFN_FREQUENCY		Timeframe Frequency	20080129
2	Importing	I_TIMEFRAME	Value transfer	☐	Type reference (TYPE)	GRFN_TIMEFRAME		Timeframe	20080129

Method GET_FREQ on class CL_GRFN_API_TIMEFRAME has no exception.

Method NEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_TF_YEAR	Value transfer	☐	Type reference (TYPE)	GRFN_TF_YEAR		Timeframe Year	20080129
2	Exporting	E_TIMEFRAME	Value transfer	☐	Type reference (TYPE)	GRFN_TIMEFRAME		Timeframe	20080129
3	Importing	I_TF_YEAR	Value transfer	☐	Type reference (TYPE)	GRFN_TF_YEAR		Timeframe Year	20080129
4	Importing	I_TIMEFRAME	Value transfer	☐	Type reference (TYPE)	GRFN_TIMEFRAME		Timeframe	20080129

Method NEXT on class CL_GRFN_API_TIMEFRAME has no exception.

Method PREV Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_TF_YEAR	Value transfer	☐	Type reference (TYPE)	GRFN_TF_YEAR		Timeframe Year	20080129
2	Exporting	E_TIMEFRAME	Value transfer	☐	Type reference (TYPE)	GRFN_TIMEFRAME		Timeframe	20080129
3	Importing	I_TF_YEAR	Value transfer	☐	Type reference (TYPE)	GRFN_TF_YEAR		Timeframe Year	20080129
4	Importing	I_TIMEFRAME	Value transfer	☐	Type reference (TYPE)	GRFN_TIMEFRAME		Timeframe	20080129

Method PREV on class CL_GRFN_API_TIMEFRAME has no exception.

Method RESOLVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_TF_YEAR	Value transfer	☐	Type reference (TYPE)	GRFN_TF_YEAR		Timeframe Year	20080129
2	Exporting	E_TIMEFRAME	Value transfer	☐	Type reference (TYPE)	GRFN_TIMEFRAME		Timeframe	20080129
3	Importing	I_DATE	Value transfer	☑	Type reference (TYPE)	SY-DATUM	SY-DATUM	Current Date of Application Server	20080129
4	Importing	I_FREQUENCY	Value transfer	☐	Type reference (TYPE)	GRFN_TF_FREQUENCY		Timeframe Frequency	20080129

Method RESOLVE on class CL_GRFN_API_TIMEFRAME has no exception.

Method RESOLVE_DAILY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_TF_YEAR	Value transfer	☐	Type reference (TYPE)	GRFN_TF_YEAR		Timeframe Year	20080516
2	Exporting	E_TIMEFRAME	Value transfer	☐	Type reference (TYPE)	GRFN_TIMEFRAME		Timeframe	20080516
3	Importing	I_DATE	Value transfer	☑	Type reference (TYPE)	SY-DATUM	SY-DATUM	Current Date of Application Server	20080516

Method RESOLVE_DAILY on class CL_GRFN_API_TIMEFRAME has no exception.

Method RETRIEVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ES_RESULT	Value transfer	☐	Type reference (TYPE)	GRFN_S_TF_TIMEFRAME		Timeframe details	20080129
2	Importing	I_NO_YEAR	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	No year added to timeframe name	20090226
3	Importing	I_TF_YEAR	Value transfer	☐	Type reference (TYPE)	GRFN_TF_YEAR		Timeframe Year	20080129
4	Importing	I_TIMEFRAME	Value transfer	☐	Type reference (TYPE)	GRFN_TIMEFRAME		Timeframe	20080129

Method RETRIEVE on class CL_GRFN_API_TIMEFRAME has no exception.

Method SET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TF_YEAR	Value transfer	☐	Type reference (TYPE)	GRFN_TF_YEAR		Timeframe Year	20080409
2	Importing	IV_TIMEFRAME	Value transfer	☐	Type reference (TYPE)	GRFN_TIMEFRAME		Timeframe	20080409

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20080409

Method TIMEFRAMES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGUAGE	Value transfer	☐	Type reference (TYPE)	SY-LANGU	SY-LANGU	Language Key of Current Text Environment	20090303
2	Returning	RT_LIST	Value transfer	☐	Type reference (TYPE)	GRFN_T_TF_TFRAME_LIST		The list of the timeframes	20080409

Method TIMEFRAMES on class CL_GRFN_API_TIMEFRAME has no exception.

Method TIMEFRAME_LABEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TF_YEAR	Call by reference	☐	Type reference (TYPE)	GRFN_TF_YEAR		Timeframe Year	20111003
2	Importing	IV_TIMEFRAME	Call by reference	☐	Type reference (TYPE)	GRFN_TIMEFRAME		Timeframe	20111003
3	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	STRING			20111003

Method TIMEFRAME_LABEL on class CL_GRFN_API_TIMEFRAME has no exception.

Method TIMEFRAME_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TIMEFRAME	Call by reference	☐	Type reference (TYPE)	GRFN_TIMEFRAME		Timeframe ID	20100423
2	Returning	RV_TEXT	Value transfer	☐	Type reference (TYPE)	GRFN_TF_TEXT		Timeframe Text	20100423

Method TIMEFRAME_TEXT on class CL_GRFN_API_TIMEFRAME has no exception.

Method YEARS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_YEAR	Value transfer	☐	Type reference (TYPE)	GRFN_T_TF_YEAR_LIST		List of the years for the timeframe selection	20081106

Method YEARS on class CL_GRFN_API_TIMEFRAME has no exception.

History

Last changed by/on	SAP	20141106
SAP Release Created in	300