SAP ABAP Class /RPM/CL_DOCUMENT_API (Document Operational API)

Hierarchy

☛ CPRXRPM (Software Component) SAP Portfolio and Project Management 6.0
   ⤷ PPM-PFM (Application Component) Portfolio Management
     ⤷ /RPM/API (Package) xRPM External Interfaces

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	/RPM/CL_OBJECT_API	xRPM Object Provider Super Class	20080731
2	Interface implementation (CLASS c. INTERFACES i_ref)	/RPM/IF_METADATA	Metadata for API objects	20080811
3	Interface implementation (CLASS c. INTERFACES i_ref)	/RPM/IF_PROVIDER_ACCESS	ESA: "CRUD"-Interface Pattern	20080731
4	Interface implementation (CLASS c. INTERFACES i_ref)	/RPM/IF_PROVIDER_ACTION	ESA: "Action"-Interface Pattern	20080731
5	Interface implementation (CLASS c. INTERFACES i_ref)	/RPM/IF_PROVIDER_QUERY	ESA: "Query"-Interface-Pattern	20080731

Properties

Class	/RPM/CL_DOCUMENT_API
Short Description	Document Operational API
Super Class	/RPM/CL_OBJECT_API	xRPM Object Provider Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	/RPM/API	xRPM External Interfaces
Created	20080731	SAP
Last change	20141109
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	/RPM/CL_CO	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
3	CL_DPR_CO	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
4	CL_RPM_CO	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	/RPM/IF_METADATA	☐	☐	Metadata for API objects	20080811
2	/RPM/IF_PROVIDER_ACCESS	☐	☐	ESA: "CRUD"-Interface Pattern	20080731
3	/RPM/IF_PROVIDER_ACTION	☐	☐	ESA: "Action"-Interface Pattern	20080731
4	/RPM/IF_PROVIDER_QUERY	☐	☐	ESA: "Query"-Interface-Pattern	20080731

Friends

