SAP ABAP Class CL_CIM_REFERENCE (Reference to CIM Namespace, Class, or Instance)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-CCM-SLD-ABA (Application Component) System Landscape Directory ABAP Connectivity
     S_WBEM_CIM (Package) WBEM Client: CIM Objects
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  CL_CIM_ELEMENT Basis Class for CIM Elements 20080711
2 Interface implementation (CLASS c. INTERFACES i_ref)  IF_CIM_REF_NORMALIZABLE Reference-Normalizable CIM Element 20081217
Properties
Class CL_CIM_REFERENCE  
Short Description Reference to CIM Namespace, Class, or Instance    
Super Class CL_CIM_ELEMENT Basis Class for CIM Elements 
Instantiability of a Class 0  Private 
Final    
General Data
Message Class    
Program status     
Category 0   
Package S_WBEM_CIM   WBEM Client: CIM Objects 
Created 20080711   SAP 
Last change 20110908   SAP 
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)
Interfaces
# Interface Abstract Final Description Created on
1 IF_CIM_REF_NORMALIZABLE Reference-Normalizable CIM Element 20081217
Friends
# Friend Modeled only Created on Description
1 CL_CIM_DECLGROUP 20081125 Group of objects in a CIM declaration
2 CL_CIM_OBJECT 20090403 Basis Class for CIM Class and CIM Instance
3 CL_CIM_OBJECTWITHREFERENCE 20080930 Container for CIM object and its reference
4 CL_CIM_XMLPARSER 20081103 Interprets the XML representation of a CIM element
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 CLASSNAME Instance attribute Public Object reference (TYPE REF TO) CL_CIM_ELEMENTNAME Class Name 20080715
2 HOST Instance attribute Public Object reference (TYPE REF TO) CL_CIM_ELEMENTNAME Host Name 20080711
3 KEYS Instance attribute Public Type reference (TYPE) CIM_T_KEY CIM Key 20080715
4 NAMESPACE Instance attribute Public Object reference (TYPE REF TO) CL_CIM_NAMESPACE Represents the name of a CIM namespace 20080715
5 REGEX_BOOL_OR_NUM_KEY Static Attribute Private Object reference (TYPE REF TO) CL_ABAP_REGEX Regular Expressions 20091208
6 REGEX_DOT_EQUALS Static Attribute Private Object reference (TYPE REF TO) CL_ABAP_REGEX Regular Expressions 20091208
7 REGEX_REF_VALUE Static Attribute Private Object reference (TYPE REF TO) CL_ABAP_REGEX Regular Expressions 20091208
8 REGEX_STRING_OR_REF_KEY Static Attribute Private Object reference (TYPE REF TO) CL_ABAP_REGEX Regular Expressions 20091208
9 REGEX_STRING_VALUE Static Attribute Private Object reference (TYPE REF TO) CL_ABAP_REGEX Regular Expressions 20091208
Methods
# Method Level Visibility Method type Description Created on
1 CLEAR_KEYS Instance method Public Method Deletes all keys 20080828
2 COMPARE_KEYS Instance method Private Method Compares all key elements 20081211
3 CREATE_FROM_REFSTRING Static method Public Method Creates a reference from its string representation 20080716
4 EQUALS_PARTLY Instance method Public Method Partial comparison with another CIM reference 20081211
5 GET_CLASS_REFERENCE Instance method Public Method Gets the corresponding class reference 20091029
6 GET_KEY Instance method Public Method Gets a key, if it exists 20081205
7 GET_NORMALIZED Instance method Public Method 20081217
8 HAS_FULL_PATH Instance method Public Method Fully qualified path (with host and namespace)? 20080930
9 HAS_LOCAL_PATH Instance method Public Method Local path (no host, but with namespace)? 20080930
10 HAS_NAME_ONLY Instance method Public Method Checks whether the reference contains only one CIM obj. name 20081215
11 IS_ASSOCIATION_INSTANCE Instance method Public Method True if it is an association reference 20081219
12 IS_CLASS Instance method Public Method True if it is a class reference 20080716
13 IS_INSTANCE Instance method Public Method True if it is an instance reference 20080716
14 IS_NAMESPACE Instance method Public Method True if it is a namespace reference 20080716
15 IS_SINGLETON_INSTANCE Instance method Public Method True if it is a singleton reference 20081219
16 IS_SINGLETON_KEY Static method Public Method Is it a singleton key? 20091021
17 KEYS_ARE_EQUAL Instance method Private Method Compares two key elements 20091022
18 NEW_NAMESPACEREF Static method Public Method Creates a reference to a CIM namespace 20080716
19 NEW_OBJECTREF Static method Public Method Creates a reference to a CIM class/instance 20090514
20 PARSE_NAMESPACEPATH Instance method Private Method Analyzes a namespace path string 20080716
21 PARSE_OBJECTNAME Instance method Private Method Analyzes an object name string 20080716
22 REMOVE_KEY Instance method Public Method Removes a key, if it exists 20080828
23 SET_CLASSNAME Instance method Public Method Sets or overwrites the class name 20090514
24 SET_HOST Instance method Public Method Sets or overwrites the host name 20081211
25 SET_KEY Instance method Public Method Sets key (generic); overwrites existing key 20080716
26 SET_KEY_PROPERTY Instance method Public Method Sets property key; overwrites existing key 20091021
27 SET_KEY_REFERENCE Instance method Public Method Sets reference key; overwrite existing key 20091021
28 SET_KEY_SINGLETON Instance method Public Method Sets the singleton key 20091021
29 SET_NAMESPACE Instance method Public Method Sets or overwrites the namespace 20081211
30 SET_REFERENCE Instance method Public Method Sets the value of a key reference 20090216
31 SET_VALUE Instance method Public Method Sets the value of a key element 20090216
32 SHM_RETRIEVE Instance method Public Method Copies the object components from the shared memory 20091119
33 TO_STRING Instance method Public Method Gets the string representation of the CIM reference 20080718
Events
Class CL_CIM_REFERENCE has no event.
Types
Class CL_CIM_REFERENCE has no local type.
Method Signatures

