SAP ABAP Class CL_GRFN_API_AM_JOBSTEP (AM Job Step Entity)

Hierarchy

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

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_GRFN_API_BASIS	Basis class for GRC API classes	20100527
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_GRFN_API_AM_JOBSTEP	Job step entiry API interface	20100527
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_GRFN_REPORT	Get data for reporting engine	20120618

Properties

Class	CL_GRFN_API_AM_JOBSTEP
Short Description	AM Job Step Entity
Super Class	CL_GRFN_API_BASIS	Basis class for GRC API classes
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	GRFN_ENTITY_API	GRC Foundation API
Created	20100527	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

#	Interface	Abstract	Final	Description	Created on
1	IF_GRFN_API_AM_JOBSTEP	☐	☐	Job step entiry API interface	20100527
2	IF_GRFN_REPORT	☐	☐	Get data for reporting engine	20120618

Friends

#	Friend	Modeled only	Created on	Description
1	CL_GRFN_API_SESSION	☐	20100529	Session Management for GRC APIs

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MC_ERROR	Constant	Private	☐	Type reference (TYPE)	SY-MSGTY	'E'	Message Type	20100529
2	MC_MODEL_CLASS	Constant	Private	☐	Type reference (TYPE)	CLASSNAME	'CL_GRFN_MODEL_AM_JOB'	Reference type	20100529
3	MT_BUF_SBC	Static Attribute	Private	☐	Type reference (TYPE)	T_BUF_SEARCH_BY_CONTROL		Buffer	20100723
4	SUBMIT_RC_CLOSESM37FAIL	Constant	Public	☐	Type reference (TYPE)	SYSUBRC	31		20120202
5	SUBMIT_RC_NONEWJS	Constant	Public	☐	Type reference (TYPE)	SYSUBRC	11		20120202
6	SUBMIT_RC_OPENORSUBMITSM37FAIL	Constant	Public	☐	Type reference (TYPE)	SYSUBRC	13		20120202
7	SUBMIT_RC_RETRIEVEJSFAIL	Constant	Public	☐	Type reference (TYPE)	SYSUBRC	12		20120202
8	SUBMIT_RC_UPDATEJFAIL	Constant	Public	☐	Type reference (TYPE)	SYSUBRC	33		20120202
9	SUBMIT_RC_UPDATEJSEXECFAIL	Constant	Public	☐	Type reference (TYPE)	SYSUBRC	32		20120202
10	SUBMIT_RC_UPDATEJSSTATUSFAIL	Constant	Public	☐	Type reference (TYPE)	SYSUBRC	14		20120202

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACTION_ALLOWED	Instance method	Public	Method		20100623
2	ACTION_CANCEL	Instance method	Public	Method		20100623
3	ACTION_OBSOLETE	Instance method	Public	Method		20100623
4	ACTION_RESCHEDULE	Instance method	Public	Method		20100623
5	AUTHORIZE_CONTEXT	Static method	Private	Method	Authorize check for context	20120203
6	CLOSE_JOBSTEP	Static method	Private	Method	Submit AM Job Step to SM37 Job - Step 3/3	20120202
7	CONSTRUCTOR	Instance method	Public	Constructor	Job Step	20100529
8	CREATE_JOBSTEPS	Instance method	Public	Method		20100623
9	CREATE_JOBSTEP_IES	Instance method	Public	Method		20100623
10	CREATE_JOBSTEP_RESULT	Instance method	Public	Method		20100531
11	DO_INTEGRATION	Instance method	Private	Method	Update Case Integration after Action Cancel and Obsolete	20120130
12	GET	Static method	Private	Method	Create instance	20100529
13	GET_JP_BI_ID	Instance method	Private	Method	Get 40 chars of the Job Step ID	20130123
14	INFO	Instance method	Public	Method		20100531
15	OPEN_JOBSTEP	Static method	Private	Method	Submit AM Job Step to SM37 Job - Step 1/3	20120202
16	PARENT	Instance method	Public	Method		20100531
17	QUERY	Instance method	Public	Method		20100530
18	QUERY_BY_JOBGROUP	Instance method	Public	Method		20100702
19	QUERY_BY_STATUS	Instance method	Public	Method		20100622
20	RETRIEVE	Instance method	Public	Method		20100530
21	SUBMIT_JOBSTEP	Static method	Private	Method	Submit AM Job Step to SM37 Job - Step 2/3	20120202
22	UPDATE	Instance method	Public	Method		20100530
23	UPDATE_AM_JOB	Static method	Private	Method	Update Job after submit	20120202
24	UPDATE_AM_JOBSTEP_EXEC	Static method	Private	Method	Update Job Step Exec date time after Close	20120202
25	UPDATE_AM_JOBSTEP_STATUS	Static method	Private	Method	Update Job Step Status after Open & Submit	20120202
26	_CALC_RESULT_DEFICIENCY	Instance method	Private	Method	Calculate Job Step Result Deficiency	20100624
27	_UPDATE_AM_JOB	Instance method	Private	Method	Change the Job Last Change Info after changing the Job Step	20100629

