SAP ABAP Class CL_PI_DOCUMENT_POC (POC: PI Document (PI Sheet / Cockpit))

Hierarchy

☛ EA-APPL (Software Component) SAP Enterprise Extension PLM, SCM, Financials
   ⤷ PP-PI-PMA-RCP (Application Component) Control Recipe
     ⤷ CMX_PII (Package) Manufacturing Execution: Interpreter

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BFW_CTHANDLER_POC	Browser Framework: Context Menu User	20011119
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ISE_CALLBACK	Intersession Events: Callback for Event Recipient	20011017
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_OS_SERVICE_POC	Domain Model: Persistence Services	19991109
4	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SY_MESS_POC	POC: System Message Processing	19990827

Properties

Class	CL_PI_DOCUMENT_POC
Short Description	POC: PI Document (PI Sheet / Cockpit)
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status	P	SAP Standard Production Program
Category	0
Package	CMX_PII	Manufacturing Execution: Interpreter
Created	19990121	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CA_APPLICATION_STEP_POC	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	POCCO	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_BFW_CTHANDLER_POC	☐	☐	Browser Framework: Context Menu User	20011119
2	IF_ISE_CALLBACK	☐	☐	Intersession Events: Callback for Event Recipient	20011017
3	IF_OS_SERVICE_POC	☐	☐	Domain Model: Persistence Services	19991109
4	IF_SY_MESS_POC	☐	☐	POC: System Message Processing	19990827

Friends

Class CL_PI_DOCUMENT_POC has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CM_PIDOC_TAB	Static Attribute	Protected	☐	Type reference (TYPE)	TY_TREFTOPIDOC		Reference Table to Open PI Documents	19991109
2	CM_SIMULATION	Static Attribute	Public	☐	Type reference (TYPE)	CHAR1		Indicator: At Least One Document is in Simulation Mode	20010109
3	CO_ISE_EVTCLASS_SAVE	Constant	Private	☐	Type reference (TYPE)	CMX_ISE_EVTCLASS	'POC_PI_DOC_SAVED'	Const: Intersession Events	20011018
4	CO_SIMULATION_ATTENTION	Constant	Public	☐	Type reference (TYPE)	CHAR1	'!'	Const: Caution Simulation Mode	20010109
5	CO_SIMULATION_NONE	Constant	Public	☐	Type reference (TYPE)	CHAR1	' '	Const: No Simulation	20010109
6	CO_SIMULATION_RUNNING	Constant	Public	☐	Type reference (TYPE)	CHAR1	'X'	Const: 1 Document Already in Simulation	20010109
7	M_COMMAND_TAB	Instance attribute	Protected	☐	Type reference (TYPE)	TY_COMMAND_TAB		Reference Table to Commands	20011119
8	M_CONNECTOR_TAB	Instance attribute	Protected	☐	Type reference (TYPE)	TY_TREFTOCONN		Reference Table to Connectors	19991108
9	M_DISCARD	Static Attribute	Public	☐	Type reference (TYPE)	FLAG		General Indicator	20130204
10	M_DOC_NAME	Instance attribute	Public	☑	Type reference (TYPE)	POC_DOCID		Document Name	19990827
11	M_SHOW_MODE_FLAG	Instance attribute	Protected	☐	Type reference (TYPE)	FLAG		Indicator: Document to be Started in Display Mode	20000201
12	M_URL_TEMP	Instance attribute	Protected	☐	Type reference (TYPE)	POC_URL		Temporary Status for URL	19991118
13	O_APPLIC_STEP	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_APPLICATION_STEP_POC		Reference to Application Step in Domain Model	19990910
14	O_BFW_DOC	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_BFW_DOCUMENT_POC		Reference to BFW Document in View	19990913

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_CONNECTOR	Instance method	Public	Method	INTERNAL: Add New Conncetor	19991115
2	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20000127
3	CLOSE	Instance method	Public	Method	Close Document	19990913
4	CONSTRUCTOR	Instance method	Public	Constructor	Constructor (Private)	19990827
5	CREATE_LOADER	Static method	Public	Method	PI Document: Load Dependent Files	20030617
6	DELETE_RUNTIME_FROM_DB	Static method	Public	Method	Delete Runtime From DB	19991118
7	DISCARD	Static method	Public	Method	Discard Document (Set Status)	20010112
8	GENERATE	Static method	Public	Method	Create PI Document	19990830
9	GET_INSTANCE	Static method	Public	Method	Get Instance to PI Document	19991126
10	ON_APPLSTEP_AFTER_MODE_CHANGE	Instance method	Private	Event handling method	Mode of Application Step (Domain Model) has Changed	20000411
11	ON_APPLSTEP_BEFORE_MODE_CHANGE	Instance method	Private	Event handling method	Mode of Application Step (Domain Model) Being Changed	20000124
12	ON_BFW_DOC_BEFORE_DISPATCHING	Static method	Private	Event handling method	BFW Document Starts Distributing Data	19991201
13	ON_BFW_DOC_CLOSING	Instance method	Private	Event handling method	BFW Document Is Closed	19990913
14	ON_BFW_DOC_CREATED	Static method	Private	Event handling method	BFW Document Created (Class Event)	19990913
15	ON_BFW_DOC_CREATED_INTERNAL	Instance method	Private	Method	BFW Document Created (Instance Implementation)	20000323
16	ON_BFW_DOC_DISPATCH_COMPLETE	Static method	Private	Event handling method	BFW Document Finishes Data Distribution	20010816
17	ON_COMMAND_STATE_CHANGED	Instance method	Private	Event handling method	Command Status has Changed	20011119
18	ON_NEW_TRANSACTION	Instance method	Private	Event handling method	New Subtransaction Was Opened for New Document	20000124
19	ON_SAVE	Static method	Private	Event handling method	Document Was Saved	20011018
20	ON_SCREEN_LEAVING	Static method	Private	Event handling method	Exiting Screen	19990913
21	STARTUP_RUNTIME	Instance method	Public	Method	Start Runtime	19991104
22	STARTUP_RUNTIME_AND_SHOW	Instance method	Public	Method	Start Runtime, Call Screen, and Display in Browser	19991111