Class /RPM/CL_DOCUMENT_API has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MT_DOC_BUTTON_CONFIG	Instance attribute	Private	☐	Type reference (TYPE)	/RPM/TT_FIELDS_DESCRIPTION		Table for field description	20081010
2	MT_DOC_FIELD_CONFIG	Instance attribute	Private	☐	Type reference (TYPE)	/RPM/TT_FIELDS_DESCRIPTION		Table for field description	20081010
3	MT_LOCKED_DOCUMENTS	Instance attribute	Private	☐	Type reference (TYPE)	TT_LOCKED_DOCUMENTS		Table of Locked documents	20101007
4	OV_NODE_DETAIL	Constant	Public	☐	Type reference (TYPE)	STRING	'DETAIL'		20080811
5	OV_QUERY_STATUS	Static Attribute	Public	☐	Type reference (TYPE)	STRING	'STATUS_TEXT'		20081029
6	SC_ACTION_DOC_COPY_AND_PASTE	Constant	Public	☐	Type reference (TYPE)	STRING	'CopyPasteDocument'		20081030
7	SC_ACTION_DOC_CREATE_LINK	Constant	Public	☐	Type reference (TYPE)	STRING	'CreateLinkToTemplateDocument'		20081030
8	SC_ACTION_DOC_CUT_AND_PASTE	Constant	Public	☐	Type reference (TYPE)	STRING	'CutPasteDocument'		20081030
9	SC_ACTION_DOC_STATUS_SET	Constant	Public	☐	Type reference (TYPE)	STRING	'SetStatusDocument'		20081030
10	SC_ACTION_MARK_CONTENT_PRELIM	Constant	Public	☐	Type reference (TYPE)	STRING	'MarkContentPrelim'		20100422
11	SC_ACTION_SET_DOC_T_AREA_GUID	Constant	Public	☐	Type reference (TYPE)	STRING	'ACTION_SET_DOC_T_AREA_GUID'	Set the Root Guid of the current Document Template Area	20081002
12	SC_ACTION_SUB_OBJ_CHANGED	Constant	Public	☐	Type reference (TYPE)	STRING	'SUB_OBJECT_CHANGED'		20081204
13	SC_BO_DOCUMENT	Constant	Public	☐	Type reference (TYPE)	STRING	'Document'		20080811
14	SC_BO_DOCUMENT_T	Constant	Public	☐	Type reference (TYPE)	STRING	'Document.Template'		20080811
15	SC_BO_DOCUMENT_VER	Constant	Public	☐	Type reference (TYPE)	STRING	'DocumentVersion'		20080811
16	SC_BO_DOC_FILE_CONTENT	Constant	Public	☐	Type reference (TYPE)	STRING	'DocumentContent'		20081029
17	SC_BO_NODE_NAME_ROOT	Constant	Public	☐	Type reference (TYPE)	STRING	'Root'		20080818
18	SC_CHANGE	Constant	Public	☐	Type reference (TYPE)	ACO_ACTVT	'CHNG'	Activity for Authorization Check	20080731
19	SC_CREATE	Constant	Public	☐	Type reference (TYPE)	ACO_ACTVT	'CREA'	Activity for Authorization Check	20080731
20	SC_DOCUMENT_CREATE	Constant	Public	☐	Type reference (TYPE)	STRING	'Document.Create'		20080731
21	SC_DOCUMENT_DELETE	Constant	Public	☐	Type reference (TYPE)	STRING	'Document.Delete'		20080731
22	SC_DOCUMENT_UPDATE	Constant	Public	☐	Type reference (TYPE)	STRING	'Document.Update'		20081017
23	SC_DOC_BUTTONINFO	Constant	Public	☐	Type reference (TYPE)	STRING	'Document.ButtonInfo'		20080929
24	SC_DOC_DOCVERINFO	Constant	Public	☐	Type reference (TYPE)	STRING	'Document.VersionInfo'		20081010
25	SC_DOC_FIELDINFO	Constant	Public	☐	Type reference (TYPE)	STRING	'Document.FieldInfo'		20080929
26	SC_DOC_GETLIST	Constant	Public	☐	Type reference (TYPE)	STRING	'Document.Getlist'		20080731
27	SC_DOC_GET_DETAIL	Constant	Public	☐	Type reference (TYPE)	STRING	'Document.Detail'		20080731
28	SC_DOC_ROOT	Constant	Public	☐	Type reference (TYPE)	STRING	'Document.Root'		20080825
29	SC_FOLDER_CREATE	Constant	Public	☐	Type reference (TYPE)	STRING	'Folder.Create'		20080731
30	SC_FOLDER_DELETE	Constant	Public	☐	Type reference (TYPE)	STRING	'Folder.Delete'		20080731
31	SC_QUERY_GET_HTTP_URL_FOR_GET	Constant	Public	☐	Type reference (TYPE)	STRING	'Get_http_url_for_get'		20100421
32	SC_QUERY_GET_HTTP_URL_FOR_PUT	Constant	Public	☐	Type reference (TYPE)	STRING	'Get_http_url_for_put'		20100421
33	SC_QUERY_GET_TEMPL_AREAS	Static Attribute	Public	☐	Type reference (TYPE)	STRING	'GET_TEMPL_AREAS'	Query to get the Root-GUID of a Template Area	20081001
34	SC_QUERY_TARGET_IS_VALID	Constant	Public	☐	Type reference (TYPE)	STRING	'Target_is_valid_4_insert'		20081104
35	SC_READ	Constant	Public	☐	Type reference (TYPE)	ACO_ACTVT	'READ'	Activity for Authorization Check	20080731
36	SC_ROOT	Constant	Public	☐	Type reference (TYPE)	RPM_TV_OBJECT_GUID_CHAR	'ROOT'	Unique Object Key(CHAR32)	20080731
37	SC_STATUS_IN_VALID	Constant	Public	☐	Type reference (TYPE)	STRING	'Invalid'		20110913
38	SC_STATUS_IN_WORK	Constant	Public	☐	Type reference (TYPE)	STRING	'Status.InWork'		20080731
39	SC_STATUS_IN_WORK_RPM	Constant	Public	☐	Type reference (TYPE)	STRING	'In Work'		20090615
40	SC_VERSION_CREATE	Constant	Public	☐	Type reference (TYPE)	STRING	'Version.Create'		20081018
41	SC_VERSION_DELETE	Constant	Public	☐	Type reference (TYPE)	STRING	'Version.Delete'		20081020
42	SC_VERSION_UPDATE	Constant	Public	☐	Type reference (TYPE)	STRING	'Version.Update'		20081125
43	SR_INSTANCE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	/RPM/CL_OBJECT_API		xRPM Object Provider Super Class	20080822

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_EDMS_OBJECT_IN_HIERARCHY	Instance method	Private	Method		20080731
2	BUILD_BUTTON_INFO	Instance method	Private	Method	Builds the field config	20081010
3	BUILD_FIELD_INFO	Instance method	Private	Method	Builds the field config	20081010
4	CHECK_CHILD_STATUS	Instance method	Private	Method	Check the status of underlying documents	20101111
5	CHECK_EDMS_DOCNAME	Instance method	Private	Method		20080731
6	CHECK_EDMS_DOCUMENT_LOCK	Instance method	Private	Method	Check doc lock	20080731
7	CONVERT_TABLE2STRING	Instance method	Private	Method		20080731
8	CREATE_DOCUMENT	Instance method	Private	Method		20080731
9	CREATE_FOLDER	Instance method	Private	Method		20080731
10	CREATE_VERSION	Instance method	Private	Method	Create a document version	20081018
11	DELETE_DOCUMENT	Instance method	Private	Method	Delete Document	20080731
12	DELETE_FOLDER	Instance method	Private	Method	Delete Folder	20081017
13	DELETE_FOLDER_OLD	Instance method	Private	Method	Delete Folder	20081017
14	DELETE_VERSION	Instance method	Private	Method	Delete version	20081020
15	DETERMINE_EDMS_DEFAULT_DOCNAME	Instance method	Private	Method	Determine Default Name	20081017
16	DETERMINE_UNIQUE_EDMS_DOCNAME	Instance method	Private	Method	Determine unique name	20081017
17	DOCUMENT_COPY_COMPLETE	Instance method	Public	Method		20081128
18	DOCUMENT_COPY_TEMPLATE_TREE	Instance method	Private	Method		20081030
19	DO_ACTION_DOC_COPY_AND_PASTE	Instance method	Private	Method		20081030
20	DO_ACTION_DOC_CREATE_LINK	Instance method	Private	Method		20081030
21	DO_ACTION_DOC_CUT_AND_PASTE	Instance method	Private	Method		20081030
22	DO_ACTION_DOC_SET_STATUS	Instance method	Private	Method	Modify Status	20081030
23	DO_ACTION_MARK_CONTENT_PRELIM	Instance method	Private	Method	Modify Status	20100422
24	DO_ACTION_SET_DOC_T_AREA_GUID	Instance method	Private	Method	Set the Root Guid of the current Document	20081002
25	EDMS_GET_DATA_EXT	Instance method	Private	Method		20081017
26	ENQUEUE_EDMS_OBJECT	Instance method	Private	Method		20080731
27	GET_ALL_DOCUMENTS	Instance method	Private	Method	Get All Document based on context	20080731
28	GET_APPLICATION_TYPE	Instance method	Private	Method	Get the application type based on the object type	20080731
29	GET_ASSOCIATED_VERSIONS	Instance method	Private	Method	Get document versions	20081014
30	GET_BUTTON_INFO	Instance method	Private	Method	Get field information - buttons	20081010
31	GET_DATA	Instance method	Private	Method		20081017
32	GET_DOCUMENT_BY_GUID	Instance method	Private	Method	Get Document by guid	20080731
33	GET_DOCUMENT_OBJECT	Instance method	Private	Method	Get Document Object	20081014
34	GET_DOCVER_INFO	Instance method	Private	Method	Get field information - versions	20081010
35	GET_DOC_DETAIL	Instance method	Private	Method		20080731
36	GET_EDMS_AUTHORIZATION	Instance method	Private	Method		20080731
37	GET_EDMS_STATUS_GUID_BY_NAME	Instance method	Private	Method		20080731
38	GET_EDMS_SUPERIOR_FOLDER	Instance method	Private	Method	Get Superior folder	20080731
39	GET_FIELD_INFO	Instance method	Private	Method	Get field information - fields	20081001
40	GET_FILE_CONTENT	Instance method	Private	Method		20081029
41	GET_HTTP_URL	Instance method	Private	Method	Determine the HTTP URL for checkin the Content	20100421
42	GET_INSTANCE	Static method	Public	Method		20080821
43	GET_POSSIBLE_STATUS	Instance method	Private	Method	Get Possible Statuses	20081029
44	GET_ROOT_DETAIL	Instance method	Private	Method	Get details of the Root document	20080822
45	GET_UNIQUE_DOCNAME_URL	Instance method	Private	Method		20080731
46	HAS_AUTHORITY_FOR_ACTIVITY	Static method	Public	Method		20080731
47	INIT_EDMS	Instance method	Private	Method		20080731
48	LOCK_UNLOCK_DOCUMENT	Instance method	Public	Method	Lock the current document and unlock the old document	20101015
49	MAP_INT2EXT	Instance method	Private	Method	Map fields from internal format to API format	20081017
50	MODIFY_DOCUMENT	Instance method	Private	Method	Modify Document	20080731
51	RETRIEVE_DOC_VERSION	Instance method	Private	Method	Retrieve document version	20081014
52	SPLIT_PATH	Instance method	Private	Method	Split Path	20080731
53	TARGET_IS_VALID_4_INSERT	Instance method	Private	Method		20081104
54	UPDATE_DOCUMENT	Instance method	Private	Method	Update Folder	20081017
55	UPDATE_DOCUMENT_BACKUP	Instance method	Private	Method	Update Folder	20081017
56	UPDATE_FOLDOC	Instance method	Public	Method		20080929