Events

Class CL_GRFN_API_AM_JOBSTEP has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	S_BUF_SEARCH_BY_CONTROL	Private	See coding			20100723	BEGIN OF s_buf_search_by_control, session_id TYPE grfn_api_session_id, control_id TYPE grfn_api_object_id, t_result TYPE if_grfn_api_am_jobstep=>t_search_by_control, END OF s_buf_search_by_control
2	S_STEP_CLOSE	Private	See coding			20120202	BEGIN OF s_step_close, jobstep_id TYPE grfn_api_object_id, jobcount TYPE btcjobcnt, s_jobstep TYPE grfn_s_jobdetail_create, END OF s_step_close
3	T_BUF_SEARCH_BY_CONTROL	Private	See coding			20100723	t_buf_search_by_control TYPE STANDARD TABLE OF s_buf_search_by_control

Method Signatures

Method ACTION_ALLOWED Signature

Method ACTION_ALLOWED on class CL_GRFN_API_AM_JOBSTEP has no parameter.
Method ACTION_ALLOWED on class CL_GRFN_API_AM_JOBSTEP has no exception.

Method ACTION_CANCEL Signature

Method ACTION_CANCEL on class CL_GRFN_API_AM_JOBSTEP has no parameter.
Method ACTION_CANCEL on class CL_GRFN_API_AM_JOBSTEP has no exception.

Method ACTION_OBSOLETE Signature

Method ACTION_OBSOLETE on class CL_GRFN_API_AM_JOBSTEP has no parameter.
Method ACTION_OBSOLETE on class CL_GRFN_API_AM_JOBSTEP has no exception.

Method ACTION_RESCHEDULE Signature

Method ACTION_RESCHEDULE on class CL_GRFN_API_AM_JOBSTEP has no parameter.
Method ACTION_RESCHEDULE on class CL_GRFN_API_AM_JOBSTEP has no exception.

Method AUTHORIZE_CONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_MODEL	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_MODEL_AM_JOB		Job and Job Step model	20120203
2	Importing	IO_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20120203
3	Importing	IV_JOBID	Call by reference	☐	Type reference (TYPE)	GRFN_JOBID		Job ID	20120203
4	Importing	IV_JOBSTEP	Call by reference	☐	Type reference (TYPE)	GRFN_JOBSTEP		Job Step	20120203
5	Importing	IV_REGULATION_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Regulation ID	20120203
6	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20120203

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