Events

Class CL_PI_DOCUMENT_POC has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_COMMAND_TAB	Protected	See coding		Management Table for Commands	20011119
2	TY_COMMAND_WA	Protected	See coding		Management Table for Commands	20011119
3	TY_REFTOCONN	Protected	Object reference (TYPE REF TO)	CL_CONNECTOR_POC	Type: Reference to Connector	19990127
4	TY_TREFTOCONN	Protected	See coding		Table Type: Reference to Connector	19990127
5	TY_TREFTOPIDOC	Protected	See coding		Table Type: Reference to PI Documents	19991109

Method Signatures

Method ADD_CONNECTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	O_CONNECTOR	Call by reference	☐	Object reference (TYPE REF TO)	CL_CONNECTOR_POC		Referenz auf Connector	19991115

Method ADD_CONNECTOR on class CL_PI_DOCUMENT_POC has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_PI_DOCUMENT_POC has no parameter.
Method CLASS_CONSTRUCTOR on class CL_PI_DOCUMENT_POC has no exception.

Method CLOSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DIALOG	Call by reference	☑	Type reference (TYPE)	FLAG		Flag: Dialog/Sicherheitsabfrage erlaubt	19991202

Method CLOSE on class CL_PI_DOCUMENT_POC has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOC_NAME	Call by reference	☐	Type reference (TYPE)	POC_DOCID		Dokumentname	19990827

Method CONSTRUCTOR on class CL_PI_DOCUMENT_POC has no exception.

Method CREATE_LOADER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_BFW_WEBRESOURCE_POC		POC Browser Framework: abstrakte Oberklasse Web-Ressource	20030617
2	Importing	SOURCE_URL	Call by reference	☐	Type reference (TYPE)	POC_URL	'SAPR3-WR-BFW_DOC_CLIENT.HTML'	POC: URL	20030617
3	Importing	STYLES	Call by reference	☐	Type reference (TYPE)	POC_NAME_TAB		PMC: Layoutdefinition	20030617
4	Importing	XML_DATA	Call by reference	☐	Object reference (TYPE REF TO)	CL_BFW_WEBRESOURCE_POC		POC Browser Framework: abstrakte Oberklasse Web-Ressource	20030617

Method CREATE_LOADER on class CL_PI_DOCUMENT_POC has no exception.

