SAP ABAP Class CL_CFX_AREA_UI (Adapter Object for Collaboration)

Hierarchy

☛ CPRXRPM (Software Component) SAP Portfolio and Project Management 6.0
   ⤷ PLM-CFO (Application Component) Collaboration Folders
     ⤷ CFX_UI (Package) Collaboration Folders: User Interface

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_CFX_AUTHORITY_UI	Interface for Authorizations	20020503

Properties

Class	CL_CFX_AREA_UI
Short Description	Adapter Object for Collaboration
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	CFX_UI	Collaboration Folders: User Interface
Created	20010117	SAP
Last change	20141109
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)
2	CFXF1	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
3	CL_CFX_CONST_UI	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_CFX_AUTHORITY_UI	☐	☐	Interface for Authorizations	20020503

Friends

Class CL_CFX_AREA_UI has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	SC_IS_SYNDICATE	Constant	Public	☐	Type reference (TYPE)	STRING	'is_syndicate'		20041022

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_TO_FAVORITES	Static method	Public	Method	Changes an Area	20020215
2	CREATE	Static method	Public	Method	Creates an Area	20010117
3	GET	Static method	Public	Method	Area	20010117
4	GET_URL_FOR_AREA	Static method	Public	Method	Returns the URL of the area_de.htm Page	20010119
5	NAVIGATE_TO_PARENT	Static method	Public	Method	Goes to the Collaboration Page If Authorization is OK	20020805
6	SET	Static method	Public	Method	Changes an Area	20010117

Events

Class CL_CFX_AREA_UI has no event.

Types

Class CL_CFX_AREA_UI has no local type.

Method Signatures

Method ADD_TO_FAVORITES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_MSG_ID	Call by reference	☐	Type reference (TYPE)	STRING			20020215
2	Exporting	E_MSG_TXT	Call by reference	☐	Type reference (TYPE)	STRING			20020215
3	Importing	I_AREA_ID	Value transfer	☐	Type reference (TYPE)	STRING			20020215
4	Importing	I_COL_ID	Value transfer	☐	Type reference (TYPE)	STRING			20020215

Method ADD_TO_FAVORITES on class CL_CFX_AREA_UI has no exception.

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_AREA_ID	Call by reference	☐	Type reference (TYPE)	STRING			20010117
2	Exporting	E_BGROUND_PROCESS_ID	Call by reference	☐	Type reference (TYPE)	STRING			20010723
3	Exporting	E_BGROUND_PROCESS_INFO	Call by reference	☐	Type reference (TYPE)	STRING			20010723
4	Exporting	E_ERROR_OCCURRED	Call by reference	☐	Type reference (TYPE)	CFX_BOOLEAN		Boolscher Typ	20010808
5	Exporting	E_MSG_ID	Call by reference	☐	Type reference (TYPE)	STRING			20010808
6	Exporting	E_MSG_TXT	Call by reference	☐	Type reference (TYPE)	STRING			20010808
7	Importing	IP_NAVIGATION	Call by reference	☐	Object reference (TYPE REF TO)	IF_BSP_NAVIGATION		BSP Navigation	20010117
8	Importing	I_COL_ID	Call by reference	☐	Type reference (TYPE)	STRING			20010119
9	Importing	I_DESCRIPTION	Call by reference	☑	Type reference (TYPE)	STRING			20010117
10	Importing	I_IS_SYNDICATE	Call by reference	☐	Type reference (TYPE)	CFX_IS_SYNDICATE	ABAP_TRUE	Konsortium	20041021
11	Importing	I_NAME	Call by reference	☑	Type reference (TYPE)	STRING			20010117

#	Exception	Resumable	Description	Created on
1	FATAL_ERROR	☐		20010117
2	NO_AUTHORITY	☐		20010117

