SAP ABAP Class CL_RMPS_DOD_DOCTYPE (Dod: Document type handling)

Hierarchy

☛ SAP_ABA (Software Component) Cross-Application Component
   ⤷ CA-GTF-RCM (Application Component) Records and Case Management
     ⤷ RMPS_DOD_PROPERTIES (Package) DoD: Attribute Handling

Properties

Class	CL_RMPS_DOD_DOCTYPE
Short Description	Dod: Document type handling
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	RMPS_DOD_PROPERTIES	DoD: Attribute Handling
Created	20090925	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	IF_SRM	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
2	SRMGS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_RMPS_DOD_DOCTYPE has no interface implemented.

Friends

Class CL_RMPS_DOD_DOCTYPE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_CONN_PAR_DOCTYPE_ENABLED	Constant	Public	☐	Type reference (TYPE)	STRING	'RMPSD_DOCTYPE_ENABLE_ADD_ATTRIS'	Connection parameter ID	20090925
2	C_DMWB_PROP_DOCTYPE	Constant	Public	☐	Type reference (TYPE)	STRING	'DOC_TYPE'	Name of the DOC_TYPE property in DMWB	20090929
3	C_UNKNOWN	Constant	Protected	☐	Type reference (TYPE)	SRMBOOLEAN	'?'	Unknown or not initialized boolean value	20090928
4	C_UOBJ_ID_DOCTYPE	Constant	Public	☐	Type reference (TYPE)	STRING	'RMPS_UOBJ_DOD_DOCTYPE'	User object ID in property context	20090929
5	G_DOCTYPE_HANDLING_ACTIVE	Instance attribute	Protected	☐	Type reference (TYPE)	SRMBOOLEAN	C_UNKNOWN	Is doctype handling active?	20090928
6	G_POID	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_SRM_POID		POID of the document/post item to handle	20090925

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ATTRIBUTE_SHOW_HIDE	Instance method	Protected	Method	Show/hide a single attribute	20090929
2	CHECK_MANDT_ATTR_4_DOCTYPE	Instance method	Public	Method	Prüfe Wert des Attributs RMPSP_DOCTYPE	20100127
3	CONNECTION_PARAMETER_ADD	Static method	Public	Method	Add connection parameter to switch doctype function on/off	20090925
4	CONSTRUCTOR	Instance method	Protected	Constructor	Constructor	20090925
5	DOCTYPE_SPEC_ATTRS_GET	Instance method	Public	Method	Get doctype specific attributes from attr types	20090929
6	DOCTYPE_SPEC_ATTRS_SHOW_HIDE	Instance method	Public	Method	Show/hide attributes depending from doctype	20090929
7	GET_ATTR_VALUE_AS_STRING	Instance method	Protected	Method		20100128
8	GET_DOCTYPES_4_RMPSP_FORMAT	Static method	Public	Method	Get doctypes corresponding with given value of RMPSP_FORMAT	20090930
9	GET_EXTENSION_4_RMPSP_FORMAT	Static method	Public	Method	Get file extension from given value of RMPSP_FORMAT	20090928
10	GET_INSTANCE	Static method	Public	Method	Get instance	20090925
11	GET_INSTANCE_FROM_CONTEXT	Static method	Public	Method	Get instance from property context (or create one)	20090929
12	GET_UNIQUE_DOCTYPE_4_FILE_EXT	Instance method	Public	Method	Get the doctype from the file extension (if unique)	20090928
13	INITIALIZE_DOCTYPE_4_DOCUMENT	Instance method	Public	Method	Inititialize the document type for a document	20090928
14	IS_DOCTYPE_HANDLING_ACTIVE	Instance method	Public	Method	Check whether Dod document type handling is active for POID	20090925
15	QUERY_GET_ATTRS_TO_HIDE	Instance method	Public	Method	Get attributes which must be hidden as search criteria	20091002
16	SEARCH_HELP_SHOW	Static method	Public	Method	Show search help for document types	20090930
17	SORT_OUTPUT_TABLE_AFTER_UPDATE	Instance method	Public	Method	After doctype change: show add. attr. directly after doctype	20090930

Events

Class CL_RMPS_DOD_DOCTYPE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	ATTRNAME_DOCTYPE_TAB_TYPE	Public	See coding		Table: attribute name - doctype	20090929	ATTRNAME_DOCTYPE_TAB_TYPE TYPE STANDARD TABLE OF ATTRNAME_DOCTYPE_TYPE
2	ATTRNAME_DOCTYPE_TYPE	Public	See coding		Structure: attribute name - doctype	20090929	BEGIN OF ATTRNAME_DOCTYPE_TYPE, NAME TYPE SRMGS_PROP_NAME, DOCTYPE TYPE RMPSP_DOCTYPE, END OF ATTRNAME_DOCTYPE_TYPE
3	DOCTYPE_TAB_TYPE	Public	See coding			20090930	DOCTYPE_TAB_TYPE TYPE STANDARD TABLE OF RMPSP_DOCTYPE WITH DEFAULT KEY

