SAP ABAP Class XO_ENUMERATOR (Enumerator Class for Constant Interfaces)
Hierarchy
☛ SAP_ABA (Software Component) Cross-Application Component
   ⤷ FS-BP (Application Component) Business Partner
     ⤷ XO_MAIN (Package) Central XO Components
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  IF_XO_CONST_BOOLE Constants: Boolean Values 20070218
2 Interface implementation (CLASS c. INTERFACES i_ref)  IF_XO_CONST_DIRECTIONS Constants: Directions 20070218
Properties
Class XO_ENUMERATOR  
Short Description Enumerator Class for Constant Interfaces    
Super Class    
Instantiability of a Class 0  Private 
Final    
General Data
Message Class    
Program status     
Category 0   
Package XO_MAIN   Central XO Components 
Created 20070217   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_XO_CONST_DIRECTIONS Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
Interfaces
# Interface Abstract Final Description Created on
1 IF_XO_CONST_BOOLE Constants: Boolean Values 20070218
2 IF_XO_CONST_DIRECTIONS Constants: Directions 20070218
Friends
# Friend Modeled only Created on Description
1 XO_UNITTEST_HELPER 20110505 Help Methods for Testing XO Framework
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 ALL_CONSTANTS Static Attribute Private Type reference (TYPE) STY_XO_CONSTANTS_BUFFER Generic Data Table for Dynamic Data References (Sorted) 20070218
2 BACKWARD Instance attribute Private Attribute reference (LIKE) 20070218
3 COUNTER Instance attribute Private Type reference (TYPE) I 0 Counter 20070218
4 DIRECTION Instance attribute Private Type reference (TYPE) XO_DIRECTION IF_XO_CONST_DIRECTIONS=>FORWARD Direction 20070218
5 FALSE Instance attribute Private Attribute reference (LIKE) 20070218
6 FORWARD Instance attribute Private Attribute reference (LIKE) 20070218
7 MAX_COUNT Instance attribute Private Type reference (TYPE) I -1 Total Number of Constants 20070218
8 MY_CONSTANTS Instance attribute Private Object reference (TYPE REF TO) STY_XO_CONSTANT_LIST Constant List (Sorted) 20070218
9 MY_NAME Instance attribute Private Type reference (TYPE) XO_OBJECT_CLASS_NAME Name of Constant Interface 20070218
10 TRUE Instance attribute Private Attribute reference (LIKE) 20070218
Methods
# Method Level Visibility Method type Description Created on
1 CONSTRUCTOR Instance method Public Constructor CONSTRUCTOR 20070217
2 GET_COUNTER Instance method Public Method Returns the Current Counter Reading 20070218
3 GET_CURRENT Instance method Public Method Returns the Current Constant Name 20070510
4 GET_DIRECTION Instance method Public Method Returns the Counter Direction 20070218
5 GET_INSTANCE Static method Public Method Factory Method: Returns an Instance of the Class 20070217
6 GET_LIST Instance method Public Method Returns the List of Constants 20070218
7 GET_MY_NAME Instance method Public Method Returns the Name of the Interface 20070219
8 GET_NAME Instance method Public Method Returns One Constant Name 20070218
9 GET_NAME_BY_VALUE Instance method Public Method Returns the Constant Name for a Value 20070510
10 GET_NEXT Instance method Public Method Returns the Next Constant Name in the Program Run 20070218
11 GET_NUMBER_OF_VALUES Instance method Public Method Returns the Number of Constants 20070218
12 GET_POSITION Instance method Public Method Indicates the Position at Which the Constants Occur 20070218
13 GET_PREVIOUS Instance method Public Method Returns the Previous Constants in the Program Run 20070218
14 GET_VALUE_BY_NAME Instance method Public Method Returns the Value for a Constant Name 20070510
15 IS_FIRST_ENTRY_REACHED Instance method Public Method Indicates Whether the First Entry in Program Run Was Reached 20070218
16 IS_LAST_ENTRY_REACHED Instance method Public Method Indicates Whether the Last Entry of Program Run Was Reached 20070218
17 NEW_RUN Instance method Public Method Resets the Counter Reading to the Start or End 20070218
Events
Class XO_ENUMERATOR has no event.
Types
Class XO_ENUMERATOR has no local type.
Method Signatures

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_INTERFACE_NAME Call by reference Type reference (TYPE) XO_OBJECT_CLASS_NAME Interfacename 20070217
2 Importing I_VALUE_LIST_REF Call by reference Object reference (TYPE REF TO) STY_XO_CONSTANT_LIST Konstantenliste (sortiert) 20070218

Method CONSTRUCTOR on class XO_ENUMERATOR has no exception.

Method GET_COUNTER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_COUNTER Value transfer Type reference (TYPE) I Zählerstand 20070218