Method CLEAR_KEYS Signature

Method CLEAR_KEYS on class CL_CIM_REFERENCE has no parameter.
Method CLEAR_KEYS on class CL_CIM_REFERENCE has no exception.

Method COMPARE_KEYS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing APPLY_RECURSIVELY Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20081211
2 Returning BOOL Value transfer Type reference (TYPE) ABAP_BOOL Wahr oder falsch 20081211
3 Importing COMPARE_CLASSNAME Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20081211
4 Importing COMPARE_HOST Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20081211
5 Importing COMPARE_KEYS Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20081211
6 Importing COMPARE_NAMESPACE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20081211
7 Importing OTHER_REF Call by reference Object reference (TYPE REF TO) CL_CIM_REFERENCE Referenz auf CIM-Namespace, -Klasse oder -Instanz 20081211

Method COMPARE_KEYS on class CL_CIM_REFERENCE has no exception.

Method CREATE_FROM_REFSTRING Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning CIMREF Value transfer Object reference (TYPE REF TO) CL_CIM_REFERENCE Referenz auf CIM-Namespace, -Klasse oder -Instanz 20081111
2 Importing REFSTRING Call by reference Type reference (TYPE) STRING Stringdarstellung der CIM-Referenz 20080716
# Exception Resumable Description Created on
1 CX_WBEM_EXCEPTION Ausnahme, falls der String keine gültige Referenz darstellt 20080716

Method EQUALS_PARTLY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing APPLY_RECURSIVELY Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Vergleichsfilter rekursiv anwenden? 20081211
2 Returning BOOL Value transfer Type reference (TYPE) ABAP_BOOL Wahr oder falsch 20081211
3 Importing COMPARE_CLASSNAME Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE Klassennamen in Vergleich einschließen? 20081211
4 Importing COMPARE_HOST Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE Host in Vergleich einschließen? 20081211
5 Importing COMPARE_KEYS Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE Schlüssel in Vergleich einschließen? 20081211
6 Importing COMPARE_NAMESPACE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE Namespace in Vergleich einschließen? 20081211
7 Importing OTHER_REF Call by reference Object reference (TYPE REF TO) CL_CIM_REFERENCE Referenz auf CIM-Namespace, -Klasse oder -Instanz 20081211

Method EQUALS_PARTLY on class CL_CIM_REFERENCE has no exception.

Method GET_CLASS_REFERENCE 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_CIM_REFERENCE Referenz auf CIM-Klasse 20091029

Method GET_CLASS_REFERENCE on class CL_CIM_REFERENCE has no exception.

Method GET_KEY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning KEY Value transfer Type reference (TYPE) CIM_S_KEY Schlüsselelement einer CIM-Reference 20081205
2 Importing NAME Call by reference Object reference (TYPE REF TO) CL_CIM_ELEMENTNAME Name des Schlüssels 20091021

Method GET_KEY on class CL_CIM_REFERENCE has no exception.

Method GET_NORMALIZED Signature

Method GET_NORMALIZED on class CL_CIM_REFERENCE has no parameter.
Method GET_NORMALIZED on class CL_CIM_REFERENCE has no exception.