Events

Class /RPM/CL_DOCUMENT_API has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TT_LOCKED_DOCUMENTS	Public	See coding			20101007	TT_LOCKED_DOCUMENTS TYPE TABLE OF ty_locked_documents
2	TY_LOCKED_DOCUMENTS	Public	See coding		Structure type for Locked Documents.	20101007	BEGIN OF TY_LOCKED_DOCUMENTS, edms_doc TYPE EDMS_DOCID, edms_object TYPE REF TO IF_EDMS_DOCUMENT, END OF TY_LOCKED_DOCUMENTS

Method Signatures

Method ADD_EDMS_OBJECT_IN_HIERARCHY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_COMMON	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT		Interface for all application objects	20080731
2	Importing	IR_EDMS_NEW_OBJECT	Call by reference	☑	Object reference (TYPE REF TO)	IF_EDMS_DOCUMENT		EDMS: Document/Folder	20080731
3	Importing	IR_EDMS_SUPERIOR_FOLDER	Call by reference	☑	Object reference (TYPE REF TO)	IF_EDMS_DOCUMENT		EDMS: Document/Folder	20080731
4	Returning	RV_ACTION_OK	Value transfer	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20080731

Method ADD_EDMS_OBJECT_IN_HIERARCHY on class /RPM/CL_DOCUMENT_API has no exception.

Method BUILD_BUTTON_INFO Signature

Method BUILD_BUTTON_INFO on class /RPM/CL_DOCUMENT_API has no parameter.
Method BUILD_BUTTON_INFO on class /RPM/CL_DOCUMENT_API has no exception.

Method BUILD_FIELD_INFO Signature

Method BUILD_FIELD_INFO on class /RPM/CL_DOCUMENT_API has no parameter.
Method BUILD_FIELD_INFO on class /RPM/CL_DOCUMENT_API has no exception.

Method CHECK_CHILD_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_EDMS_FOLDER	Call by reference	☐	Object reference (TYPE REF TO)	IF_EDMS_DOCUMENT		EDMS: Document/Folder	20101111
2	Returning	RV_OK	Value transfer	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20101111

Method CHECK_CHILD_STATUS on class /RPM/CL_DOCUMENT_API has no exception.

Method CHECK_EDMS_DOCNAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_COMMON	Call by reference	☑	Object reference (TYPE REF TO)	OBJECT		Interface for All Application Objects	20080731
2	Importing	IR_EDMS_OBJECT	Call by reference	☑	Object reference (TYPE REF TO)	IF_EDMS_DOCUMENT		EDMS: Document/Folder	20080731
3	Importing	IR_EDMS_SUPERIOR_FOLDER	Call by reference	☑	Object reference (TYPE REF TO)	IF_EDMS_DOCUMENT		EDMS: Document/Folder	20080731
4	Importing	IV_EDMS_OBJECT	Call by reference	☑	Type reference (TYPE)	EDMS_DOCID		EDMS: Document ID	20080731
5	Importing	IV_EDMS_OBJECT_DOCNAME	Call by reference	☐	Type reference (TYPE)	EDMS_DOC_NAME		EDMS: Document Name	20080731
6	Returning	RV_DOCNAME_OK	Value transfer	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20080731

Method CHECK_EDMS_DOCNAME on class /RPM/CL_DOCUMENT_API has no exception.

Method CHECK_EDMS_DOCUMENT_LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_EDMS_DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_EDMS_DOCUMENT		EDMS: Document/Folder	20080731
2	Returning	RV_IS_CHANGEABLE	Value transfer	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20080731

Method CHECK_EDMS_DOCUMENT_LOCK on class /RPM/CL_DOCUMENT_API has no exception.

Method CONVERT_TABLE2STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_URL	Call by reference	☐	Type reference (TYPE)	BAPI_TT_DOCUMENT_FILE		Container for Parts of File Path Portions	20080731
2	Returning	RV_STRING	Value transfer	☐	Type reference (TYPE)	DPR_TV_BAPI_FILE_NAME		Current File Path for Document to Be Assigned (EDMS)	20080731

Method CONVERT_TABLE2STRING on class /RPM/CL_DOCUMENT_API has no exception.

