SAP ABAP Class CL_ISHMED_DWS_FRAMEWORK_API (i.s.h.med DWS: Documentation Work Station API)
Hierarchy
☛
IS-H (Software Component) SAP Healthcare
⤷
IS-H (Application Component) SAP Healthcare - Industry-Specific Components for Hospitals
⤷
NMED_DWS (Package) IS-H: Documentation Work Station Framework
⤷
⤷
Properties
| Class | CL_ISHMED_DWS_FRAMEWORK_API | |
| Short Description | i.s.h.med DWS: Documentation Work Station API | |
| Super Class | ||
| Instantiability of a Class | 0 | Private |
| Final |
General Data
| Message Class | N2DWS | |
| Program status | T | Test Program |
| Category | 0 | |
| Package | NMED_DWS | IS-H: Documentation Work Station Framework |
| Created | 20030619 | SAP |
| Last change | 20050615 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_ISHMED_DWS_FRAMEWORK_API has no interface implemented.
Friends
Class CL_ISHMED_DWS_FRAMEWORK_API has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Private | Object reference (TYPE REF TO) | CL_ISHMED_DWS_MANAGER | Main Controller | 20040816 | |||
| 2 | Static Attribute | Private | Object reference (TYPE REF TO) | CL_ISHMED_DWS_FRAMEWORK_API | Service API Singleton | 20040611 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | Calls Work Station Instance | 20040923 | |
| 2 | Instance method | Public | Constructor | Creates New Work Station Instance and its API Object | 20030619 | |
| 3 | Instance method | Public | Method | Creates a Work Station Context | 20041011 | |
| 4 | Instance method | Public | Method | Deregister DWS Object | 20030619 | |
| 5 | Instance method | Public | Method | Send Message | 20030619 | |
| 6 | Static method | Public | Method | Exit Service, Release Resources of Work Station Instance | 20040818 | |
| 7 | Instance method | Public | Method | Returns Associated Broker | 20040910 | |
| 8 | Static method | Private | Method | Creates Configuration Object from Work Station Variant | 20040923 | |
| 9 | Instance method | Public | Method | Returns Special Work Station Instance | 20040907 | |
| 10 | Instance method | Public | Method | Determine Work Station Context | 20041011 | |
| 11 | Instance method | Public | Method | Returns Work Station Controller | 20040910 | |
| 12 | Static method | Public | Method | Returns or Creates DWS Service API (This Singleton) | 20040610 | |
| 13 | Instance method | Public | Method | Returns Associated Layout Manager | 20040907 | |
| 14 | Instance method | Public | Method | Initialization Routine for DWS Instance | 20040915 | |
| 15 | Instance method | Public | Method | Starts Processing Process of Work Station Dialog | 20040818 | |
| 16 | Instance method | Public | Method | Saves Properties of Work Station Layout | 20040909 | |
| 17 | Instance method | Public | Method | Set Work Station Context | 20041011 | |
| 18 | Instance method | Public | Method | Sets Layout Properties of Work Station | 20040818 |
Events
Class CL_ISHMED_DWS_FRAMEWORK_API has no event.
Types
Class CL_ISHMED_DWS_FRAMEWORK_API has no local type.
Method Signatures
Method CALL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DWS_CONTEXT | Call by reference | Object reference (TYPE REF TO) | CL_ISHMED_DWS_CONTEXT | IS-H*MED DWS: Arbeitsplatz-Kontext | 20041011 | |||
| 2 | DWS_ID | Call by reference | Type reference (TYPE) | N2DWS_BUSINESSKEY | Arbeitsplatz-Id | 20040923 | |||
| 3 | DWS_PARAMETERS | Call by reference | Object reference (TYPE REF TO) | CL_ISHMED_ANY_CONTAINER | DWS Parameter | 20050227 | |||
| 4 | SERVICE | Value transfer | Object reference (TYPE REF TO) | CL_ISHMED_DWS_FRAMEWORK_API | IS-H*MED DWS: API Dokumentationsarbeitsplatz | 20040923 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | IS-H*MED DWS: Allgemeine Fehlerklasse | 20040923 |
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DWS_CONTEXT | Call by reference | Object reference (TYPE REF TO) | CL_ISHMED_DWS_CONTEXT | IS-H*MED DWS: Arbeitsplatz-Kontext | 20041011 | |||
| 2 | DWS_ID | Call by reference | Type reference (TYPE) | N2DWS_BUSINESSKEY | Arbeitsplatzschlüssel | 20041206 | |||
| 3 | DWS_PARAMETERS | Call by reference | Object reference (TYPE REF TO) | CL_ISHMED_ANY_CONTAINER | DWS Parameter | 20050227 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20040903 |
Method CREATE_DWS_CONTEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CASE | Call by reference | Type reference (TYPE) | FALNR | IS-H: Fallnummer | 20041011 | |||
| 2 | DWS_CONTEXT | Value transfer | Object reference (TYPE REF TO) | CL_ISHMED_DWS_CONTEXT | IS-H*MED DWS: Arbeitsplatz-Kontext | 20041011 | |||
| 3 | INSTITUTION | Call by reference | Type reference (TYPE) | EINRI | IS-H: Einrichtung | 20041011 | |||
| 4 | MOVEMENT | Call by reference | Type reference (TYPE) | LFDBEW | IS-H: Bewegung | 20041011 | |||
| 5 | PATIENT | Call by reference | Type reference (TYPE) | PATNR | IS-H: Patientennummer | 20041011 | |||
| 6 | SERVICE | Call by reference | Type reference (TYPE) | LNRLS | IS-H: Laufende Nummer der Leistung | 20041011 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | IS-H*MED DWS: Allgemeine Fehlerklasse | 20041011 |
Method DEREGISTER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DWS_OBJECT | Call by reference | Object reference (TYPE REF TO) | IF_ISHMED_DWS_OBJECTTYPE | IS-H*MED DWS: IF Dokumentationsobjekttyp | 20030619 |
Method DEREGISTER on class CL_ISHMED_DWS_FRAMEWORK_API has no exception.
Method DISPATCH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PARAMETERS | Call by reference | Type reference (TYPE) | ABAP_PARMBIND_TAB | Parameterbindung | 20030619 | |||
| 2 | PORT | Call by reference | Object reference (TYPE REF TO) | OBJECT | IS-H*MED DWS: Dokumentationsobjekttyp | 20030619 | |||
| 3 | SERVICE | Call by reference | Type reference (TYPE) | C | DWS Objecttype Service | 20030619 |
Method DISPATCH on class CL_ISHMED_DWS_FRAMEWORK_API has no exception.
Method FINALIZE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | SERVICE | Call by reference | Object reference (TYPE REF TO) | CL_ISHMED_DWS_FRAMEWORK_API | IS-H*MED DWS: API Dokumentationsarbeitsplatz | 20040818 |
Method FINALIZE on class CL_ISHMED_DWS_FRAMEWORK_API has no exception.
Method GET_BROKER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | BROKER | Value transfer | Object reference (TYPE REF TO) | CL_ISHMED_DWS_BROKER | IS-H*MED DWS: Broker | 20040910 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | DWS Manager ist nicht instanziiert. | 20050226 |
Method GET_CONFIGURATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CONFIGURATION | Value transfer | Object reference (TYPE REF TO) | CL_ISHMED_DWS_CONFIGURATION | IS-H*MED DWS: Arbeitsplatz-Konfiguration | 20040923 | |||
| 2 | DWS_ID | Call by reference | Type reference (TYPE) | N2DWS_BUSINESSKEY | Arbeitsplatzschlüssel | 20041206 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | IS-H*MED DWS: Allgemeine Fehlerklasse | 20040923 |
Method GET_DWS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DWS | Value transfer | Object reference (TYPE REF TO) | CL_ISHMED_DWS | IS-H*MED DWS: Generische Vorlage einer Arbeitsplatzinstanz | 20040907 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Arbeitsplatzinstanz ist initial | 20050226 |
Method GET_DWS_CONTEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DWS_CONTEXT | Value transfer | Object reference (TYPE REF TO) | CL_ISHMED_DWS_CONTEXT | IS-H*MED DWS: Arbeitsplatz-Kontext | 20041011 |
Method GET_DWS_CONTEXT on class CL_ISHMED_DWS_FRAMEWORK_API has no exception.
Method GET_DWS_CONTROLLER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CONTROLLER | Value transfer | Object reference (TYPE REF TO) | CL_ISHMED_DWS_MANAGER | IS-H*MED DWS: Arbeitsplatz-Controller-Klasse | 20040910 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20050226 |
Method GET_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DWS_CONTEXT | Call by reference | Object reference (TYPE REF TO) | CL_ISHMED_DWS_CONTEXT | IS-H*MED DWS: Arbeitsplatz-Kontext | 20050112 | |||
| 2 | DWS_ID | Call by reference | Type reference (TYPE) | N2DWS_BUSINESSKEY | Arbeitsplatzschlüssel | 20041206 | |||
| 3 | DWS_PARAMETERS | Call by reference | Object reference (TYPE REF TO) | CL_ISHMED_ANY_CONTAINER | DWS Parameter | 20050227 | |||
| 4 | ENFORCE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | True - erzeugt ggf Referenz (siehe Doku) | 20050527 | ||
| 5 | SERVICE | Value transfer | Object reference (TYPE REF TO) | CL_ISHMED_DWS_FRAMEWORK_API | Service API Objekt | 20040610 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20040903 |
Method GET_LAYOUTMAN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | LAYOUTMAN | Value transfer | Object reference (TYPE REF TO) | CL_ISHMED_DWS_LAYOUTMANAGER | IS-H*MED DWS: Layoutmanager | 20040907 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Layoutmananger ist nicht instanziiert. | 20050226 |
Method INITIALIZE Signature
Method INITIALIZE on class CL_ISHMED_DWS_FRAMEWORK_API has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | IS-H*MED DWS: Allgemeine Fehlerklasse | 20050111 |
Method RUN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PROCESS_ID | Call by reference | Type reference (TYPE) | CSEQUENCE | (Funktionsbausteinname) | 20040824 | |||
| 2 | RC | Value transfer | Type reference (TYPE) | ISH_METHOD_RC | Rückkehrcode der Eingabeverarbeitung | 20040824 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | IS-H*MED DWS: Allgemeine Fehlerklasse | 20040818 |
Method SAVE_LAYOUT Signature
Method SAVE_LAYOUT on class CL_ISHMED_DWS_FRAMEWORK_API has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | IS-H*MED DWS: Allgemeine Fehlerklasse | 20040909 |
Method SET_DWS_CONTEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DWS_CONTEXT | Call by reference | Object reference (TYPE REF TO) | CL_ISHMED_DWS_CONTEXT | IS-H*MED DWS: Arbeitsplatz-Kontext | 20041011 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | IS-H*MED DWS: Allgemeine Fehlerklasse | 20050103 |
Method SET_LAYOUT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | LAYOUT_NAME | Call by reference | Type reference (TYPE) | STRING | 'LAYOUT_DEFAULT' | Layoutname | 20040818 |
Method SET_LAYOUT on class CL_ISHMED_DWS_FRAMEWORK_API has no exception.
History
| Last changed by/on | SAP | 20050615 |
| SAP Release Created in | 472 |