Method HAS_FULL_PATH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning BOOL Value transfer Type reference (TYPE) ABAP_BOOL Wahr oder falsch 20080930

Method HAS_FULL_PATH on class CL_CIM_REFERENCE has no exception.

Method HAS_LOCAL_PATH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning BOOL Value transfer Type reference (TYPE) ABAP_BOOL Wahr oder falsch 20080930

Method HAS_LOCAL_PATH on class CL_CIM_REFERENCE has no exception.

Method HAS_NAME_ONLY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning BOOL Value transfer Type reference (TYPE) ABAP_BOOL Wahr, falls kein Namespace adressiert ist 20081215
2 Importing RECURSIVE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Rekursives Prüfen enthaltener CIM-Referenzen? 20081215

Method HAS_NAME_ONLY on class CL_CIM_REFERENCE has no exception.

Method IS_ASSOCIATION_INSTANCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning BOOL Value transfer Type reference (TYPE) ABAP_BOOL Wahr oder falsch 20081219

Method IS_ASSOCIATION_INSTANCE on class CL_CIM_REFERENCE has no exception.

Method IS_CLASS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning BOOL Value transfer Type reference (TYPE) ABAP_BOOL Wahr oder falsch 20080716

Method IS_CLASS on class CL_CIM_REFERENCE has no exception.

Method IS_INSTANCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning BOOL Value transfer Type reference (TYPE) ABAP_BOOL Wahr oder falsch 20080716

Method IS_INSTANCE on class CL_CIM_REFERENCE has no exception.

Method IS_NAMESPACE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning BOOL Value transfer Type reference (TYPE) ABAP_BOOL Wahr oder falsch 20080716

Method IS_NAMESPACE on class CL_CIM_REFERENCE has no exception.

Method IS_SINGLETON_INSTANCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning BOOL Value transfer Type reference (TYPE) ABAP_BOOL Wahr oder falsch 20081219

Method IS_SINGLETON_INSTANCE on class CL_CIM_REFERENCE has no exception.

Method IS_SINGLETON_KEY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing KEY Call by reference Type reference (TYPE) CIM_S_KEY CIM-Key-Struktur (für CIM Referenzen) 20091021
2 Returning RESULT Value transfer Type reference (TYPE) ABAP_BOOL 20091021

Method IS_SINGLETON_KEY on class CL_CIM_REFERENCE has no exception.

Method KEYS_ARE_EQUAL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing APPLY_RECURSIVELY Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20091022
2 Returning BOOL Value transfer Type reference (TYPE) ABAP_BOOL 20091022
3 Importing COMPARE_CLASSNAME Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20091022
4 Importing COMPARE_HOST Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20091022
5 Importing COMPARE_KEYS Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20091022
6 Importing COMPARE_NAMESPACE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20091022
7 Importing OTHER_KEY Call by reference Type reference (TYPE) CIM_S_KEY 20091022
8 Importing THIS_KEY Call by reference Type reference (TYPE) CIM_S_KEY 20091022

Method KEYS_ARE_EQUAL on class CL_CIM_REFERENCE has no exception.

Method NEW_NAMESPACEREF Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning CIMREF Value transfer Object reference (TYPE REF TO) CL_CIM_REFERENCE Referenz auf CIM-Namespace 20081111
2 Importing HOST Call by reference Object reference (TYPE REF TO) CL_CIM_ELEMENTNAME Hostname 20080716
3 Importing NAMESPACE Call by reference Object reference (TYPE REF TO) CL_CIM_NAMESPACE Name eines CIM-Namespace 20080716

Method NEW_NAMESPACEREF on class CL_CIM_REFERENCE has no exception.

Method NEW_OBJECTREF Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning CIMREF Value transfer Object reference (TYPE REF TO) CL_CIM_REFERENCE Referenz auf CIM-Namespace 20090514
2 Importing CLASSNAME Call by reference Object reference (TYPE REF TO) CL_CIM_ELEMENTNAME CIM-Klassenname 20090514
3 Importing HOST Call by reference Object reference (TYPE REF TO) CL_CIM_ELEMENTNAME Hostname 20090514
4 Importing NAMESPACE Call by reference Object reference (TYPE REF TO) CL_CIM_NAMESPACE Name eines CIM-Namespace 20090514

Method NEW_OBJECTREF on class CL_CIM_REFERENCE has no exception.

Method PARSE_NAMESPACEPATH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing NAMESPACEPATH Call by reference Type reference (TYPE) STRING 20080716
2 Returning SUCCESS Value transfer Type reference (TYPE) ABAP_BOOL Fehlerfrei beendet? 20080716