Method DELETE_RUNTIME_FROM_DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DELETE_DOMAIN_MODEL	Call by reference	☐	Type reference (TYPE)	FLAG	'X'	Flag: Domain Model löschen	19991118
2	Importing	DELETE_SIGNATURES	Call by reference	☐	Type reference (TYPE)	FLAG	SPACE	Flag: Signaturen löschen	20000202
3	Importing	DOC_NAME	Call by reference	☐	Type reference (TYPE)	POC_DOCID		Dokumentname	20000317
4	Exporting	DOMAIN_MODEL_DELETED	Call by reference	☐	Type reference (TYPE)	FLAG		Flag: Domain Model wurde erfolgreich gelöscht	20000119
5	Importing	EX_GENERATING	Call by reference	☐	Type reference (TYPE)	FLAG	SPACE	Kennzeichen: Generierungsmodus	20010629
6	Exporting	XML_FILES_DELETED	Call by reference	☐	Type reference (TYPE)	FLAG		Flag: XML-Files wurden erfolgreich gelöscht	20000119

#	Exception	Resumable	Description	Created on
1	LOCKED	☐	Dokument ist z.Z. gesperrt (es wird gerade bearbeitet)	19991222

Method DISCARD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOC_NAME	Call by reference	☐	Type reference (TYPE)	POC_DOCID		Dokumentname	20010112

#	Exception	Resumable	Description	Created on
1	NOT_FOUND	☐	Dokument nicht gefunden	20010112
2	NOT_POSSIBLE	☐	Verwerfen/abbrechen nicht möglich	20010112

Method GENERATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ADRES	Call by reference	☑	Type reference (TYPE)	ADR		Steuerrezeptempfänger	20010904
2	Importing	CHAR_TAB	Call by reference	☐	Type reference (TYPE)	POC_PICHAR_TAB		Merkmalstabelle	19990830
3	Importing	DOC_NAME	Call by reference	☐	Type reference (TYPE)	POC_DOCID		Dokumentname	19990830
4	Exporting	IS_CORRECT	Value transfer	☐	Type reference (TYPE)	FLAG		Flag: keine Syntaxfehler oder -warnungen gefunden	19990902
5	Importing	METADATA_TAB	Call by reference	☐	Type reference (TYPE)	POC_METADATA_TAB		Tabelle für Metadaten	19990830
6	Exporting	O_PI_DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_PI_DOCUMENT_POC		Referenz auf erzeugtes Dokument	19990830
7	Importing	PLANT	Call by reference	☐	Type reference (TYPE)	WERKS_D		Werk	19990830
8	Importing	SETTINGS	Call by reference	☐	Type reference (TYPE)	POC_SETTINGS		Struktur: globale Einstellungen	19990908
9	Importing	SYNTAX_CHECK_ONLY	Call by reference	☑	Type reference (TYPE)	FLAG		Flag: nur Syntaxcheck ausführen	19990830
10	Exporting	WITH_WARNINGS	Value transfer	☐	Type reference (TYPE)	FLAG		Flag: Warnungen aufgetreten	20000204

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Generierung fehlgeschlagen (siehe Messages)	19990830
2	FAILED_TEMPORARY	☐	Generierung temporär fehlgeschlagen (z.B. wegen Sperren)	20010126

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOC_NAME	Call by reference	☐	Type reference (TYPE)	POC_DOCID		Dokumentname	19991126
2	Returning	O_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_PI_DOCUMENT_POC		Referenz auf PI Dokument	19991126

Method GET_INSTANCE on class CL_PI_DOCUMENT_POC has no exception.

Method ON_APPLSTEP_AFTER_MODE_CHANGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EX_MODE	Call by reference	☐	Attribute reference (LIKE)				20000411
2	Importing	SENDER	Call by reference	☐	Type reference (TYPE)				20000411

Method ON_APPLSTEP_AFTER_MODE_CHANGE on class CL_PI_DOCUMENT_POC has no exception.

Method ON_APPLSTEP_BEFORE_MODE_CHANGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EX_MODE	Call by reference	☐	Attribute reference (LIKE)				20000124
2	Importing	EX_RELOAD	Call by reference	☐	Attribute reference (LIKE)				20000331

Method ON_APPLSTEP_BEFORE_MODE_CHANGE on class CL_PI_DOCUMENT_POC has no exception.

