SAP ABAP Class CL_SRM_SP_PAPERDOC (SP Paper Document - Client)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-RM (Application Component) SAP Records Management
     ⤷ SRM_GENERAL_SP (Package) SRM General SPs

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_SRM_SP_DOCVIEW_GE	SP Document - Client	20021128

Properties

Class	CL_SRM_SP_PAPERDOC
Short Description	SP Paper Document - Client
Super Class	CL_SRM_SP_DOCVIEW_GE	SP Document - Client
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SRM_GENERAL_SP	SRM General SPs
Created	20021128	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_SRM_SWISS_KNIFE_DOC	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	IF_SRM_REFERENCE	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
3	SRMCL	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
4	SRMGS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
5	SRMGU	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
6	SRMIF	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_SRM_SP_PAPERDOC has no interface implemented.

Friends

Class CL_SRM_SP_PAPERDOC has no friend class.

Attributes

Class CL_SRM_SP_PAPERDOC has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONVERT_PAPERDOC	Instance method	Private	Method	Convert paper document to electronic document	20021128
2	CREATE_NEW_PAPERDOC	Instance method	Private	Method	Create a new paper document	20021128
3	DELETE_PAPERDOC	Instance method	Private	Method	Delete the actual paper document	20021128
4	DISPLAY_PAPERDOC	Instance method	Private	Method	Display the actual paper document	20021128
5	FILTER_PROPERTIES	Instance method	Private	Method	Filters Properties	20021128
6	GET_PROPERTIES_FROM_SENDER	Instance method	Private	Method	Get prop of request sender that will be taken into p. doc	20021128
7	HAS_DIGITAL_CONTENT	Instance method	Private	Method	Check whether paper document can be digitalized later	20021128
8	LOCK_PAPERDOC	Instance method	Private	Method	Lock the actual paperdoc	20021128
9	MODIFY_PAPERDOC	Instance method	Private	Method	Modify the actual paperdoc	20021128
10	PROCESS_REQUEST_OUTPLACE	Instance method	Public	Method	Start SP Client Application Outplace	20021128
11	UNLOCK_PAPERDOCK	Instance method	Private	Method	Unlock the actual paperdoc	20021128

Events

Class CL_SRM_SP_PAPERDOC has no event.

Types

Class CL_SRM_SP_PAPERDOC has no local type.

Method Signatures

Method CONVERT_PAPERDOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_RESULT_POID	Call by reference	☐	Object reference (TYPE REF TO)	IF_SRM_POID		POID of result elec. doc	20021128

#	Exception	Resumable	Description	Created on
1	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20021128
2	CX_SRM_NO_AUTHORIZATION	☐	Fehlende Berechtigung	20021128
3	CX_SRM_SPCL_USER_CANCEL	☐	SP Client : Abbruch durch Benutzer	20021128

Method CREATE_NEW_PAPERDOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONNECTION_OBJECT	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT		My connection Object	20021128

#	Exception	Resumable	Description	Created on
1	NOT_AUTHORIZED	☐	User is not authorized	20021128
2	UNEXPECTED_ERROR	☐	Unexpected_error	20021128
3	USER_CANCEL	☐	Action canceled by User	20021128

Method DELETE_PAPERDOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONNECTION_OBJECT	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT		My connection object	20021128

#	Exception	Resumable	Description	Created on
1	NOT_AUTHORIZED	☐	User is not authorized	20021128
2	UNEXPECTED_ERROR	☐	Unexpected error	20021128
3	USER_CANCEL	☐	Action canceled by user	20021128

Method DISPLAY_PAPERDOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONNECTION_OBJECT	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT		My connection object	20021128

#	Exception	Resumable	Description	Created on
1	NOT_AUTHORIZED	☐	User is not authorized	20021128
2	UNEXPECTED_ERROR	☐	Unexpected error	20021128
3	USER_CANCEL	☐	Action canceled by user	20021128

Method FILTER_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	PROPERTIES	Value transfer	☐	Type reference (TYPE)	SRMGS_PROPERTY_TAB		Properties die gefiltert werden sollen	20021128

Method FILTER_PROPERTIES on class CL_SRM_SP_PAPERDOC has no exception.

Method GET_PROPERTIES_FROM_SENDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_PROPERTIES	Value transfer	☐	Type reference (TYPE)	SRMGS_PROPERTY_TAB		gefilterteProperties des sender SP	20021128
2	Importing	IM_OWN_DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_SRM_DOCUMENT		Instanz für eigenes SRM Dokument	20021128
3	Importing	IM_OWN_VARIANT	Call by reference	☐	Object reference (TYPE REF TO)	IF_SRM_VARIANT		Instanz für eigenes SRM Variant	20021128
4	Importing	IM_SENDER_POID	Call by reference	☐	Object reference (TYPE REF TO)	IF_SRM_POID		POID des Sender SP	20021128

Method GET_PROPERTIES_FROM_SENDER on class CL_SRM_SP_PAPERDOC has no exception.

Method HAS_DIGITAL_CONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_IS_DIGITISED	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN		Boolean: Mögliche Werte IF_SRM=>TRUE / FALSE	20021128

Method HAS_DIGITAL_CONTENT on class CL_SRM_SP_PAPERDOC has no exception.

Method LOCK_PAPERDOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_LOCK_USER	Call by reference	☐	Type reference (TYPE)	STRING		User who has locked the doccument	20021128
2	Importing	IM_CONNECTION_OBJECT	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT		My connection object	20021128

#	Exception	Resumable	Description	Created on
1	NOT_AUTHORIZED	☐	User is not authorized	20021128
2	UNEXPECTED_ERROR	☐	Unexpected error	20021128
3	YET_LOCKED	☐	document is currently locked	20021128

Method MODIFY_PAPERDOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONNECTION_OBJECT	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT		My connection object	20021128

#	Exception	Resumable	Description	Created on
1	NOT_AUTHORIZED	☐	User is not authorized	20021128
2	UNEXPECTED_ERROR	☐	Unexpected error	20021128
3	USER_CANCEL	☐	Action canceled by user	20021128

Method PROCESS_REQUEST_OUTPLACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_MODE_PASV	Call by reference	☑	Type reference (TYPE)	SRMBOOLEAN		'X': active mode; space: passive mode	20021128
2	Importing	IM_REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	IF_SRM_REQUEST		Request	20021128

#	Exception	Resumable	Description	Created on
1	CX_SRM_FRAMEWORK	☐	Framework (abstrakt)	20021128
2	CX_SRM_SP_CLIENT	☐	Ausnahme vom SP Client	20021128

Method UNLOCK_PAPERDOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONNECTION_OBJECT	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT		My connection object	20021128

#	Exception	Resumable	Description	Created on
1	UNEXPECTED_ERROR	☐	Unexpected error	20021128

History

Last changed by/on	SAP	20110908
SAP Release Created in	630