Method GET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EP_AREA	Call by reference	☐	Object reference (TYPE REF TO)	CL_CFX_AREA		Collaboration: Area	20030806
2	Exporting	EP_MEMBER	Call by reference	☐	Object reference (TYPE REF TO)	CL_CFX_UI_TABLE		CL_CFX_UI_TABLE	20010209
3	Exporting	ES_AUTHORITY_UI	Call by reference	☐	Type reference (TYPE)	CFX_TS_INPUTFIELD		structure for ui object inputfield	20020702
4	Exporting	ES_BUTTON_ASSIGN_PROFILE	Call by reference	☐	Type reference (TYPE)	CFX_TS_BUTTON		structure for ui object button	20020603
5	Exporting	ES_BUTTON_STATUS_PROTOCOL	Call by reference	☐	Type reference (TYPE)	CFX_TS_BUTTON		structure for ui object button	20030129
6	Exporting	ES_BUTTON_UNASSIGN_PROFILE	Call by reference	☐	Type reference (TYPE)	CFX_TS_BUTTON		structure for ui object button	20020603
7	Exporting	ES_BUTTON_WEBDAV_URL	Call by reference	☐	Type reference (TYPE)	CFX_TS_BUTTON		structure for ui object button	20050617
8	Exporting	ES_COL_NAME	Call by reference	☐	Type reference (TYPE)	CFX_TS_FIELD		Beschreibung eines Attributs	20010122
9	Exporting	ES_CONTEXTS	Call by reference	☐	Type reference (TYPE)	CFX_TS_FUNCTION		Beschreibung einer Funktion	20010619
10	Exporting	ES_CREATE_CANCEL	Call by reference	☐	Type reference (TYPE)	CFX_TS_FUNCTION		Abbrechn beim Anlegen	20010117
11	Exporting	ES_CREATE_SUBMIT	Call by reference	☐	Type reference (TYPE)	CFX_TS_FUNCTION		Neuer Eintrag sichern	20010117
12	Exporting	ES_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	CFX_TS_FIELD		Beschreibung eines Attributs	20010117
13	Exporting	ES_EDIT	Call by reference	☐	Type reference (TYPE)	CFX_TS_FUNCTION		Ändern	20010117
14	Exporting	ES_EDIT_AUTHORITY	Call by reference	☐	Type reference (TYPE)	CFX_TS_FUNCTION		Berechtigungen bearbeiten	20010117
15	Exporting	ES_EDIT_CANCEL	Call by reference	☐	Type reference (TYPE)	CFX_TS_FUNCTION		Abbrechen beim Ändern	20010117
16	Exporting	ES_EDIT_SUBMIT	Call by reference	☐	Type reference (TYPE)	CFX_TS_FUNCTION		Geänderter Eintrag sichern	20010117
17	Exporting	ES_IS_SYNDICATE	Call by reference	☐	Type reference (TYPE)	CFX_TS_CHECKBOX		structure for ui object checkbox	20041021
18	Exporting	ES_NAME	Call by reference	☐	Type reference (TYPE)	CFX_TS_FIELD		Beschreibung eines Attributs	20010117
19	Exporting	ES_NTF_OVERVIEW	Call by reference	☐	Type reference (TYPE)	CFX_TS_FUNCTION		Notification overview page	20011026
20	Exporting	ES_STATUS_CONTROLS	Call by reference	☐	Type reference (TYPE)	CFX_TS_STATUS_CONTROLS		UI-Elemente für Status auf einer Objekt-Seite	20020603
21	Exporting	E_IS_PUBLIC	Call by reference	☐	Type reference (TYPE)	CFX_BOOLEAN		Zeigt an, dass es ich um ein Einkäuferarbeitsbereich handelt	20010118
22	Exporting	E_TOPIC_ID	Call by reference	☐	Type reference (TYPE)	STRING			20010611
23	Importing	IP_NAVIGATION	Call by reference	☐	Object reference (TYPE REF TO)	IF_BSP_NAVIGATION		BSP Navigation	20010117
24	Importing	I_AREA_ID	Call by reference	☐	Type reference (TYPE)	STRING			20010117
25	Importing	I_COL_ID	Call by reference	☐	Type reference (TYPE)	STRING			20010117
26	Importing	I_MODE	Call by reference	☐	Type reference (TYPE)	CFX_MODE	CL_CFX_CONST_UI=>SC_MODE_DISPLAY	Bearbeitungsmodus für Collaboration Folders	20010117