Method CREATE_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER			20080929
2	Importing	IR_COMMON	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT		Interface for All Application Objects	20080731
3	Importing	IR_SOURCE	Call by reference	☑	Object reference (TYPE REF TO)	OBJECT			20101005
4	Importing	IS_DATA	Call by reference	☑	Type reference (TYPE)	BAPI_TS_DOCUMENT		BAPI ADD: Data of Document to Be Changed (EDMS)	20080731
5	Importing	IS_DATA_UPD	Call by reference	☑	Type reference (TYPE)	BAPI_TS_DOCUMENT_UPD		BAPI ADD: Update Structure for Document to Be Changed (EDMS)	20080731
6	Importing	IS_VERSION	Call by reference	☑	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20101005
7	Importing	IT_FILE_CONTENT	Call by reference	☑	Type reference (TYPE)	BAPI_TT_RAW_CONTAINER		RAW Portions of Length 255 f. Long Text, Approval Document	20080731
8	Importing	IT_URL	Call by reference	☑	Type reference (TYPE)	BAPI_TT_URL		Container for Parts of URL Portions	20080731
9	Importing	IV_MIMETYPE	Call by reference	☑	Type reference (TYPE)	DPR_TV_BAPI_MIMETYPE		MIME Type	20080731
10	Importing	IV_SAVE_AS_URL	Call by reference	☐	Type reference (TYPE)	DPR_TV_BAPI_SAVE_AS_URL		Store Document to Be Assigned (EDMS) as a URL	20080731
11	Importing	IV_TARGET_FOLDER_GUID	Call by reference	☐	Type reference (TYPE)	/RPM/TV_GUID		GUID for Folder in BAPI Interface	20080731
12	Importing	IV_TARGET_FOLDER_ID	Call by reference	☐	Type reference (TYPE)	EDMS_DOCID		EDMS: Document ID	20080731
13	Returning	RR_DOCUMENT	Value transfer	☐	Object reference (TYPE REF TO)	OBJECT		Document Instance	20080731

Method CREATE_DOCUMENT on class /RPM/CL_DOCUMENT_API has no exception.

Method CREATE_FOLDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER		Message Handler Interface	20080929
2	Importing	IR_COMMON	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT		Interface for All Application Objects	20080731
3	Importing	IR_SOURCE	Call by reference	☑	Object reference (TYPE REF TO)	OBJECT			20101005
4	Importing	IS_DATA	Call by reference	☐	Type reference (TYPE)	BAPI_TS_FOLDER		BAPI ADD/CHANGE: Fields in Folder (EDMS)	20080731
5	Importing	IS_DATA_UPD	Call by reference	☐	Type reference (TYPE)	BAPI_TS_FOLDER_UPD		BAPI ADD/CHANGE: Update Structure for Folder (EDMS)	20080731
6	Importing	IS_VERSION	Call by reference	☑	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20101005
7	Importing	IV_DETERMINE_UNIQUE_NAME	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20080731
8	Importing	IV_TARGET_FOLDER_GUID	Call by reference	☐	Type reference (TYPE)	/RPM/TV_GUID		GUID for Folder in BAPI Interface	20080731
9	Importing	IV_TARGET_FOLDER_ID	Call by reference	☐	Type reference (TYPE)	EDMS_DOCID		EDMS: Document ID	20080731
10	Returning	RR_FOLDER	Value transfer	☐	Object reference (TYPE REF TO)	OBJECT		Document Instance	20080731

Method CREATE_FOLDER on class /RPM/CL_DOCUMENT_API has no exception.

Method CREATE_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER			20081018
2	Importing	IR_COMMON	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT		Interface for All Application Objects	20081018
3	Importing	IS_DOC_DATA	Call by reference	☑	Type reference (TYPE)	/RPM/TS_API_DOCUMENT		BAPI ADD: Data of Document to Be Changed (EDMS)	20081018
4	Importing	IT_FILE_CONTENT	Call by reference	☑	Type reference (TYPE)	BAPI_TT_RAW_CONTAINER		RAW Portions of Length 255 f. Long Text, Approval Document	20081018
5	Importing	IT_URL	Call by reference	☑	Type reference (TYPE)	BAPI_TT_URL		Container for Parts of URL Portions	20081018
6	Importing	IV_MIMETYPE	Call by reference	☑	Type reference (TYPE)	DPR_TV_BAPI_MIMETYPE		MIME Type	20081018
7	Importing	IV_SAVE_AS_URL	Call by reference	☐	Type reference (TYPE)	DPR_TV_BAPI_SAVE_AS_URL		Store Document to Be Assigned (EDMS) as a URL	20081018
8	Returning	RR_DOCUMENT	Value transfer	☐	Object reference (TYPE REF TO)	OBJECT		Document Instance	20081018

Method CREATE_VERSION on class /RPM/CL_DOCUMENT_API has no exception.

Method DELETE_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER			20080925
2	Importing	IR_COMMON	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT		Interface for all application objects	20080731
3	Importing	IS_DOC_DATA	Call by reference	☐	Type reference (TYPE)	/RPM/TS_API_DOCUMENT		Guid for application objects	20081017

Method DELETE_DOCUMENT on class /RPM/CL_DOCUMENT_API has no exception.

Method DELETE_FOLDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_RC	Call by reference	☐	Type reference (TYPE)	I			20101111
2	Importing	IN_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER			20081017
3	Importing	IR_COMMON	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT		Interface for all application objects	20081017
4	Importing	IS_FOL_DATA	Call by reference	☐	Type reference (TYPE)	/RPM/TS_API_DOCUMENT		Guid for application objects	20081017
5	Importing	IV_FOLDER_GUID	Call by reference	☐	Type reference (TYPE)	/RPM/TV_GUID		Unique Object Key(CHAR32)	20081017

Method DELETE_FOLDER on class /RPM/CL_DOCUMENT_API has no exception.

Method DELETE_FOLDER_OLD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_COMMON	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT		Interface for all application objects	20081017
2	Importing	IV_FOLDER_GUID	Call by reference	☐	Type reference (TYPE)	/RPM/TV_GUID		Guid for application objects	20081017

Method DELETE_FOLDER_OLD on class /RPM/CL_DOCUMENT_API has no exception.

Method DELETE_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER		Message Handler Interface	20081020
2	Importing	IR_COMMON	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT			20081020
3	Importing	IS_VER_DATA	Call by reference	☐	Type reference (TYPE)	/RPM/TS_API_DOCUMENT		API: Structure for Documents	20081020

Method DELETE_VERSION on class /RPM/CL_DOCUMENT_API has no exception.

