SAP ABAP Class CL_GRFN_API_DOCUMENT (API for document 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	20080313
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_GRFN_API_DOCUMENT	Interface for document API	20080313

Properties

Class	CL_GRFN_API_DOCUMENT
Short Description	API for document 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	20080313	SAP
Last change	20141106
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	GRFN0	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	GRFND	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
3	GRPCD	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_GRFN_API_DOCUMENT	☐	☐	Interface for document API	20080313

Friends

#	Friend	Modeled only	Created on	Description
1	CL_GRFN_API_BASIS	☐	20080314	Basis class for GRC API classes
2	CL_GRFN_API_SESSION	☐	20080317	Session Management for GRC APIs
3	CL_GRFN_DOCUMENTS	☐	20080728	Document subsystem UI proxy

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MC_MODEL_CLASS	Constant	Private	☐	Type reference (TYPE)	CLASSNAME	'CL_GRFN_DOCUMENTS_MODEL'	Model class	20080313

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_APP_KEY	Static method	Public	Method	Returns the object key for an application key	20080313
2	CONSTRUCTOR	Instance method	Public	Constructor		20080317
3	CONVERT_URL	Static method	Public	Method	Converts the URL for a document	20080313
4	CREATE	Instance method	Public	Method		20080317
5	DELETE	Instance method	Public	Method		20080317
6	DOWNLOAD	Instance method	Public	Method		20080317
7	FILL_DOCUMENT_DATA	Static method	Public	Method	Fills in the document data for a document	20080313
8	FREEZE	Instance method	Public	Method		20121213
9	GET	Static method	Private	Method	Returns an instance of the API class	20080317
10	IS_FREEZING_ENABLED	Static method	Public	Method	Check IMG settings	20121213
11	PARSE_APP_KEY	Static method	Public	Method	Returns the application object key for an object id	20080313
12	QUERY	Instance method	Public	Method		20080317
13	REF_TIME_TO_TEXT	Static method	Public	Method	Convert reference time to text	20121213
14	RETRIEVE	Instance method	Public	Method		20080317
15	UPDATE	Instance method	Public	Method		20080317

Events

Class CL_GRFN_API_DOCUMENT has no event.

Types

Class CL_GRFN_API_DOCUMENT has no local type.

Method Signatures

Method BUILD_APP_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_APPL_OBJ_KEY	Call by reference	☐	Type reference (TYPE)	GRFND_APPLICATION_OBJECT_KEY			20080313
2	Returning	RV_OBJECT_ID	Value transfer	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20080313

Method BUILD_APP_KEY on class CL_GRFN_API_DOCUMENT has no exception.

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	20080317
2	Importing	IV_DOCUMENT_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20080317

Method CONSTRUCTOR on class CL_GRFN_API_DOCUMENT has no exception.

Method CONVERT_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_URL	Call by reference	☐	Type reference (TYPE)	STRING			20080313

Method CONVERT_URL on class CL_GRFN_API_DOCUMENT has no exception.

Method CREATE Signature

Method CREATE on class CL_GRFN_API_DOCUMENT has no parameter.
Method CREATE on class CL_GRFN_API_DOCUMENT has no exception.

Method DELETE Signature

Method DELETE on class CL_GRFN_API_DOCUMENT has no parameter.
Method DELETE on class CL_GRFN_API_DOCUMENT has no exception.

Method DOWNLOAD Signature

Method DOWNLOAD on class CL_GRFN_API_DOCUMENT has no parameter.
Method DOWNLOAD on class CL_GRFN_API_DOCUMENT has no exception.

Method FILL_DOCUMENT_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_DOCUMENT_DATA	Call by reference	☐	Type reference (TYPE)	GRFN_S_API_DOCUMENT_DATA		The list of the documents	20080318
2	Importing	IS_DOCUMENT	Call by reference	☐	Type reference (TYPE)	GRFND_S_RUNTIME_DOCS			20080313

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

Method FREEZE Signature

Method FREEZE on class CL_GRFN_API_DOCUMENT has no parameter.
Method FREEZE on class CL_GRFN_API_DOCUMENT has no exception.

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	20080317
2	Importing	IV_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20080317
3	Returning	RO_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_GRFN_API_DOCUMENT		API for document entity	20080317

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

Method IS_FREEZING_ENABLED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ENABLED	Value transfer	☐	Type reference (TYPE)	AS4FLAG		Flag (X or Blank)	20121213

Method IS_FREEZING_ENABLED on class CL_GRFN_API_DOCUMENT has no exception.

Method PARSE_APP_KEY 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	20080313
2	Returning	RS_APPL_OBJ_KEY	Value transfer	☐	Type reference (TYPE)	GRFND_APPLICATION_OBJECT_KEY			20080313

Method PARSE_APP_KEY on class CL_GRFN_API_DOCUMENT has no exception.

Method QUERY Signature

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

Method REF_TIME_TO_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_REF_TIME	Call by reference	☐	Type reference (TYPE)	GRFN_DOCUMENT_REF_TIME		Docement signoff time reference	20121213
2	Returning	RV_TEXT	Value transfer	☐	Type reference (TYPE)	GRFN_TEXT		String	20121213

Method REF_TIME_TO_TEXT on class CL_GRFN_API_DOCUMENT has no exception.

Method RETRIEVE Signature

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

Method UPDATE Signature

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

History

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