SAP ABAP Class CL_CFX_HYPERLINK (XML-Based Hyperlink)

Hierarchy

☛ CPRXRPM (Software Component) SAP Portfolio and Project Management 6.0
   ⤷ PLM-CFO (Application Component) Collaboration Folders
     ⤷ CFX_FOLDERS (Package) Collaboration Folders: Folder and Documents

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ACO_COMMON	Common Interface for Authorization Check	20020415
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_CFS_AUTH_NEEDER	Interface for cFolders Authorization	20041207
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_CFX_ALIAS	Alias Names for Objects	20010613
4	Interface implementation (CLASS c. INTERFACES i_ref)	IF_CFX_COMMON	Common Interface for All Objects	20010108
5	Interface implementation (CLASS c. INTERFACES i_ref)	IF_CFX_DOCUMENT	Common Interface for All Documents	20001127
6	Interface implementation (CLASS c. INTERFACES i_ref)	IF_CFX_GO_DATA_PARENT	Object Interface for Object with Generic Data	20030130
7	Interface implementation (CLASS c. INTERFACES i_ref)	IF_CFX_ITERATOR_ELEMENT	Common Interface for All Objects That Can Be Iterated	20001127
8	Interface implementation (CLASS c. INTERFACES i_ref)	IF_CFX_SEARCHEABLE	CFX Search: Interface of Object for Search	20010906

Properties

Class	CL_CFX_HYPERLINK
Short Description	XML-Based Hyperlink
Super Class
Instantiability of a Class	0	Private
Final	☐

General Data

Message Class
Program status
Category	0
Package	CFX_FOLDERS	Collaboration Folders: Folder and Documents
Created	20001127	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	IXML	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_ACO_COMMON	☐	☐	Common Interface for Authorization Check	20020415
2	IF_CFS_AUTH_NEEDER	☐	☐	Interface for cFolders Authorization	20041207
3	IF_CFX_ALIAS	☐	☐	Alias Names for Objects	20010613
4	IF_CFX_COMMON	☐	☐	Common Interface for All Objects	20010108
5	IF_CFX_DOCUMENT	☐	☐	Common Interface for All Documents	20001127
6	IF_CFX_GO_DATA_PARENT	☐	☐	Object Interface for Object with Generic Data	20030130
7	IF_CFX_ITERATOR_ELEMENT	☐	☐	Common Interface for All Objects That Can Be Iterated	20001127
8	IF_CFX_SEARCHEABLE	☐	☐	CFX Search: Interface of Object for Search	20010906

Friends

Class CL_CFX_HYPERLINK has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MP_APPLICATION	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_CFX_FOL_APPLICATION		Application Singleton for Folders Packet	20001127
2	MP_DOCUMENT	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_CFX_COMMON_DOCUMENT		Collaboration Folders Document Class	20001127
3	MP_DOM	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT		IF_IXML_DOCUMENT for the Hyperlink Data	20001127
4	M_BACTIVE	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		If X write_content Really Writes	20001129
5	M_DESCRIPTION	Instance attribute	Private	☐	Type reference (TYPE)	CFX_STRING		The Description of the Hyperlink	20001205
6	M_DOCUMENT_NEW	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		If Member Document is Still Empty	20010313
7	M_ID	Instance attribute	Private	☐	Type reference (TYPE)	GUID		The Hyperlink GUID	20001205
8	M_LINK	Instance attribute	Protected	☐	Type reference (TYPE)	CFX_STRING		The Link Itself	20001205
9	M_NAME	Instance attribute	Private	☐	Type reference (TYPE)	CFX_STRING		The Name of the Hyperlink	20001205
10	SC_TAG_DESCRIPTION	Static Attribute	Protected	☐	Type reference (TYPE)	STRING		XML-Tag DESCRIPTION	20001129
11	SC_TAG_HYPERLINK	Static Attribute	Protected	☐	Type reference (TYPE)	STRING		XML Tag for the Hyperlink	20001127
12	SC_TAG_ID	Static Attribute	Protected	☐	Type reference (TYPE)	STRING		XML Tag	20001129
13	SC_TAG_LINK	Static Attribute	Protected	☐	Type reference (TYPE)	STRING		XML Tag	20001129
14	SC_TAG_NAME	Static Attribute	Protected	☐	Type reference (TYPE)	STRING		XML Tag NAME	20001129

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ANALYSE	Instance method	Private	Method	Reads the DOM from MP_DOM; Extracts Relevant Data	20001128
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR of a HL-Instance	20001127
3	CREATE	Static method	Public	Method	Generates a New Hyperlink	20001127
4	FILL_DOM	Instance method	Private	Method	Fills DOM with current MS* vars	20001130
5	GET_ALL_DATA	Instance method	Public	Method	Returns ID, Name, Description and Link	20001213
6	GET_DOM	Instance method	Private	Method	Reads in the Hyperlink DOM	20001128
7	GET_HYPERLINK_CACHE	Instance method	Public	Method	Get Redundant Cache for XML-Based Hyperlinks	20050214
8	GET_LINK	Instance method	Public	Method	Delivers the URL (the Hyperlink)	20001128
9	INITIALIZE	Static method	Public	Method	Delivers an Instance to a Key	20001127
10	RAISE_CREATED	Instance method	Private	Method		20010705
11	RAISE_CREATED_AS_COPY	Instance method	Private	Method		20010705
12	REGISTER	Static method	Public	Method	Registers the Hyperlink	20001127
13	SET_ALL_DATA	Instance method	Public	Method	Sets Name, Description and Link	20010202
14	SET_HYPERLINK_CACHE	Instance method	Public	Method	Set Redundant Cache for XML-Based Hyperlinks	20050214
15	SET_LINK	Instance method	Public	Method	Sets the Link	20001128
16	UNREGISTER	Instance method	Private	Method	Registers Structure as Belonging to Folders	20020422
17	WRITE_CONTENT	Instance method	Private	Method	Saves the DOM in a Document Persistently	20001129