Method DETERMINE_EDMS_DEFAULT_DOCNAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_COMMON	Call by reference	☑	Object reference (TYPE REF TO)	OBJECT			20081017
2	Importing	IR_EDMS_SUPERIOR_FOLDER	Call by reference	☑	Object reference (TYPE REF TO)	IF_EDMS_DOCUMENT		EDMS: Document/Folder	20081017
3	Importing	IV_FOLDER	Call by reference	☐	Type reference (TYPE)	BOOLE_D	CL_DPR_CO=>SC_TRUE	'X': Folder; Otherwise: Document	20081017
4	Returning	RV_DOCNAME	Value transfer	☐	Type reference (TYPE)	EDMS_DOC_NAME		EDMS: Document Name	20081017

Method DETERMINE_EDMS_DEFAULT_DOCNAME on class /RPM/CL_DOCUMENT_API has no exception.

Method DETERMINE_UNIQUE_EDMS_DOCNAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_EDMS_OBJECT_DOCNAME	Call by reference	☐	Type reference (TYPE)	EDMS_DOC_NAME		EDMS: Document Name	20081017
2	Importing	IR_COMMON	Call by reference	☑	Object reference (TYPE REF TO)	OBJECT		Development Projects: Interface for All Application Objects	20081017
3	Importing	IR_EDMS_OBJECT	Call by reference	☑	Object reference (TYPE REF TO)	IF_EDMS_DOCUMENT		EDMS: Document/Folder	20081017
4	Importing	IR_EDMS_SUPERIOR_FOLDER	Call by reference	☑	Object reference (TYPE REF TO)	IF_EDMS_DOCUMENT		EDMS: Document/Folder	20081017
5	Importing	IV_EDMS_OBJECT	Call by reference	☑	Type reference (TYPE)	EDMS_DOCID		EDMS: Document ID	20081017

Method DETERMINE_UNIQUE_EDMS_DOCNAME on class /RPM/CL_DOCUMENT_API has no exception.

Method DOCUMENT_COPY_COMPLETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_MESSAGE_BUFFER	Call by reference	☑	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER		Message Handler Interface	20081128
2	Importing	IS_VERSION	Call by reference	☑	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20101005
3	Importing	IV_SOURCE_KEY	Call by reference	☐	Type reference (TYPE)	/RPM/TV_GUID		Project Element Key	20081128
4	Importing	IV_TARGET_KEY	Call by reference	☐	Type reference (TYPE)	/RPM/TV_GUID		Project Element Key	20081128
5	Returning	RV_RC	Value transfer	☐	Type reference (TYPE)	I			20081128

Method DOCUMENT_COPY_COMPLETE on class /RPM/CL_DOCUMENT_API has no exception.

Method DOCUMENT_COPY_TEMPLATE_TREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_MESSAGE_BUFFER	Call by reference	☑	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER		Message Handler Interface	20081030
2	Importing	IS_DOCUMENT	Call by reference	☐	Type reference (TYPE)	/RPM/TS_API_DOCUMENT		Data Structure of Document to Be Created	20081030
3	Importing	IV_SOURCE_KEY	Call by reference	☐	Type reference (TYPE)	DPR_TV_OBJECT_GUID_CHAR		Project Element Key	20081030
4	Returning	RR_DOCUMENT	Value transfer	☐	Object reference (TYPE REF TO)	OBJECT			20081121

Method DOCUMENT_COPY_TEMPLATE_TREE on class /RPM/CL_DOCUMENT_API has no exception.

Method DO_ACTION_DOC_COPY_AND_PASTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_ACTION_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20081030
2	Importing	IN_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20081030
3	Importing	IN_CHANGE_HANDLER	Call by reference	☑	Object reference (TYPE REF TO)	/RPM/IF_CHANGE_HANDLER			20081030
4	Importing	IN_KEY	Call by reference	☐	Type reference (TYPE)	ANY			20081030
5	Importing	IN_MESSAGE_BUFFER	Call by reference	☑	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER		Message Handler Interface	20081030
6	Importing	IN_PARAMETERS	Call by reference	☐	Type reference (TYPE)	ANY			20081030
7	Importing	IR_COMMON	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT			20081030
8	Importing	IR_ROOT	Call by reference	☑	Object reference (TYPE REF TO)	OBJECT			20081104
9	Exporting	OUT_REJECTED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20081030

Method DO_ACTION_DOC_COPY_AND_PASTE on class /RPM/CL_DOCUMENT_API has no exception.

Method DO_ACTION_DOC_CREATE_LINK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_ACTION_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20081030
2	Importing	IN_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20081030
3	Importing	IN_CHANGE_HANDLER	Call by reference	☑	Object reference (TYPE REF TO)	/RPM/IF_CHANGE_HANDLER			20081030
4	Importing	IN_KEY	Call by reference	☐	Type reference (TYPE)	ANY			20081030
5	Importing	IN_MESSAGE_BUFFER	Call by reference	☑	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER		Message Handler Interface	20081030
6	Importing	IN_PARAMETERS	Call by reference	☐	Type reference (TYPE)	ANY			20081030
7	Importing	IR_COMMON	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT			20081030
8	Exporting	OUT_REJECTED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20081030

Method DO_ACTION_DOC_CREATE_LINK on class /RPM/CL_DOCUMENT_API has no exception.

Method DO_ACTION_DOC_CUT_AND_PASTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_ACTION_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20081030
2	Importing	IN_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20081030
3	Importing	IN_CHANGE_HANDLER	Call by reference	☑	Object reference (TYPE REF TO)	/RPM/IF_CHANGE_HANDLER			20081030
4	Importing	IN_KEY	Call by reference	☐	Type reference (TYPE)	ANY			20081030
5	Importing	IN_MESSAGE_BUFFER	Call by reference	☑	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER		Message Handler Interface	20081030
6	Importing	IN_PARAMETERS	Call by reference	☐	Type reference (TYPE)	ANY			20081030
7	Importing	IR_COMMON	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT			20081030
8	Importing	IR_ROOT	Call by reference	☑	Object reference (TYPE REF TO)	OBJECT			20081104
9	Exporting	OUT_REJECTED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20081030

Method DO_ACTION_DOC_CUT_AND_PASTE on class /RPM/CL_DOCUMENT_API has no exception.