Method Signatures

Method ATTRIBUTE_SHOW_HIDE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ATTRIBUTE	Call by reference	☐	Object reference (TYPE REF TO)	IF_SRM_ATTRIBUTE_VALUE		Attribute to show/hide	20090929
2	Importing	IM_SHOW	Call by reference	☐	Type reference (TYPE)	SRMBOOLEAN		Show the attribute? True->show; False->hide	20090929

#	Exception	Resumable	Description	Created on
1	CX_SRM_ATTRIBUTE	☐	Error in Attribute (Abstract)	20090929

Method CHECK_MANDT_ATTR_4_DOCTYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONTEXT	Call by reference	☐	Object reference (TYPE REF TO)	IF_SRM_PROP_CONTEXT		IF_SRM_PROP_CONTEXT	20100127
2	Changing	VAL_HDL_PROPERTY_TAB	Call by reference	☐	Type reference (TYPE)	SRM_LIST_ATTR_VAL_HDL		List: Attribute Value and Selection Field	20100127

#	Exception	Resumable	Description	Created on
1	CX_SRM_ATTR_VALUE_NOT_SET	☐	Value Not Set	20100128

Method CONNECTION_PARAMETER_ADD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CH_CONNECTION_PARAMS	Value transfer	☐	Type reference (TYPE)	SRM_LIST_EDIT_ATTRIBUTE_DESC		Description of connection parameter	20090925
2	Importing	IM_IF_SRM	Call by reference	☐	Object reference (TYPE REF TO)	IF_SRM		General SRM Methods	20090925

#	Exception	Resumable	Description	Created on
1	CX_SRM_ATTRIBUTE_DESCRIPTION	☐	Attribute Description (abstract)	20090925
2	CX_SRM_INITIALIZATION	☐	Initialization Error (abstract)	20090925

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_POID	Call by reference	☐	Object reference (TYPE REF TO)	IF_SRM_POID		POID of the document/post item to handle	20090925

Method CONSTRUCTOR on class CL_RMPS_DOD_DOCTYPE has no exception.

Method DOCTYPE_SPEC_ATTRS_GET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	SRMGS_PROPERTY_TYPE_TAB		List of doctype specific attributes (1 line per attr.)	20090929
2	Exporting	EX_ATTRIBUTES_DOCTYPES	Call by reference	☐	Type reference (TYPE)	ATTRNAME_DOCTYPE_TAB_TYPE		List of doctypes per attribute (n doctypes per attr.)	20090929
3	Importing	IM_ATTR_TYPES	Call by reference	☐	Type reference (TYPE)	SRMGS_PROPERTY_TYPE_TAB		Attribute types	20090929

Method DOCTYPE_SPEC_ATTRS_GET on class CL_RMPS_DOD_DOCTYPE has no exception.

Method DOCTYPE_SPEC_ATTRS_SHOW_HIDE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CH_VAL_HDL_TAB	Call by reference	☑	Type reference (TYPE)	SRM_LIST_ATTR_VAL_HDL		Alternatively: value handling table (called from PROP_VALUE)	20090929
2	Importing	IM_ATTR_TAB	Call by reference	☑	Type reference (TYPE)	SRM_LIST_ATTRIBUTE_VALUE		Attribute table (called from PROP_REPOSITORY)	20090929
3	Importing	IM_CONTEXT	Call by reference	☐	Object reference (TYPE REF TO)	IF_SRM_PROP_CONTEXT		Property context	20090929
4	Importing	IM_DOCTYPE	Call by reference	☑	Type reference (TYPE)	RMPSP_DOCTYPE		Document Type (may be omitted, if value contained in table)	20090929
5	Importing	IM_EMAIL_TYPE	Call by reference	☑	Type reference (TYPE)	STRING		Email type (body or attachment)	20091001

#	Exception	Resumable	Description	Created on
1	CX_SRM_FRAMEWORK	☐	Framework (abstract)	20090929

Method GET_ATTR_VALUE_AS_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_ATTR_DESC	Call by reference	☐	Type reference (TYPE)	STRING			20100128
2	Exporting	EX_ATTR_VALUE	Call by reference	☐	Type reference (TYPE)	STRING			20100128
3	Importing	IM_ATTR_ID	Call by reference	☐	Type reference (TYPE)	SRMGS_PROP_NAME			20100128
4	Importing	IM_LIST	Call by reference	☐	Type reference (TYPE)	SRM_LIST_ATTR_VAL_HDL		List: Attribute Value and Selection Field	20100128

Method GET_ATTR_VALUE_AS_STRING on class CL_RMPS_DOD_DOCTYPE has no exception.

Method GET_DOCTYPES_4_RMPSP_FORMAT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_RMPSP_FORMAT	Call by reference	☐	Type reference (TYPE)	STRING		Value of RMPSP_FORMAT	20090930
2	Returning	RE_DOCTYPES	Value transfer	☐	Type reference (TYPE)	DOCTYPE_TAB_TYPE		Possible document types for the given value of RMPSP_FORMAT	20090930