Method PARSE_NAMESPACEPATH on class CL_CIM_REFERENCE has no exception.

Method PARSE_OBJECTNAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing OBJECTNAME Call by reference Type reference (TYPE) STRING 20080716
# Exception Resumable Description Created on
1 CX_WBEM_EXCEPTION Ausnahme der WBEM-Programmierschnittstelle 20091105

Method REMOVE_KEY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning KEY Value transfer Type reference (TYPE) CIM_S_KEY Entferntes Schlüsselobjekt oder Nullreferenz 20080828
2 Importing NAME Call by reference Object reference (TYPE REF TO) CL_CIM_ELEMENTNAME Elementname (case-insensitive) 20080828

Method REMOVE_KEY on class CL_CIM_REFERENCE has no exception.

Method SET_CLASSNAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CLASSNAME Call by reference Object reference (TYPE REF TO) CL_CIM_ELEMENTNAME Elementname (case-insensitive) 20090514

Method SET_CLASSNAME on class CL_CIM_REFERENCE has no exception.

Method SET_HOST Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing HOST Call by reference Object reference (TYPE REF TO) CL_CIM_ELEMENTNAME Elementname (case-insensitive) 20081211

Method SET_HOST on class CL_CIM_REFERENCE has no exception.

Method SET_KEY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing KEY Call by reference Type reference (TYPE) CIM_S_KEY Schlüsselelement einer CIM-Reference 20080716

Method SET_KEY on class CL_CIM_REFERENCE has no exception.

Method SET_KEY_PROPERTY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing KEYTYPE Call by reference Object reference (TYPE REF TO) CL_CIM_KEYTYPE CIM-Schlüssel-Datentyp (Typesafe Enumeration) 20091021
2 Importing NAME Call by reference Object reference (TYPE REF TO) CL_CIM_ELEMENTNAME Elementname (case-insensitive) 20091021
3 Importing VALUE Call by reference Type reference (TYPE) STRING 20091021

Method SET_KEY_PROPERTY on class CL_CIM_REFERENCE has no exception.

Method SET_KEY_REFERENCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing NAME Call by reference Object reference (TYPE REF TO) CL_CIM_ELEMENTNAME Elementname (case-insensitive) 20091021
2 Importing REFERENCE Call by reference Object reference (TYPE REF TO) CL_CIM_REFERENCE Referenz auf CIM-Namespace, -Klasse oder -Instanz 20091021

Method SET_KEY_REFERENCE on class CL_CIM_REFERENCE has no exception.

Method SET_KEY_SINGLETON Signature

Method SET_KEY_SINGLETON on class CL_CIM_REFERENCE has no parameter.
Method SET_KEY_SINGLETON on class CL_CIM_REFERENCE has no exception.

Method SET_NAMESPACE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing NAMESPACE Call by reference Object reference (TYPE REF TO) CL_CIM_NAMESPACE Name eines CIM-Namespace 20081211

Method SET_NAMESPACE on class CL_CIM_REFERENCE has no exception.

Method SET_REFERENCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CIMREF Call by reference Object reference (TYPE REF TO) CL_CIM_REFERENCE CIM-Referenz 20090216
2 Importing NAME Call by reference Object reference (TYPE REF TO) CL_CIM_ELEMENTNAME Name des Schlüsselelements 20090216

Method SET_REFERENCE on class CL_CIM_REFERENCE has no exception.

Method SET_VALUE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing NAME Call by reference Object reference (TYPE REF TO) CL_CIM_ELEMENTNAME Name des Schlüsselelements 20090216
2 Importing VALUE Call by reference Type reference (TYPE) STRING Wert 20090216

Method SET_VALUE on class CL_CIM_REFERENCE has no exception.

Method SHM_RETRIEVE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning CIMREF Value transfer Object reference (TYPE REF TO) CL_CIM_REFERENCE Referenz auf CIM-Namespace, -Klasse oder -Instanz 20091119

Method SHM_RETRIEVE on class CL_CIM_REFERENCE has no exception.

Method TO_STRING Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing COMPARABLE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Normalisierte vergleichbare Form? 20080828
2 Importing INCLUDE_HOST Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE Einschließlich Host? 20080828
3 Importing INCLUDE_NAMESPACE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE Einschließlich Namespace? 20080828
4 Returning REFSTRING Value transfer Type reference (TYPE) STRING Stringdarstellung 20080718

Method TO_STRING on class CL_CIM_REFERENCE has no exception.
History
Last changed by/on SAP  20110908 
SAP Release Created in 712