Method DO_ACTION_DOC_SET_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_ACTION_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20081030
2	Importing	IN_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20081030
3	Importing	IN_CHANGE_HANDLER	Call by reference	☑	Object reference (TYPE REF TO)	/RPM/IF_CHANGE_HANDLER			20081030
4	Importing	IN_KEY	Call by reference	☐	Type reference (TYPE)	ANY			20081030
5	Importing	IN_MESSAGE_BUFFER	Call by reference	☑	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER		Message Handler Interface	20081030
6	Importing	IN_PARAMETERS	Call by reference	☐	Type reference (TYPE)	ANY			20081030
7	Importing	IR_COMMON	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT			20081030
8	Exporting	OUT_REJECTED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20081030

Method DO_ACTION_DOC_SET_STATUS on class /RPM/CL_DOCUMENT_API has no exception.

Method DO_ACTION_MARK_CONTENT_PRELIM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_ACTION_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100422
2	Importing	IN_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100422
3	Importing	IN_CHANGE_HANDLER	Call by reference	☑	Object reference (TYPE REF TO)	/RPM/IF_CHANGE_HANDLER			20100422
4	Importing	IN_KEY	Call by reference	☐	Type reference (TYPE)	ANY			20100422
5	Importing	IN_MESSAGE_BUFFER	Call by reference	☑	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER		Message Handler Interface	20100422
6	Importing	IN_PARAMETERS	Call by reference	☐	Type reference (TYPE)	ANY			20100422
7	Importing	IR_COMMON	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT			20100422
8	Exporting	OUT_REJECTED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20100422

Method DO_ACTION_MARK_CONTENT_PRELIM on class /RPM/CL_DOCUMENT_API has no exception.

Method DO_ACTION_SET_DOC_T_AREA_GUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_KEYS	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20081002

Method DO_ACTION_SET_DOC_T_AREA_GUID on class /RPM/CL_DOCUMENT_API has no exception.

Method EDMS_GET_DATA_EXT Signature

Method EDMS_GET_DATA_EXT on class /RPM/CL_DOCUMENT_API has no parameter.
Method EDMS_GET_DATA_EXT on class /RPM/CL_DOCUMENT_API has no exception.

Method ENQUEUE_EDMS_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_EDMS_OBJECT	Call by reference	☐	Object reference (TYPE REF TO)	IF_EDMS_DOCUMENT		EDMS: Document/Folder	20080731
2	Importing	IV_EDMS_OBJECT	Call by reference	☐	Type reference (TYPE)	EDMS_DOCID		EDMS: Document ID	20080731
3	Returning	RV_ENQUEUE_OK	Value transfer	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20080731

Method ENQUEUE_EDMS_OBJECT on class /RPM/CL_DOCUMENT_API has no exception.

Method GET_ALL_DOCUMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20080731
2	Importing	IN_KEYS	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20080731
3	Importing	IN_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER		Message Handler Interface	20080731
4	Exporting	OUT_DATA	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20080731
5	Exporting	OUT_KEYS	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20080731

Method GET_ALL_DOCUMENTS on class /RPM/CL_DOCUMENT_API has no exception.

Method GET_APPLICATION_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_OBJ_TYPE	Call by reference	☐	Type reference (TYPE)	CGPL_OBJECT_TYPE		Object Type in Project Planning	20080731
2	Returning	RV_APPL_TYPE	Value transfer	☐	Type reference (TYPE)	CGPL_APPLICATION_TYPE		Application in Project Planning	20080731

Method GET_APPLICATION_TYPE on class /RPM/CL_DOCUMENT_API has no exception.

Method GET_ASSOCIATED_VERSIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20081014
2	Importing	IN_EDIT_MODE	Call by reference	☐	Type reference (TYPE)	I		Edit mode of application objects	20081014
3	Importing	IN_FILL_DATA	Call by reference	☐	Type reference (TYPE)	BOOLE_D	CL_RPM_CO=>SC_TRUE		20081014
4	Importing	IN_FILL_PROPERTIES	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Boolean	20081014
5	Importing	IN_KEYS	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20081014
6	Importing	IN_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER		Message Handler Interface	20081014
7	Exporting	OUT_DATA	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20081014
8	Exporting	OUT_LINK_SOURCE_KEYS	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20081014
9	Exporting	OUT_LINK_TARGET_KEYS	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20081014

Method GET_ASSOCIATED_VERSIONS on class /RPM/CL_DOCUMENT_API has no exception.

Method GET_BUTTON_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DOC_GUID	Call by reference	☐	Type reference (TYPE)	RPM_TV_OBJECT_GUID_CHAR		Unique Object Key(CHAR32)	20081010
2	Importing	IV_DOC_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20081010
3	Exporting	OUT_DATA	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20081010

Method GET_BUTTON_INFO on class /RPM/CL_DOCUMENT_API has no exception.

Method GET_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_DATA	Call by reference	☐	Type reference (TYPE)	ANY			20081017
2	Importing	IR_COMMON	Call by reference	☑	Object reference (TYPE REF TO)	OBJECT		Development Projects: Interface for All Application Objects	20081017

Method GET_DATA on class /RPM/CL_DOCUMENT_API has no exception.

Method GET_DOCUMENT_BY_GUID Signature

Method GET_DOCUMENT_BY_GUID on class /RPM/CL_DOCUMENT_API has no parameter.
Method GET_DOCUMENT_BY_GUID on class /RPM/CL_DOCUMENT_API has no exception.

Method GET_DOCUMENT_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT			20081014
2	Importing	IS_KEY	Call by reference	☐	Type reference (TYPE)	/RPM/TS_DOCUMENT_KEYS		RPM Document Keys	20081014

Method GET_DOCUMENT_OBJECT on class /RPM/CL_DOCUMENT_API has no exception.

Method GET_DOCVER_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DOC_GUID	Call by reference	☐	Type reference (TYPE)	RPM_TV_OBJECT_GUID_CHAR		Unique Object Key(CHAR32)	20081010
2	Importing	IV_DOC_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20081010
3	Importing	IV_VER_GUID	Call by reference	☐	Type reference (TYPE)	RPM_TV_OBJECT_GUID_CHAR		Unique Object Key(CHAR32)	20081125
4	Exporting	OUT_DATA	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20081010