Method ON_BFW_DOC_BEFORE_DISPATCHING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOC_ID	Call by reference	☐	Attribute reference (LIKE)				19991201

Method ON_BFW_DOC_BEFORE_DISPATCHING on class CL_PI_DOCUMENT_POC has no exception.

Method ON_BFW_DOC_CLOSING Signature

Method ON_BFW_DOC_CLOSING on class CL_PI_DOCUMENT_POC has no parameter.
Method ON_BFW_DOC_CLOSING on class CL_PI_DOCUMENT_POC has no exception.

Method ON_BFW_DOC_CREATED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOC_ID	Call by reference	☐	Attribute reference (LIKE)				19991029
2	Importing	OBJ	Call by reference	☐	Attribute reference (LIKE)				19991029

Method ON_BFW_DOC_CREATED on class CL_PI_DOCUMENT_POC has no exception.

Method ON_BFW_DOC_CREATED_INTERNAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	O_BFWDOC	Call by reference	☐	Object reference (TYPE REF TO)	IF_BFW_DOCUMENT_POC		Referenz auf BFW-Dokument	20000323

Method ON_BFW_DOC_CREATED_INTERNAL on class CL_PI_DOCUMENT_POC has no exception.

Method ON_BFW_DOC_DISPATCH_COMPLETE Signature

Method ON_BFW_DOC_DISPATCH_COMPLETE on class CL_PI_DOCUMENT_POC has no parameter.
Method ON_BFW_DOC_DISPATCH_COMPLETE on class CL_PI_DOCUMENT_POC has no exception.

Method ON_COMMAND_STATE_CHANGED Signature

Method ON_COMMAND_STATE_CHANGED on class CL_PI_DOCUMENT_POC has no parameter.
Method ON_COMMAND_STATE_CHANGED on class CL_PI_DOCUMENT_POC has no exception.

Method ON_NEW_TRANSACTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EX_DOCUMENT	Call by reference	☐	Attribute reference (LIKE)				20000124
2	Importing	EX_MODE_SHOW	Call by reference	☐	Attribute reference (LIKE)				20000124

Method ON_NEW_TRANSACTION on class CL_PI_DOCUMENT_POC has no exception.

Method ON_SAVE Signature

Method ON_SAVE on class CL_PI_DOCUMENT_POC has no parameter.
Method ON_SAVE on class CL_PI_DOCUMENT_POC has no exception.

Method ON_SCREEN_LEAVING Signature

Method ON_SCREEN_LEAVING on class CL_PI_DOCUMENT_POC has no parameter.
Method ON_SCREEN_LEAVING on class CL_PI_DOCUMENT_POC has no exception.

Method STARTUP_RUNTIME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DISPLAY_MODE	Call by reference	☐	Type reference (TYPE)	FLAG	'X'	Flag: Anzeigemodus	19991126
2	Exporting	ROOT_URL	Call by reference	☐	Type reference (TYPE)	POC_URL		URL des PI-Dokuments am Frontend	19991129
3	Importing	SIMULATION_MODE	Call by reference	☐	Type reference (TYPE)	FLAG	''	Flag: Simulationsmodus	20000126

#	Exception	Resumable	Description	Created on
1	DOC_NOT_FOUND	☐	(Persistentes) Dokument nicht gefunden	19991116
2	FAILED	☐	Fehlgeschlagen	19991104
3	NOT_ALLOWED	☐	Nicht erlaubt, z.B. wenn bereits ein Dokument simuliert wird	20000201
4	NO_AUTHORIZATION	☐	Keine Berechtigung	19991115

Method STARTUP_RUNTIME_AND_SHOW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DISPLAY_MODE	Call by reference	☐	Type reference (TYPE)	FLAG	'X'	Flag: Anzeigemodus	19991111
2	Importing	SIMULATION_MODE	Call by reference	☐	Type reference (TYPE)	FLAG	''	Flag: Simulationsmodus	20000126

#	Exception	Resumable	Description	Created on
1	DOC_NOT_FOUND	☐	(Persistentes) Dokument nicht gefunden	19991116
2	FAILED	☐	Schwerwiegender interner Fehler	19991111
3	NO_AUTHORIZATION	☐	Keine Berechtigung	19991111

History

Last changed by/on	SAP	20130531
SAP Release Created in