Method CLOSE_JOBSTEP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_JOBSTEP_EXEC_DATE	Call by reference	☐	Type reference (TYPE)	GRFN_EXEC_DATE			20120202
2	Exporting	EV_JOBSTEP_EXEC_TIME	Call by reference	☐	Type reference (TYPE)	GRFN_EXEC_TIME			20120202
3	Exporting	EV_START_NOW	Call by reference	☐	Type reference (TYPE)	BOOLEAN			20120202
4	Importing	IO_LOG	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_APPLOG_JOB_DESIGN			20120202
5	Importing	IS_JOBSTEP	Call by reference	☐	Type reference (TYPE)	GRFN_S_JOBDETAIL_CREATE			20120202
6	Importing	IV_JOBCOUNT	Call by reference	☐	Type reference (TYPE)	BTCJOBCNT			20120202
7	Importing	IV_JOBEXECTYPE	Call by reference	☐	Type reference (TYPE)	GRFN_JOBEXECTYPE			20120202
8	Importing	IV_JOBFREQ	Call by reference	☐	Type reference (TYPE)	GRFN_TF_FREQUENCY			20120202
9	Importing	IV_JOBNAME	Call by reference	☐	Type reference (TYPE)	BTCJOB			20120202

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐		20120202

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20100529
2	Importing	IV_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100529

Method CONSTRUCTOR on class CL_GRFN_API_AM_JOBSTEP has no exception.

Method CREATE_JOBSTEPS Signature

Method CREATE_JOBSTEPS on class CL_GRFN_API_AM_JOBSTEP has no parameter.
Method CREATE_JOBSTEPS on class CL_GRFN_API_AM_JOBSTEP has no exception.

Method CREATE_JOBSTEP_IES Signature

Method CREATE_JOBSTEP_IES on class CL_GRFN_API_AM_JOBSTEP has no parameter.
Method CREATE_JOBSTEP_IES on class CL_GRFN_API_AM_JOBSTEP has no exception.

Method CREATE_JOBSTEP_RESULT Signature

Method CREATE_JOBSTEP_RESULT on class CL_GRFN_API_AM_JOBSTEP has no parameter.
Method CREATE_JOBSTEP_RESULT on class CL_GRFN_API_AM_JOBSTEP has no exception.

Method DO_INTEGRATION Signature

Method DO_INTEGRATION on class CL_GRFN_API_AM_JOBSTEP has no parameter.

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

Method GET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20100529
2	Importing	IV_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100529
3	Returning	RO_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_GRFN_API_AM_JOBSTEP		AM Job Entity	20100529

Method GET on class CL_GRFN_API_AM_JOBSTEP has no exception.

Method GET_JP_BI_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20130123
2	Returning	RV_JP_ID	Value transfer	☐	Type reference (TYPE)	GRFN_REP_JP_ID		Job Step Key for BI Datasource	20130123

Method GET_JP_BI_ID on class CL_GRFN_API_AM_JOBSTEP has no exception.

Method INFO Signature

Method INFO on class CL_GRFN_API_AM_JOBSTEP has no parameter.
Method INFO on class CL_GRFN_API_AM_JOBSTEP has no exception.

Method OPEN_JOBSTEP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_JOBCOUNT	Call by reference	☐	Type reference (TYPE)	BTCJOBCNT			20120202
2	Importing	IO_LOG	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_APPLOG_JOB_DESIGN			20120202
3	Importing	IV_JOBNAME	Call by reference	☐	Type reference (TYPE)	BTCJOB			20120202

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐		20120202

Method PARENT Signature

Method PARENT on class CL_GRFN_API_AM_JOBSTEP has no parameter.
Method PARENT on class CL_GRFN_API_AM_JOBSTEP has no exception.

Method QUERY Signature

Method QUERY on class CL_GRFN_API_AM_JOBSTEP has no parameter.
Method QUERY on class CL_GRFN_API_AM_JOBSTEP has no exception.

Method QUERY_BY_JOBGROUP Signature

Method QUERY_BY_JOBGROUP on class CL_GRFN_API_AM_JOBSTEP has no parameter.
Method QUERY_BY_JOBGROUP on class CL_GRFN_API_AM_JOBSTEP has no exception.