#	Exception	Resumable	Description	Created on
1	FATAL_ERROR	☐		20010117
2	NO_AUTHORITY	☐		20010117
3	OBJECT_NOT_EXISTING	☐		20010117

Method GET_URL_FOR_AREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ACTION	Call by reference	☑	Type reference (TYPE)	CFX_MODE		Bearbeitungsmodus für Collaboration Folders	20010119
2	Importing	I_AREA_ID	Call by reference	☐	Type reference (TYPE)	STRING			20010119
3	Importing	I_COL_ID	Call by reference	☐	Type reference (TYPE)	STRING			20010119
4	Importing	I_PAGENAME	Call by reference	☑	Type reference (TYPE)	CFX_BSPPAGE		Name einer BSP-Seite	20010119
5	Importing	I_ROLE	Call by reference	☐	Type reference (TYPE)	CFX_ROLE		role of a cfx user	20010119
6	Returning	R_URL	Value transfer	☐	Type reference (TYPE)	STRING			20010119

Method GET_URL_FOR_AREA on class CL_CFX_AREA_UI has no exception.

Method NAVIGATE_TO_PARENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_NAVIGATE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20020805
2	Importing	IP_NAVIGATION	Call by reference	☐	Object reference (TYPE REF TO)	IF_BSP_NAVIGATION		Business Server Page (BSP) Navigation	20020805
3	Importing	I_AREA_ID	Call by reference	☐	Type reference (TYPE)	STRING			20020805
4	Importing	I_COL_ID	Call by reference	☐	Type reference (TYPE)	STRING			20020805

Method NAVIGATE_TO_PARENT on class CL_CFX_AREA_UI has no exception.

Method SET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ERROR_OCCURRED	Call by reference	☐	Type reference (TYPE)	CFX_BOOLEAN		Boolscher Typ	20010808
2	Exporting	E_MSG_ID	Call by reference	☐	Type reference (TYPE)	STRING			20010808
3	Exporting	E_MSG_TXT	Call by reference	☐	Type reference (TYPE)	STRING			20010808
4	Exporting	E_NAVIGATE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20020607
5	Importing	IP_BACK_URL	Call by reference	☐	Object reference (TYPE REF TO)	CL_CFX_URL		URL mit Seite und Parametern	20030902
6	Importing	IP_NAVIGATION	Call by reference	☐	Object reference (TYPE REF TO)	IF_BSP_NAVIGATION		BSP Navigation	20010117
7	Importing	I_AREA_ID	Call by reference	☐	Type reference (TYPE)	STRING			20010122
8	Importing	I_COL_ID	Call by reference	☐	Type reference (TYPE)	STRING			20010122
9	Importing	I_DESCRIPTION	Call by reference	☑	Type reference (TYPE)	STRING			20010117
10	Importing	I_IS_SYNDICATE	Call by reference	☑	Type reference (TYPE)	CFX_IS_SYNDICATE		Konsortium	20041129
11	Importing	I_MODE	Call by reference	☐	Type reference (TYPE)	STRING			20020705
12	Importing	I_NAME	Call by reference	☑	Type reference (TYPE)	STRING			20010117
13	Importing	I_STATUS_ID	Call by reference	☑	Type reference (TYPE)	STRING			20020603

#	Exception	Resumable	Description	Created on
1	FATAL_ERROR	☐		20010117
2	NO_AUTHORITY	☐		20010117
3	OBJECT_NOT_EXISTING	☐		20010117

History

Last changed by/on	SAP	20141109
SAP Release Created in	20A