Method GET_DOCVER_INFO on class /RPM/CL_DOCUMENT_API has no exception.

Method GET_DOC_DETAIL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20080731
2	Importing	IN_KEYS	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20080731
3	Importing	IN_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER		Message Handler Interface	20080731
4	Exporting	OUT_DATA	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20080731

Method GET_DOC_DETAIL on class /RPM/CL_DOCUMENT_API has no exception.

Method GET_EDMS_AUTHORIZATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_COMMON	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT		Interface for All Application Objects	20080731
2	Importing	IR_EDMS_OBJECT	Call by reference	☐	Object reference (TYPE REF TO)	IF_EDMS_DOCUMENT		EDMS: Document/Folder	20080731
3	Importing	IV_EDMS_OBJECT	Call by reference	☐	Type reference (TYPE)	EDMS_DOCID		EDMS: Document ID	20080731
4	Returning	RR_AUTHORIZATION	Value transfer	☐	Object reference (TYPE REF TO)	IF_ACO_AUTHORIZATION		Information About Authorization Subject	20080731

Method GET_EDMS_AUTHORIZATION on class /RPM/CL_DOCUMENT_API has no exception.

Method GET_EDMS_STATUS_GUID_BY_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_EDMS_DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_EDMS_DOCUMENT		EDMS: Document/Folder	20080731
2	Importing	IV_EDMS_STATUS_NAME	Call by reference	☐	Type reference (TYPE)	CFS_STATUS_NAME		Status name	20080731
3	Returning	RV_EDMS_STATUS_GUID	Value transfer	☐	Type reference (TYPE)	/RPM/TV_GUID		Guid for application objects	20080731

Method GET_EDMS_STATUS_GUID_BY_NAME on class /RPM/CL_DOCUMENT_API has no exception.

Method GET_EDMS_SUPERIOR_FOLDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_EDMS_SUPERIOR_FOLDER	Call by reference	☐	Object reference (TYPE REF TO)	IF_EDMS_DOCUMENT		EDMS: Document/Folder	20080731
2	Exporting	EV_EDMS_SUPERIOR_FOLDER	Call by reference	☐	Type reference (TYPE)	EDMS_DOCID		EDMS: Document ID	20080731
3	Importing	IR_COMMON	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT		Interface for All Application Objects	20080731
4	Importing	IR_DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT		"CHANGE TO DOCUMENTs ONCE THAT GET CREATED"	20080731
5	Importing	IV_TARGET_FOLDER_GUID	Call by reference	☐	Type reference (TYPE)	DPR_TV_BAPI_GUID_FOLDER		GUID for Folder in BAPI Interface	20080731
6	Importing	IV_TARGET_FOLDER_ID	Call by reference	☐	Type reference (TYPE)	EDMS_DOCID		EDMS: Document ID	20080731

Method GET_EDMS_SUPERIOR_FOLDER on class /RPM/CL_DOCUMENT_API has no exception.

Method GET_FIELD_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DOC_GUID	Call by reference	☐	Type reference (TYPE)	RPM_TV_OBJECT_GUID_CHAR		Unique Object Key(CHAR32)	20081010
2	Importing	IV_DOC_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20081010
3	Exporting	OUT_DATA	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20081010

Method GET_FIELD_INFO on class /RPM/CL_DOCUMENT_API has no exception.

Method GET_FILE_CONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20081030
2	Importing	IN_KEYS	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20081030
3	Importing	IN_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER		Message Handler Interface	20081030
4	Exporting	OUT_DATA	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20081030

Method GET_FILE_CONTENT on class /RPM/CL_DOCUMENT_API has no exception.

Method GET_HTTP_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DATA	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20100421
2	Exporting	ET_KEYS	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20100421
3	Importing	IT_SELECTION_PARAMETERS	Call by reference	☐	Type reference (TYPE)	/RPM/TT_SELECTION_PARAMETERS		Selection Parameters	20100421
4	Importing	IV_QUERY_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name of the query	20100421

Method GET_HTTP_URL on class /RPM/CL_DOCUMENT_API has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	/RPM/CL_OBJECT_API		xRPM Object Provider Super Class	20080822

Method GET_INSTANCE on class /RPM/CL_DOCUMENT_API has no exception.

Method GET_POSSIBLE_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DOC_GUID	Call by reference	☐	Type reference (TYPE)	RPM_TV_OBJECT_GUID_CHAR		Guid for application objects	20081029
2	Importing	IV_ROOT_GUID	Call by reference	☐	Type reference (TYPE)	/RPM/TV_GUID		Guid for application objects	20081029
3	Importing	IV_ROOT_OBJ_TYPE	Call by reference	☐	Type reference (TYPE)	CGPL_OBJECT_TYPE		Object Type in Project Planning	20081029
4	Exporting	OUT_DATA	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20081029

Method GET_POSSIBLE_STATUS on class /RPM/CL_DOCUMENT_API has no exception.

Method GET_ROOT_DETAIL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20080822
2	Importing	IN_KEYS	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20080822
3	Importing	IN_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER		Message Handler Interface	20080822
4	Exporting	OUT_DATA	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20080822

Method GET_ROOT_DETAIL on class /RPM/CL_DOCUMENT_API has no exception.

Method GET_UNIQUE_DOCNAME_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DOCUMENT_DATA	Call by reference	☐	Type reference (TYPE)	/RPM/TS_API_DOCUMENT		API: Structure for Documents	20080731
2	Importing	IT_ALL_DOCS	Call by reference	☐	Type reference (TYPE)	/RPM/TT_API_DOCUMENT			20080731
3	Importing	IV_DOC_PATH	Call by reference	☐	Type reference (TYPE)	STRING			20080731
4	Importing	IV_URL_NAME	Call by reference	☐	Type reference (TYPE)	RPM_FLAG		Flag	20080731
5	Returning	RV_NAME	Value transfer	☐	Type reference (TYPE)	STRING			20080731

Method GET_UNIQUE_DOCNAME_URL on class /RPM/CL_DOCUMENT_API has no exception.