Method GET_DOCTYPES_4_RMPSP_FORMAT on class CL_RMPS_DOD_DOCTYPE has no exception.

Method GET_EXTENSION_4_RMPSP_FORMAT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_RMPSP_FORMAT	Call by reference	☐	Type reference (TYPE)	STRING		Value of RMPSP_FORMAT	20090928
2	Returning	RE_EXTENSION	Value transfer	☐	Type reference (TYPE)	STRING		File extension	20090928

Method GET_EXTENSION_4_RMPSP_FORMAT on class CL_RMPS_DOD_DOCTYPE has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CLASS_NAME	Call by reference	☐	Type reference (TYPE)	STRING	'CL_RMPS_DOD_DOCTYPE'	Class name	20090925
2	Importing	IM_POID	Call by reference	☐	Object reference (TYPE REF TO)	IF_SRM_POID		POID of the document/post item to handle	20090925
3	Returning	RE_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_RMPS_DOD_DOCTYPE		The instance	20090925

Method GET_INSTANCE on class CL_RMPS_DOD_DOCTYPE has no exception.

Method GET_INSTANCE_FROM_CONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONTEXT	Call by reference	☐	Object reference (TYPE REF TO)	IF_SRM_PROP_CONTEXT		Property context	20090929
2	Returning	RE_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_RMPS_DOD_DOCTYPE		The instance	20090929

Method GET_INSTANCE_FROM_CONTEXT on class CL_RMPS_DOD_DOCTYPE has no exception.

Method GET_UNIQUE_DOCTYPE_4_FILE_EXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_FILE_EXTENSION	Call by reference	☐	Type reference (TYPE)	STRING		File-Extension	20090928
2	Returning	RE_DOC_TYPE	Value transfer	☐	Type reference (TYPE)	RMPSP_DOCTYPE		Document Type	20090928

Method GET_UNIQUE_DOCTYPE_4_FILE_EXT on class CL_RMPS_DOD_DOCTYPE has no exception.

Method INITIALIZE_DOCTYPE_4_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CH_INITIALIZED_PROPERTIES	Call by reference	☐	Type reference (TYPE)	SRMGS_PROPERTY_TAB		Initialized properties	20090928
2	Importing	IM_VAR_PROPERTY_TYPES	Call by reference	☐	Type reference (TYPE)	SRMGS_PROPERTY_TYPE_TAB		Property definitions (variant)	20090928

Method INITIALIZE_DOCTYPE_4_DOCUMENT on class CL_RMPS_DOD_DOCTYPE has no exception.

Method IS_DOCTYPE_HANDLING_ACTIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_IS_ACTIVE	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN		True, if Dod document type handling is active	20090925

Method IS_DOCTYPE_HANDLING_ACTIVE on class CL_RMPS_DOD_DOCTYPE has no exception.

Method QUERY_GET_ATTRS_TO_HIDE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ATTR_TYPES	Call by reference	☐	Type reference (TYPE)	SRMGS_PROPERTY_TYPE_TAB		Attribute definitions	20091002
2	Returning	RE_ATTRS_TO_HIDE	Value transfer	☐	Type reference (TYPE)	SRMGS_PROPERTY_TYPE_TAB		Attributes to hide	20091002

Method QUERY_GET_ATTRS_TO_HIDE on class CL_RMPS_DOD_DOCTYPE has no exception.

Method SEARCH_HELP_SHOW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_DOCTYPE	Call by reference	☐	Type reference (TYPE)	RMPSP_DOCTYPE		Selected document type	20090930
2	Exporting	EX_DOCTYPE_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	STRING		Description for the document type	20090930
3	Exporting	EX_USER_CANCEL	Call by reference	☐	Type reference (TYPE)	SRMBOOLEAN		Dialog cancelled by the user?	20090930
4	Importing	IM_DISPLAY_ONLY	Call by reference	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>FALSE	Only display?	20090930
5	Importing	IM_RMPSP_FORMAT	Call by reference	☑	Type reference (TYPE)	STRING		File format (value of attr. RMPSP_FORMAT or only extension)	20090930

Method SEARCH_HELP_SHOW on class CL_RMPS_DOD_DOCTYPE has no exception.

Method SORT_OUTPUT_TABLE_AFTER_UPDATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CH_OUTPUT_TAB	Call by reference	☐	Type reference (TYPE)	SRM_PROP_ALV_2COL_OUT_T		ALV output table of attribute dialog	20090930
2	Importing	IM_ATTR_VAL_HDL_TAB	Call by reference	☐	Type reference (TYPE)	SRM_LIST_ATTR_VAL_HDL		Value handling table	20090930
3	Importing	IM_CONTEXT	Call by reference	☐	Object reference (TYPE REF TO)	IF_SRM_PROP_CONTEXT		Property context	20090930

Method SORT_OUTPUT_TABLE_AFTER_UPDATE on class CL_RMPS_DOD_DOCTYPE has no exception.

History

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