Method QUERY_BY_STATUS Signature

Method QUERY_BY_STATUS on class CL_GRFN_API_AM_JOBSTEP has no parameter.
Method QUERY_BY_STATUS on class CL_GRFN_API_AM_JOBSTEP has no exception.

Method RETRIEVE Signature

Method RETRIEVE on class CL_GRFN_API_AM_JOBSTEP has no parameter.
Method RETRIEVE on class CL_GRFN_API_AM_JOBSTEP has no exception.

Method SUBMIT_JOBSTEP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_LOG	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_APPLOG_JOB_DESIGN			20120202
2	Importing	IV_JOBCOUNT	Call by reference	☐	Type reference (TYPE)	BTCJOBCNT			20120202
3	Importing	IV_JOBID	Call by reference	☐	Type reference (TYPE)	GRFN_JOBID			20120202
4	Importing	IV_JOBNAME	Call by reference	☐	Type reference (TYPE)	BTCJOB			20120202
5	Importing	IV_JOBSTEP	Call by reference	☐	Type reference (TYPE)	GRFN_JOBSTEP			20120202
6	Importing	IV_NO_NEXT	Call by reference	☐	Type reference (TYPE)	GRFN_BOOLEAN			20120202
7	Importing	IV_TF_YEAR	Call by reference	☐	Type reference (TYPE)	GRFN_TF_YEAR			20120202
8	Importing	IV_TIMEFRAME	Call by reference	☐	Type reference (TYPE)	GRFN_TIMEFRAME			20120202

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐		20120202

Method UPDATE Signature

Method UPDATE on class CL_GRFN_API_AM_JOBSTEP has no parameter.
Method UPDATE on class CL_GRFN_API_AM_JOBSTEP has no exception.

Method UPDATE_AM_JOB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_LOG	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_APPLOG_JOB_DESIGN			20120202
2	Importing	IO_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION			20120202
3	Importing	IV_JOBID	Call by reference	☐	Type reference (TYPE)	GRFN_JOBID			20120202

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐		20120202

Method UPDATE_AM_JOBSTEP_EXEC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_LOG	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_APPLOG_JOB_DESIGN			20120202
2	Importing	IO_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION			20120202
3	Importing	IV_JOBSTEP_EXEC_DATE	Call by reference	☐	Type reference (TYPE)	GRFN_EXEC_DATE			20120202
4	Importing	IV_JOBSTEP_EXEC_TIME	Call by reference	☐	Type reference (TYPE)	GRFN_EXEC_TIME			20120202
5	Importing	IV_JOBSTEP_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID			20120202

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐		20120202

Method UPDATE_AM_JOBSTEP_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_LOG	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_APPLOG_JOB_DESIGN			20120202
2	Importing	IO_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION			20120202
3	Importing	IV_GRC_JOBCOUNT	Call by reference	☐	Type reference (TYPE)	BTCJOBCNT			20120202
4	Importing	IV_JOBSTEPSTATUS	Call by reference	☐	Type reference (TYPE)	GRFN_JOBSTEPSTATUS			20120202
5	Importing	IV_JOBSTEP_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID			20120202

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐		20120202

Method _CALC_RESULT_DEFICIENCY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_DEFICIENCY	Call by reference	☐	Type reference (TYPE)	GRFN_S_JOBSTEP_DEFICIENCY		Job Step Result - Deficiency	20100624
2	Importing	IT_RESULT	Call by reference	☐	Type reference (TYPE)	GRFN_T_JOBSTEP_RESULT		Job Step Result	20100624

Method _CALC_RESULT_DEFICIENCY on class CL_GRFN_API_AM_JOBSTEP has no exception.

Method _UPDATE_AM_JOB Signature

Method _UPDATE_AM_JOB on class CL_GRFN_API_AM_JOBSTEP has no parameter.

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

History

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