Events

#	Event	Type	Visibility	Description	Created on
1	NOTIFY_REFERENCE	Instance Event (0)	Public (2)	Inform Reference Object of Hyperlink	20050215

Types

Class CL_CFX_HYPERLINK has no local type.

Method Signatures

Method ANALYSE Signature

Method ANALYSE on class CL_CFX_HYPERLINK has no parameter.
Method ANALYSE on class CL_CFX_HYPERLINK has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_CFX_HYPERLINK has no parameter.
Method CONSTRUCTOR on class CL_CFX_HYPERLINK has no exception.

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_IF_REFERENCE	Call by reference	☑	Object reference (TYPE REF TO)	IF_CFX_COMMON		Gemeinsame Schnittstelle aller Objekte	20050118
2	Importing	IP_OBJECT_TYPING	Call by reference	☑	Object reference (TYPE REF TO)	CL_CFX_OBJECT_TYPING		Objekt - Typisierung	20030114
3	Importing	IP_PARENT_FOLDER	Call by reference	☐	Object reference (TYPE REF TO)	CL_CFX_COMMON_FOLDER		Mappe für Collaboration Folders	20001127
4	Importing	I_CLASSNAME	Call by reference	☐	Type reference (TYPE)	SEOCLSNAME	CFXF1_SC_CLASS_NAME_CFX_DOC	Objekttypname	20041111
5	Importing	I_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	CFX_DOCUMENT_DESCRIPTION		Beschreibung des Hyperlinks	20001127
6	Importing	I_LINK	Call by reference	☑	Type reference (TYPE)	CFX_STRING		Die URL, wo der Hyperlink hinzeigen soll	20001130
7	Importing	I_NAME	Call by reference	☐	Type reference (TYPE)	CFX_DOCUMENT_NAME		Name des Hyperlinks	20001127
8	Importing	I_USED_BY	Call by reference	☐	Type reference (TYPE)	SKWF_APPL	CFXF1_SC_APPLICATION	Zu welcher Applikation gehört das Objekt?	20041117
9	Returning	RP_HYPERLINK	Value transfer	☐	Object reference (TYPE REF TO)	CL_CFX_HYPERLINK		XML basierter Hyperlink	20001127

Method CREATE on class CL_CFX_HYPERLINK has no exception.

Method FILL_DOM Signature

Method FILL_DOM on class CL_CFX_HYPERLINK has no parameter.
Method FILL_DOM on class CL_CFX_HYPERLINK has no exception.

Method GET_ALL_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	STRING		Beschreibung des Dokuments	20001213
2	Exporting	E_ID	Call by reference	☐	Type reference (TYPE)	STRING		Id des Dokuments	20001213
3	Exporting	E_LINK	Call by reference	☐	Type reference (TYPE)	STRING		Eingeschlossener Link (Nutzdaten)	20001213
4	Exporting	E_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name des Dokuments	20001213
5	Importing	I_TRACK_ACCESS	Call by reference	☐	Type reference (TYPE)	CFX_BOOLEAN	ABAP_TRUE	Boolscher Typ	20011129

Method GET_ALL_DATA on class CL_CFX_HYPERLINK has no exception.

