SAP ABAP Class CL_GRFN_UTIL_DOCUMENT (Utility class for documents)

Hierarchy

☛ GRCFND_A (Software Component) GRC Foundation ABAP
   ⤷ GRC (Application Component) Governance, Risk and Compliance
     ⤷ GRFN_UTILITIES (Package) Various helping infrastructure for GRC ABAP

Properties

Class	CL_GRFN_UTIL_DOCUMENT
Short Description	Utility class for documents
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	GRFN_UTILITIES	Various helping infrastructure for GRC ABAP
Created	20080918	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_UTIL_DOCUMENT has no interface implemented.

Friends

Class CL_GRFN_UTIL_DOCUMENT has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MTS_DOC_BUFFER	Static Attribute	Private	☐	Type reference (TYPE)	TS_ALL_DOC			20100413

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	COPY_DOCUMENTS	Static method	Public	Method	Copies documents from one object to another	20080918
2	COUNT_DOCUMENTS_SIZE	Static method	Public	Method	Calculate total size of documents for an object	20100715
3	DELETE_DOCUMENT	Static method	Public	Method	Deletes a certain document	20100413
4	GET_ALL_DOCS	Static method	Public	Method	Reads all GRC documents	20100413

Events

Class CL_GRFN_UTIL_DOCUMENT has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	S_ALL_DOC	Public	See coding			20100413	begin of s_all_doc, objtype type grfn_api_entity_id, object_id type grfnd_appl_object_id, document_id type grfn_api_object_id, document_title type grfn_document_title, end of s_all_doc
2	TS_ALL_DOC	Public	See coding			20100413	ts_all_doc type sorted table of s_all_doc with non-unique key object_id

Method Signatures

Method COPY_DOCUMENTS 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	20080918
2	Importing	IV_SOURCE_OBJ	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20080918
3	Importing	IV_SOURCE_REG_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20081208
4	Importing	IV_SOURCE_SEGMENT	Call by reference	☑	Type reference (TYPE)	GRFN_DOCUMENT_SEGMENT		Document Segment	20081203
5	Importing	IV_TARGET_OBJ	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20080918
6	Importing	IV_TARGET_REG_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20081208
7	Importing	IV_TARGET_SEGMENT	Call by reference	☑	Type reference (TYPE)	GRFN_DOCUMENT_SEGMENT		Document Segment	20081203

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

Method COUNT_DOCUMENTS_SIZE 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	20100715
2	Importing	IV_OBJECT_ID	Value transfer	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100715
3	Importing	IV_REGULATION_ID	Value transfer	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100715
4	Importing	IV_SEGMENT	Value transfer	☑	Type reference (TYPE)	GRFN_DOCUMENT_SEGMENT		Document Segment	20100715
5	Returning	RV_SIZE	Value transfer	☐	Type reference (TYPE)	DDSIZED		Natural number	20100715

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

Method DELETE_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DOCUMENT_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100413

Method DELETE_DOCUMENT on class CL_GRFN_UTIL_DOCUMENT has no exception.

Method GET_ALL_DOCS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BUFFER_REFRESH	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Object ID	20100413
2	Returning	RTS_ALL_DOC	Value transfer	☐	Type reference (TYPE)	TS_ALL_DOC			20100413

Method GET_ALL_DOCS on class CL_GRFN_UTIL_DOCUMENT has no exception.

History

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