Method GET_COUNTER on class XO_ENUMERATOR has no exception.

Method GET_CURRENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_CURRENT_CONSTANT Value transfer Type reference (TYPE) XO_OBJECT_NAME Objektname 20070510
# Exception Resumable Description Created on
1 CX_XO_ILLEGAL_OPERATION Ausnahme: Ausführung nicht erlaubt 20070510

Method GET_DIRECTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_DIRECTION Value transfer Type reference (TYPE) XO_DIRECTION Richtung 20070218

Method GET_DIRECTION on class XO_ENUMERATOR has no exception.

Method GET_INSTANCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_INTERFACE_NAME Call by reference Type reference (TYPE) XO_OBJECT_CLASS_NAME Name des Interface 20070217
2 Returning R_REFERENCE Value transfer Object reference (TYPE REF TO) XO_ENUMERATOR Enumeratorklasse für Konstanten-Interfaces 20070217
# Exception Resumable Description Created on
1 CX_XO_ILLEGAL_OPERATION Ausnahme: Ausführung nicht erlaubt 20070217

Method GET_LIST Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting E_LIST Call by reference Type reference (TYPE) TTY_XO_CONSTANT_LIST Konstantenliste 20070218
2 Exporting E_SORTED_LIST Call by reference Type reference (TYPE) STY_XO_CONSTANT_LIST Konstantenliste (sortiert) 20070218

Method GET_LIST on class XO_ENUMERATOR has no exception.

Method GET_MY_NAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_NAME Value transfer Type reference (TYPE) XO_OBJECT_CLASS_NAME Klassenname 20070219

Method GET_MY_NAME on class XO_ENUMERATOR has no exception.

Method GET_NAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_POSITION Call by reference Type reference (TYPE) I Position 20070218
2 Returning R_NAME Value transfer Type reference (TYPE) XO_OBJECT_NAME Objektname 20070218
# Exception Resumable Description Created on
1 CX_XO_INVALID_PARAMETER Ausnahme: Übergabewerte fehlerhaft 20070218

Method GET_NAME_BY_VALUE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_VALUE Call by reference Type reference (TYPE) ANY Konstantenwert 20070510
2 Returning R_NAME Value transfer Type reference (TYPE) XO_OBJECT_NAME Objektname 20070510

Method GET_NAME_BY_VALUE on class XO_ENUMERATOR has no exception.

Method GET_NEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_NEXT_CONSTANT Value transfer Type reference (TYPE) XO_OBJECT_NAME Objektname 20070218
# Exception Resumable Description Created on
1 CX_XO_ILLEGAL_OPERATION Ausnahme: Ausführung nicht erlaubt 20070218

Method GET_NUMBER_OF_VALUES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_NUMBER_OF_VALUES Value transfer Type reference (TYPE) I Anzahl Konstanten 20070218

Method GET_NUMBER_OF_VALUES on class XO_ENUMERATOR has no exception.

Method GET_POSITION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_CONSTANT Call by reference Type reference (TYPE) XO_OBJECT_NAME Konstante 20070218
2 Returning R_POSITION Value transfer Type reference (TYPE) I Position 20070218
# Exception Resumable Description Created on
1 CX_XO_INVALID_PARAMETER Ausnahme: Übergabewerte fehlerhaft 20070218

Method GET_PREVIOUS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_PREVIOUS_CONSTANT Value transfer Type reference (TYPE) XO_OBJECT_NAME Vorherige Konstante 20070218
# Exception Resumable Description Created on
1 CX_XO_ILLEGAL_OPERATION Ausnahme: Ausführung nicht erlaubt 20070218

Method GET_VALUE_BY_NAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_NAME Call by reference Type reference (TYPE) XO_OBJECT_NAME Objektname 20070510
2 Returning R_VALUE Value transfer Type reference (TYPE) SEOVALUE Konstantenwert 20070510

Method GET_VALUE_BY_NAME on class XO_ENUMERATOR has no exception.

Method IS_FIRST_ENTRY_REACHED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_RESULT Value transfer Type reference (TYPE) XO_BOOLE Boole'scher Wert ('X' = True ' ' = False) 20070218

Method IS_FIRST_ENTRY_REACHED on class XO_ENUMERATOR has no exception.

Method IS_LAST_ENTRY_REACHED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_RESULT Value transfer Type reference (TYPE) XO_BOOLE Boole'scher Wert ('X' = True ' ' = False) 20070218

Method IS_LAST_ENTRY_REACHED on class XO_ENUMERATOR has no exception.

Method NEW_RUN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_DIRECTION Call by reference Type reference (TYPE) XO_DIRECTION IF_XO_CONST_DIRECTIONS=>FORWARD Richtung 20070218

Method NEW_RUN on class XO_ENUMERATOR has no exception.
History
Last changed by/on SAP  20110908 
SAP Release Created in 710