Method GET_DOM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TRACK_ACCESS	Call by reference	☐	Type reference (TYPE)	CFX_BOOLEAN	ABAP_TRUE	Boolscher Typ	20011129
2	Returning	RP_DOM	Value transfer	☐	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT		Ref zu dem IF_IXML_DOCUMENT DOM	20001128

Method GET_DOM on class CL_CFX_HYPERLINK has no exception.

Method GET_HYPERLINK_CACHE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_HYPERLINK_CACHE	Call by reference	☐	Type reference (TYPE)	CFX_TT_HYPERLINK_CACHE		Hyperlinks (redundant, als Cache zu XML-Dateien)	20050214

Method GET_HYPERLINK_CACHE on class CL_CFX_HYPERLINK has no exception.

Method GET_LINK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TRACK_ACCESS	Call by reference	☐	Type reference (TYPE)	CFX_BOOLEAN	ABAP_TRUE	Boolscher Typ	20011129
2	Returning	R_LINK	Value transfer	☐	Type reference (TYPE)	CFX_STRING		der Hyperlink	20001206

Method GET_LINK on class CL_CFX_HYPERLINK has no exception.

Method INITIALIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_PARENT_FOLDER	Call by reference	☑	Object reference (TYPE REF TO)	CL_CFX_COMMON_FOLDER		Mappe für Collaboration Folders	20001127
2	Importing	I_DOCUMENT_GUID	Call by reference	☐	Type reference (TYPE)	GUID_32		GUID im 'CHAR' Format in Großschreibung	20001127
3	Returning	RP_HYPERLINK	Value transfer	☐	Object reference (TYPE REF TO)	CL_CFX_HYPERLINK		XML basierter Hyperlink	20001127

Method INITIALIZE on class CL_CFX_HYPERLINK has no exception.

Method RAISE_CREATED Signature

Method RAISE_CREATED on class CL_CFX_HYPERLINK has no parameter.
Method RAISE_CREATED on class CL_CFX_HYPERLINK has no exception.

Method RAISE_CREATED_AS_COPY Signature

Method RAISE_CREATED_AS_COPY on class CL_CFX_HYPERLINK has no parameter.
Method RAISE_CREATED_AS_COPY on class CL_CFX_HYPERLINK has no exception.

Method REGISTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_HYPERLINK	Call by reference	☐	Object reference (TYPE REF TO)	CL_CFX_HYPERLINK		XML basierter Hyperlink	20001127

Method REGISTER on class CL_CFX_HYPERLINK has no exception.

Method SET_ALL_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	STRING			20010202
2	Importing	I_LINK	Call by reference	☐	Type reference (TYPE)	CFX_STRING		Zeichenkette für Collaboration Folders	20010202
3	Importing	I_NAME	Call by reference	☐	Type reference (TYPE)	CFX_DOCUMENT_NAME		Name eine Dokuments	20010202

Method SET_ALL_DATA on class CL_CFX_HYPERLINK has no exception.

Method SET_HYPERLINK_CACHE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_REFERENCE_CFX_ID	Call by reference	☐	Type reference (TYPE)	CFX_ID		ID des Objektes der Referenz	20050214
2	Importing	I_REFERENCE_ID	Call by reference	☐	Type reference (TYPE)	CFX_STRING		ID der Referenz	20050214

Method SET_HYPERLINK_CACHE on class CL_CFX_HYPERLINK has no exception.

Method SET_LINK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LINK	Call by reference	☐	Type reference (TYPE)	CFX_STRING		Der (neue) Hyperlink	20001128

Method SET_LINK on class CL_CFX_HYPERLINK has no exception.

Method UNREGISTER Signature

Method UNREGISTER on class CL_CFX_HYPERLINK has no parameter.
Method UNREGISTER on class CL_CFX_HYPERLINK has no exception.

Method WRITE_CONTENT Signature

Method WRITE_CONTENT on class CL_CFX_HYPERLINK has no parameter.
Method WRITE_CONTENT on class CL_CFX_HYPERLINK has no exception.

Event Signatures

Event NOTIFY_REFERENCE Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	I_IS_LINKED	Exporting	Value transfer	☐	Type reference (TYPE)	CFX_BOOLEAN		'X' = Für die Referenz existiert mindestens ein Hyperlink	20050215
2	I_REFERENCE_CFX_ID	Exporting	Value transfer	☐	Type reference (TYPE)	CFX_ID		ID des Objektes der Referenz	20050215
3	I_REFERENCE_ID	Exporting	Value transfer	☐	Type reference (TYPE)	GUID_16		Dokument ID der Referenz	20050215

History

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