Method HAS_AUTHORITY_FOR_ACTIVITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_ACO	Call by reference	☑	Object reference (TYPE REF TO)	IF_ACO_COMMON		Common Interface for Authorization Check	20090713
2	Importing	IR_COMMON	Call by reference	☑	Object reference (TYPE REF TO)	OBJECT		Interface for all application objects	20080731
3	Importing	IV_RPM_ACTIVITY	Call by reference	☐	Type reference (TYPE)	ACO_ACTVT		Activity for Authorization Check	20080731
4	Importing	IV_USER_ID	Call by reference	☐	Type reference (TYPE)	XUBNAME	SY-UNAME	User Name in User Master Record	20080731
5	Returning	RV_HAS_AUTHORIZATION	Value transfer	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20080731

Method HAS_AUTHORITY_FOR_ACTIVITY on class /RPM/CL_DOCUMENT_API has no exception.

Method INIT_EDMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_COMMON	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT		Interface for All Application Objects	20080731
2	Returning	RR_DOCUMENTS	Value transfer	☐	Object reference (TYPE REF TO)	OBJECT		Documents Collection	20080731

Method INIT_EDMS on class /RPM/CL_DOCUMENT_API has no exception.

Method LOCK_UNLOCK_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGE	Call by reference	☐	Type reference (TYPE)	/RPM/TT_MESSAGES		Table Type for Messages	20101015
2	Exporting	EV_RC	Call by reference	☐	Type reference (TYPE)	I		Return code	20101015
3	Importing	IS_CONTEXT	Value transfer	☐	Type reference (TYPE)	/RPM/TS_OBJECT_HIER		Portfolio Hierarchy	20101015
4	Importing	IV_DOC_ID	Value transfer	☐	Type reference (TYPE)	/RPM/TV_GUID		API: Structure for Documents	20101015

Method LOCK_UNLOCK_DOCUMENT on class /RPM/CL_DOCUMENT_API has no exception.

Method MAP_INT2EXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_INT_DATA	Call by reference	☐	Type reference (TYPE)	/RPM/TS_DOCUMENT_EXT		Document in External Display	20081017
2	Returning	RS_EXT_DATA	Value transfer	☐	Type reference (TYPE)	/RPM/TS_API_DOCUMENT		API: Structure for Documents	20081017

Method MAP_INT2EXT on class /RPM/CL_DOCUMENT_API has no exception.

Method MODIFY_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_MODIFICATION	Call by reference	☐	Type reference (TYPE)	TY_MODIFICATION			20080731
2	Exporting	EV_RC	Call by reference	☐	Type reference (TYPE)	I			20090413
3	Importing	IN_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER		Message Handler Interface	20080731

Method MODIFY_DOCUMENT on class /RPM/CL_DOCUMENT_API has no exception.

Method RETRIEVE_DOC_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20081014
2	Importing	IN_EDIT_MODE	Call by reference	☐	Type reference (TYPE)	I		Edit mode of application objects	20081014
3	Importing	IN_FILL_PROPERTIES	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Boolean	20081014
4	Importing	IN_KEYS	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20081014
5	Importing	IN_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER		Message Handler Interface	20081014
6	Exporting	OUT_DATA	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20081014
7	Exporting	OUT_FAILED_KEYS	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20081014

Method RETRIEVE_DOC_VERSION on class /RPM/CL_DOCUMENT_API has no exception.

Method SPLIT_PATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_EXT	Call by reference	☐	Type reference (TYPE)	STRING			20080731
2	Exporting	EV_FILENAME	Call by reference	☐	Type reference (TYPE)	STRING			20080731
3	Exporting	EV_FILENAME_WO_EXT	Call by reference	☐	Type reference (TYPE)	STRING			20080731
4	Exporting	EV_PATH	Call by reference	☐	Type reference (TYPE)	STRING			20080731
5	Importing	IV_FILEPATH	Call by reference	☐	Type reference (TYPE)	STRING			20080731

Method SPLIT_PATH on class /RPM/CL_DOCUMENT_API has no exception.

Method TARGET_IS_VALID_4_INSERT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DATA	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20081104
2	Exporting	ET_KEYS	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20081104
3	Importing	IT_SELECTION_PARAMETERS	Call by reference	☐	Type reference (TYPE)	/RPM/TT_SELECTION_PARAMETERS		Selection Parameters	20081104

Method TARGET_IS_VALID_4_INSERT on class /RPM/CL_DOCUMENT_API has no exception.

Method UPDATE_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_COMMON	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT			20081017
2	Importing	IR_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER		Message Handler Interface	20081017
3	Importing	IS_DOC_DATA	Call by reference	☐	Type reference (TYPE)	/RPM/TS_API_DOCUMENT		API: Structure for Documents	20081017
4	Returning	RR_DOCUMENT	Value transfer	☐	Object reference (TYPE REF TO)	OBJECT			20081017

Method UPDATE_DOCUMENT on class /RPM/CL_DOCUMENT_API has no exception.

Method UPDATE_DOCUMENT_BACKUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/IF_MESSAGE_BUFFER		Message Handler Interface	20081017
2	Importing	IR_COMMON	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT			20081017
3	Importing	IS_FOL_DATA	Call by reference	☐	Type reference (TYPE)	/RPM/TS_API_DOCUMENT		API: Structure for Documents	20081017
4	Importing	IV_FOLDER_GUID	Call by reference	☐	Type reference (TYPE)	/RPM/TV_GUID		Guid for application objects	20081017
5	Returning	RR_DOCUMENT	Value transfer	☐	Object reference (TYPE REF TO)	OBJECT			20081017

Method UPDATE_DOCUMENT_BACKUP on class /RPM/CL_DOCUMENT_API has no exception.

Method UPDATE_FOLDOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	DOC_DATA	Call by reference	☐	Type reference (TYPE)	/RPM/TS_API_DOCUMENT		API: Structure for Documents	20080929
2	Importing	IN_MESSAGE_BUFFER	Call by reference	☐	Object reference (TYPE REF TO)	/RPM/CL_MESSAGE_HANDLE			20080929
3	Importing	IR_COMMON	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT			20080929

Method UPDATE_FOLDOC on class /RPM/CL_DOCUMENT_API has no exception.

History

Last changed by/on	SAP	20141109
SAP Release Created in	500_701