SAP ABAP Class CL_SRM_GSP_HELPER (Help Class for Archiving Support)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SRV-RM (Application Component) SAP Records Management
⤷
SRM_GSP_ARCHIVE (Package) Archiving for Generic SP
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-SRV-RM (Application Component) SAP Records Management⤷
SRM_GSP_ARCHIVE (Package) Archiving for Generic SPProperties
| Class | CL_SRM_GSP_HELPER | |
| Short Description | Help Class for Archiving Support | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SRM_GSP_ARCHIVE | Archiving for Generic SP |
| Created | 20041014 | SAP |
| Last change | 20130531 | 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) |
| 2 | SRMGS |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_SRM_GSP_HELPER has no interface implemented.
Friends
Class CL_SRM_GSP_HELPER has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | C_ACT_CODE_ARCH_CREATE |
Constant | Public | Type reference (TYPE) | STRING | '24' | Cpde for Archiving | 20050201 | |
| 2 | C_ACT_CODE_ARCH_READ |
Constant | Public | Type reference (TYPE) | STRING | '03' | Code for Reading | 20050201 | |
| 3 | C_ACT_CODE_CREATE |
Constant | Public | Type reference (TYPE) | STRING | '01' | Code for Creating | 20041126 | |
| 4 | C_ACT_CODE_DELETE |
Constant | Public | Type reference (TYPE) | STRING | '06' | Code for Deleting | 20041126 | |
| 5 | C_ACT_CODE_MODIFY |
Constant | Public | Type reference (TYPE) | STRING | '02' | Code for Changing | 20041126 | |
| 6 | C_ACT_CODE_SEARCH |
Constant | Public | Type reference (TYPE) | STRING | '30' | Code for Searching | 20041126 | |
| 7 | C_ACT_CODE_TRANSPORT |
Constant | Public | Type reference (TYPE) | STRING | '21' | Code for Transporting | 20041126 | |
| 8 | C_ACT_CODE_VIEW |
Constant | Public | Type reference (TYPE) | STRING | '03' | Code for Displaying | 20041126 | |
| 9 | C_AUTH_OBJ_ARCHIVE |
Constant | Public | Type reference (TYPE) | STRING | 'S_SRM_ARCH' | Authorization Object for Archiving Documents/Cases | 20050201 | |
| 10 | C_AUTH_OBJ_CONTENT |
Constant | Public | Type reference (TYPE) | STRING | 'S_SRMGS_CT' | Authorization Object for Content | 20041126 | |
| 11 | C_AUTH_OBJ_DOCUMENT |
Constant | Public | Type reference (TYPE) | STRING | 'S_SRMGS_DC' | Authorization Object for Documents | 20041126 | |
| 12 | C_AUTH_OBJ_PROP |
Constant | Public | Type reference (TYPE) | STRING | 'S_SRMGS_PR' | Authorization Object for Attributes | 20041126 | |
| 13 | C_AUTH_OBJ_VARIANT |
Constant | Public | Type reference (TYPE) | STRING | C_AUTH_OBJ_VERSION | Authorization Object for Variant | 20041126 | |
| 14 | C_AUTH_OBJ_VERSION |
Constant | Public | Type reference (TYPE) | STRING | 'S_SRMGS_VV' | Authorization Object for Version | 20041126 | |
| 15 | GOS_SUCCESS_MESSAGE |
Static Attribute | Private | Type reference (TYPE) | SRMBOOLEAN | Boolean: Possible Values IF_SRM=>TRUE / FALSE | 20120829 | ||
| 16 | G_MAX_HITS |
Constant | Private | Type reference (TYPE) | I | 1000000 | Maximum Number of Hits Returned by KPro Search | 20041014 | |
| 17 | MY_CLIENTSERVICE |
Static Attribute | Private | Object reference (TYPE REF TO) | IF_SRM_SRM_CLIENT_SERVICE | Interface for Client-Specific Service Functions | 20050117 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CHECK_ARCHIVE |
Static method | Public | Method | Checks whether data object has been stored in the archive | 20050713 |
| 2 | CHECK_ARCHIVE_AUTH |
Static method | Public | Method | Archiving Authorization Check (S_SRM_ARCH) | 20050201 |
| 3 | CHECK_AUTHORIZATION |
Static method | Public | Method | Authority Checks | 20041126 |
| 4 | CHECK_CONTENT_LOCATION |
Static method | Public | Method | Checks, Repository Category of the PHIOs of a LOIOS | 20050113 |
| 5 | CONVERT_PROPERTY_NAMES |
Static method | Private | Method | Converts Property Names | 20041014 |
| 6 | DOWNLOAD_ARCHIVED_CONTENT |
Static method | Public | Method | Download Archived Content to Local File | 20050713 |
| 7 | FETCH_LOIO_PROPERTIES |
Static method | Private | Method | Reads Attribute Values from KPro | 20041209 |
| 8 | FETCH_PHIO_PROPERTIES |
Static method | Private | Method | Reads Attribute Values from KPro | 20041209 |
| 9 | GET_ARCHIVING_STATUS |
Static method | Public | Method | Archiving Flag Queries in the POID Directory | 20050128 |
| 10 | GET_CLIENT_SERVICE |
Static method | Public | Method | Gets Reference to Client Service | 20050117 |
| 11 | GET_DOCUMENT_URL |
Static method | Public | Method | Gets a URL for Access to PHIO | 20041206 |
| 12 | GET_FILE_EXTENSION |
Static method | Public | Method | Gets the File Extension for a Specified MIME Type | 20041206 |
| 13 | GET_GOS_SUCCESS |
Static method | Public | Method | Get GOS success status | 20120829 |
| 14 | GET_INSTANCE_POID |
Static method | Public | Method | Gets Instance POID of a Document | 20050117 |
| 15 | GET_NAVIGATION_COUNT |
Static method | Public | Method | Gets the File Count to be displayed in DTB RM | 20090428 |
| 16 | GET_PHIOS_OF_DOCUMENT |
Static method | Public | Method | Gets All PHIOs for a Document | 20041207 |
| 17 | GET_PROPERTIES |
Static method | Public | Method | Reads Attribute Values (LOIO or POID) | 20041209 |
| 18 | GET_PROPERTY_TYPES |
Static method | Public | Method | Gets List of Property Types (PHIO/LOIO) | 20041014 |
| 19 | GET_RMS_ID_BY_LOIO_ID |
Static method | Public | Method | Gets the RMS ID for the Specified LOIO ID | 20041213 |
| 20 | GET_SPPOID_BY_POID |
Static method | Public | Method | Get SP POID from POID | 20120731 |
| 21 | GET_SPS_ID_BY_LOIO_ID |
Static method | Public | Method | Gets the Element Type ID for the Specified LOIO ID | 20041210 |
| 22 | GET_TEMP_DIRECTORY |
Static method | Public | Method | Determines Temporary Directory for Storing Data | 20041117 |
| 23 | GET_URL_FOR_GET |
Static method | Public | Method | Generate a URL for the Get Operation | 20050713 |
| 24 | IS_DOCUMENT_ARCHIVED |
Static method | Public | Method | Checks if a given document has been archived | 20050713 |
| 25 | IS_RECORD |
Static method | Public | Method | Is the document with the specified element type ID a record? | 20041203 |
| 26 | KPRO_QUERY_DATE_CONVERSION |
Static method | Private | Method | Converts Dates into KPro-Compliant Format | 20041014 |
| 27 | READ_DOCUMENT_FROM_ARCHIVE |
Static method | Public | Method | Importing an Archived Document into Internal Tables | 20050131 |
| 28 | SEARCH_MATCHING_DOCUMENTS |
Static method | Public | Method | Searches for documents that match the specified criteria | 20041014 |
| 29 | SET_GOS_SUCCESS |
Static method | Public | Method | Set GOS success status | 20120829 |
Events
Class CL_SRM_GSP_HELPER has no event.
Types
Class CL_SRM_GSP_HELPER has no local type.
Method Signatures
Method CHECK_ARCHIVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IS_DATASELECTION | Call by reference | Type reference (TYPE) | DATA | 20050713 | |||
| 2 | Importing |
IV_FIELDCAT | Value transfer | Type reference (TYPE) | AIND_FCAT | Feldkatalog der Archivtest unterstützt | 20050713 | ||
| 3 |  Returning |
RE_CHECK_RESULT | Value transfer | Type reference (TYPE) | AIND_ARKEY | SAP AS: Referenzstruktur für Archivekey/Archiveofs | 20050713 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_SRM_CONNECTION |
Repository Verbindung (abstrakt) | 20050713 |
Method CHECK_ARCHIVE_AUTH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ACTIVITY | Call by reference | Type reference (TYPE) | STRING | Aktivität (Archivieren, Lesen) | 20050201 | ||
| 2 | Importing |
ARC_OBJECT | Call by reference | Type reference (TYPE) | ARCH_OBJ-OBJECT | Archivierungsobjekt | 20050201 | ||
| 3 | Importing |
OBJECT | Call by reference | Type reference (TYPE) | STRING | Berechtigungsobjekt | 20050201 | ||
| 4 | Returning |
RE_IS_AUTHORIZED | Value transfer | Type reference (TYPE) | SRMGS_BOOLEAN | Berechtigung liegt vor (Ja/Nein) | 20050201 |
Method CHECK_ARCHIVE_AUTH on class CL_SRM_GSP_HELPER has no exception.
Method CHECK_AUTHORIZATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ACTIVITY | Value transfer | Type reference (TYPE) | STRING | Aktivität, die geprüft werden soll | 20041126 | ||
| 2 | Returning |
CHECK_OK | Value transfer | Type reference (TYPE) | SRMGS_BOOLEAN | Berechtigung liegt vor | 20041126 | ||
| 3 | Importing |
DOCUMENT_ID | Value transfer | Type reference (TYPE) | STRING | 'NONE' | Dokumenten-ID | 20041126 | |
| 4 | Importing |
MODEL_ID | Value transfer | Type reference (TYPE) | STRING | 'NONE' | Modell | 20041126 | |
| 5 | Importing |
OBJECT | Value transfer | Type reference (TYPE) | STRING | Berechtigungsobjekt | 20041126 | ||
| 6 | Importing |
PROPGROUP | Value transfer | Type reference (TYPE) | STRING | 'NONE' | Eigenschaftsgruppe | 20041126 | |
| 7 | Importing |
PROPNAME | Value transfer | Type reference (TYPE) | STRING | 'NONE' | Eigenschaftsname | 20041126 | |
| 8 | Importing |
RMS_ID | Value transfer | Type reference (TYPE) | STRING | 'NONE' | RMS | 20041126 | |
| 9 | Importing |
SPS_ID | Value transfer | Type reference (TYPE) | STRING | 'NONE' | SPS | 20041126 |
Method CHECK_AUTHORIZATION on class CL_SRM_GSP_HELPER has no exception.
Method CHECK_CONTENT_LOCATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
CONT_LOCATION_TAB | Call by reference | Type reference (TYPE) | SRM_GSP_CONTENT_LOCATION_TAB | Speicherkategorien der PHIOs | 20050113 | ||
| 2 | Importing |
DOCUMENT_ID | Call by reference | Type reference (TYPE) | SRMGS_DOC_ID | LOIO-ID | 20050113 | ||
| 3 | Exporting |
LOCATION_OK | Call by reference | Type reference (TYPE) | SRMGS_BOOLEAN | Content liegt in korrekter Speicherkategorie | 20050113 | ||
| 4 | Importing |
SPS_ID | Call by reference | Type reference (TYPE) | STRING | Elementart-ID | 20050113 | ||
| 5 | Importing |
STORAGE_CATEGORY | Call by reference | Type reference (TYPE) | SDOK_STCAT | Speicherkatogorie | 20050113 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP_KPRO_ACCESS |
Error occured during usage of kpro functionallity | 20050113 |
Method CONVERT_PROPERTY_NAMES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
CONVERTED_PROPS | Call by reference | Type reference (TYPE) | SDM_OBJECT_TAB | Extended property names | 20041014 | ||
| 2 | Importing |
REQUEST_PROPS | Call by reference | Type reference (TYPE) | SRMGS_STRING_TAB | Property names which have to be converted | 20041014 | ||
| 3 | Importing |
SPS_ID | Call by reference | Type reference (TYPE) | STRING | SPS-ID | 20041014 |
Method CONVERT_PROPERTY_NAMES on class CL_SRM_GSP_HELPER has no exception.
Method DOWNLOAD_ARCHIVED_CONTENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Changing |
IT_COMPONENTS | Value transfer | Type reference (TYPE) | SDOKCOMCHOS | Tabelle beschreibt PHIO und Speicherdetails | 20050713 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP_ARCHIVING |
Fehler bei der Durchführung der Archivierung | 20050713 |
Method FETCH_LOIO_PROPERTIES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
DOC_ID | Call by reference | Type reference (TYPE) | SRMGS_DOC_ID | LOIO-ID | 20041209 | ||
| 2 | Changing |
PROPERTIES | Call by reference | Type reference (TYPE) | SRMGS_PROPERTY_TAB | Eigenschaften | 20041209 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP_KPRO_ACCESS |
Error occured during usage of kpro functionallity | 20041209 |
Method FETCH_PHIO_PROPERTIES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
DOC_ID | Call by reference | Type reference (TYPE) | SRMGS_DOC_ID | PHIO-ID | 20041209 | ||
| 2 | Changing |
PROPERTIES | Call by reference | Type reference (TYPE) | SRMGS_PROPERTY_TAB | Eigenschaften | 20041209 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP_KPRO_ACCESS |
Error occured during usage of kpro functionallity | 20041209 |
Method GET_ARCHIVING_STATUS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
POID | Call by reference | Object reference (TYPE REF TO) | IF_SRM_POID | POID | 20050128 | ||
| 2 | Exporting |
STATUS | Call by reference | Type reference (TYPE) | C | Archivierungsstatus ('T'=makiert; 'A' = archiviert) | 20050128 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP_ARCHIVING |
Error occured while performing operations on archiv | 20050128 |
Method GET_CLIENT_SERVICE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_SPS_ID | Call by reference | Type reference (TYPE) | STRING | 'SRM_RMS_CLIENTFRAME_WIN' | 20120731 | ||
| 2 | Returning |
R_CLIENT_SERVICE | Value transfer | Object reference (TYPE REF TO) | IF_SRM_SRM_CLIENT_SERVICE | Reference to client-service interface | 20050117 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP_ARCHIVING |
Error occured while performing operations on archiv | 20050117 |
Method GET_DOCUMENT_URL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
FILE_NAME | Call by reference | Type reference (TYPE) | C | Dateiname | 20041216 | ||
| 2 | Importing |
PHIO_ID | Call by reference | Type reference (TYPE) | SDOKOBJECT | SDOK: BOR-Schlüssel für Informationsobjekt | 20041206 | ||
| 3 | Importing |
STORAGE_CATEGORY | Call by reference | Type reference (TYPE) | SDOKSTCA | SDOK: Speicherkategorien physischer Informationsobjekte | 20041215 | ||
| 4 | Exporting |
URL | Call by reference | Type reference (TYPE) | C | 20041206 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP_KPRO_ACCESS |
Error occured during usage of kpro functionallity | 20041206 |
Method GET_FILE_EXTENSION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EXTENSION | Call by reference | Type reference (TYPE) | C | 20041206 | |||
| 2 | Importing |
SUBTYPE | Call by reference | Type reference (TYPE) | C | 20041206 |
Method GET_FILE_EXTENSION on class CL_SRM_GSP_HELPER has no exception.
Method GET_GOS_SUCCESS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
SUCCESS | Value transfer | Type reference (TYPE) | SRMBOOLEAN | Boolean: Mögliche Werte IF_SRM=>TRUE / FALSE | 20120829 |
Method GET_GOS_SUCCESS on class CL_SRM_GSP_HELPER has no exception.
Method GET_INSTANCE_POID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
DOCUMENT_ID | Call by reference | Type reference (TYPE) | STRING | Dokument-ID | 20050117 | ||
| 2 | Importing |
RMS_ID | Call by reference | Type reference (TYPE) | STRING | RMS-ID | 20050117 | ||
| 3 | Returning |
R_INSTANCE_POID | Value transfer | Object reference (TYPE REF TO) | IF_SRM_POID | Instanz-POID | 20050117 | ||
| 4 | Importing |
SPS_ID | Call by reference | Type reference (TYPE) | STRING | SPS-ID | 20050117 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP_ARCHIVING |
Error occured while performing operations on archiv | 20050117 |
Method GET_NAVIGATION_COUNT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_NAVIGATION_ID | Call by reference | Type reference (TYPE) | STRING | User profile value | 20090428 | ||
| 2 | Exporting |
OV_NAVIGATION_COUNT | Call by reference | Type reference (TYPE) | STRING | Navigation count | 20090428 |
Method GET_NAVIGATION_COUNT on class CL_SRM_GSP_HELPER has no exception.
Method GET_PHIOS_OF_DOCUMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
DOCUMENT_ID | Call by reference | Type reference (TYPE) | SRMGS_DOC_ID | Dokument-ID | 20041207 | ||
| 2 | Exporting |
PHIOS | Call by reference | Type reference (TYPE) | SRMGS_DOC_ID_TAB | Tabelle der PHIOs | 20041207 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP_KPRO_ACCESS |
Error occured during usage of kpro functionallity | 20041207 |
Method GET_PROPERTIES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
DOCUMENT_ID | Call by reference | Type reference (TYPE) | SRMGS_DOC_ID | ID des Dokuments (LOIO oder PHIO) | 20041209 | ||
| 2 | Importing |
IS_LOIO | Call by reference | Type reference (TYPE) | SRMGS_BOOLEAN | Handelt es sich um ein LOIO? | 20041209 | ||
| 3 | Changing |
PROPERTIES | Call by reference | Type reference (TYPE) | SRMGS_PROPERTY_TAB | Tabelle mit Attributen | 20041209 | ||
| 4 | Importing |
SPS_ID | Call by reference | Type reference (TYPE) | STRING | 20041209 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP_KPRO_ACCESS |
Error occured during usage of kpro functionallity | 20041209 |
Method GET_PROPERTY_TYPES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
KIND_OF | Value transfer | Type reference (TYPE) | STRING | LOIO or PHIO property types? If not specified => both types | 20041115 | ||
| 2 | Exporting |
PROPERTY_TYPES | Call by reference | Type reference (TYPE) | SRMGS_PROPERTY_TYPE_TAB | Defined property types | 20041014 | ||
| 3 | Importing |
SPS_ID | Call by reference | Type reference (TYPE) | STRING | SPS-ID | 20041014 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP_KPRO_ACCESS |
Error occured during usage of kpro functionallity | 20041203 |
Method GET_RMS_ID_BY_LOIO_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
LOIO_ID | Call by reference | Type reference (TYPE) | SRMGS_DOC_ID | LOIO-ID | 20041213 | ||
| 2 | Returning |
RMS_ID | Value transfer | Type reference (TYPE) | STRING | RMS-ID | 20041213 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP_KPRO_ACCESS |
Error occured during usage of kpro functionallity | 20041213 |
Method GET_SPPOID_BY_POID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_SPS_ID | Call by reference | Type reference (TYPE) | STRING | 'SRM_CMG_CLIENTFRAME_WIN' | 20120731 | ||
| 2 | Importing |
POIDID | Call by reference | Type reference (TYPE) | SRMPOIDID | POID ID | 20120731 | ||
| 3 | Exporting |
SPPOID | Call by reference | Type reference (TYPE) | SRM_LIST_POID | List: POID Parameter Werte | 20120731 |
Method GET_SPPOID_BY_POID on class CL_SRM_GSP_HELPER has no exception.
Method GET_SPS_ID_BY_LOIO_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
LOIO_ID | Call by reference | Type reference (TYPE) | SRMGS_DOC_ID | LOIO-ID | 20041210 | ||
| 2 | Returning |
SPS_ID | Value transfer | Type reference (TYPE) | STRING | Elementart-ID | 20041210 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP_KPRO_ACCESS |
Error occured during usage of kpro functionallity | 20041210 |
Method GET_TEMP_DIRECTORY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
TEMPDIR | Call by reference | Type reference (TYPE) | CHAR255 | char255 | 20041117 |
Method GET_TEMP_DIRECTORY on class CL_SRM_GSP_HELPER has no exception.
Method GET_URL_FOR_GET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_COMPONENTS | Call by reference | Type reference (TYPE) | SRMGS_COMPONENTS | Tabelle der Komponenten | 20050713 | ||
| 2 | Exporting |
ET_URL_TAB | Call by reference | Type reference (TYPE) | SRMGS_URL_TAB | URLs für die Komponenten | 20050713 | ||
| 3 | Importing |
IS_LOIO_ID | Value transfer | Type reference (TYPE) | SRMGS_DOC_ID | 20050713 | |||
| 4 | Importing |
IS_PHIO_ID | Value transfer | Type reference (TYPE) | SRMGS_DOC_ID | 20050713 | |||
| 5 | Importing |
I_DP_URL_ONLY | Call by reference | Type reference (TYPE) | C | 20050713 | |||
| 6 | Importing |
I_FILENAME | Call by reference | Type reference (TYPE) | C | 20050713 | |||
| 7 | Importing |
I_URL_LIFETIME | Call by reference | Type reference (TYPE) | C | URL Lebensdauer -- Werte im DP und KPro nicht dokum.! | 20050713 | ||
| 8 | Importing |
I_WEB_URL_ONLY | Call by reference | Type reference (TYPE) | SRMGS_BOOLEAN | SRMGS_FALSE | Nur externe URLs zurückliefern | 20050713 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP_ARCHIVING |
Fehler bei der Durchführung der Archivierung | 20050713 | |
| 2 | CX_SRM_GSP_KPRO_ACCESS |
Fehler beim Zugriff auf KPro-Funktionen | 20050713 |
Method IS_DOCUMENT_ARCHIVED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_DOCUMENT_ID | Value transfer | Type reference (TYPE) | SRMGS_DOC_ID | LOIO-ID des Dokumentes | 20050713 | ||
| 2 | Returning |
RE_IS_ARCHIVED | Value transfer | Type reference (TYPE) | SRMGS_BOOLEAN | Dokument archiviert (Ja/Nein) | 20050713 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP_ARCHIVING |
Fehler bei der Durchführung der Archivierung | 20050713 |
Method IS_RECORD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
DOCUMENT_CLASS | Call by reference | Type reference (TYPE) | STRING | 20050713 | |||
| 2 | Importing |
DOCUMENT_ID | Call by reference | Type reference (TYPE) | STRING | 20050713 | |||
| 3 | Returning |
IS_RECORD | Value transfer | Type reference (TYPE) | SRMGS_BOOLEAN | 20041203 | |||
| 4 | Importing |
RMS_ID | Call by reference | Type reference (TYPE) | STRING | 20050713 | |||
| 5 | Importing |
SPS_ID | Call by reference | Type reference (TYPE) | STRING | Elementart-ID | 20041203 |
Method IS_RECORD on class CL_SRM_GSP_HELPER has no exception.
Method KPRO_QUERY_DATE_CONVERSION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
OPTION_IN | Call by reference | Type reference (TYPE) | ATTR_OPTION | 20041014 | |||
| 2 | Exporting |
OPTION_OUT | Call by reference | Type reference (TYPE) | STRING | 20041014 | |||
| 3 | Importing |
VALUE1_IN | Call by reference | Type reference (TYPE) | SRMGS_PROP_VALUE | 20041014 | |||
| 4 | Exporting |
VALUE1_OUT | Call by reference | Type reference (TYPE) | STRING | 20041014 | |||
| 5 | Importing |
VALUE2_IN | Call by reference | Type reference (TYPE) | SRMGS_PROP_VALUE | 20041014 | |||
| 6 | Exporting |
VALUE2_OUT | Call by reference | Type reference (TYPE) | STRING | 20041014 |
Method KPRO_QUERY_DATE_CONVERSION on class CL_SRM_GSP_HELPER has no exception.
Method READ_DOCUMENT_FROM_ARCHIVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ARCHIVE_NAME | Call by reference | Type reference (TYPE) | ARKEY | Schlüssel einer Archivdatei | 20050131 | ||
| 2 | Importing |
ARCHIVE_OBJECT | Call by reference | Type reference (TYPE) | ARCH_OBJ-OBJECT | Archivierungsobjekt | 20050131 | ||
| 3 | Changing |
LOIO | Call by reference | Type reference (TYPE) | SRM_GSP_ARC_LOIO_TAB | Tabelle zur Speicherung archivierter LOIOs | 20050131 | ||
| 4 | Changing |
LOIOP | Call by reference | Type reference (TYPE) | SRM_GSP_ARC_LOIOP_TAB | Tabelle zur Speicherung von LOIO-Properties | 20050131 | ||
| 5 | Importing |
OBJECT_OFFSET | Call by reference | Type reference (TYPE) | ADMI_OFFST | Offset des Datenobjekts in der Archivdatei | 20050131 | ||
| 6 | Changing |
PHCO | Call by reference | Type reference (TYPE) | SRM_GSP_ARC_PHCO_TAB | Tablelle mit PHIO-Content | 20050131 | ||
| 7 | Changing |
PHCOB | Call by reference | Type reference (TYPE) | SRM_GSP_ARC_PHCOB_TAB | Tabelle mit PHIO-Content (binär) | 20050131 | ||
| 8 | Changing |
PHCOI | Call by reference | Type reference (TYPE) | SRM_GSP_ARC_PHCOI_TAB | Tabelle mit PHIO-Content (Info) | 20050131 | ||
| 9 | Changing |
PHCOT | Call by reference | Type reference (TYPE) | SRM_GSP_ARC_PHCOT_TAB | Tabelle mit PHIO-Content (Text) | 20050131 | ||
| 10 | Changing |
PHIO | Call by reference | Type reference (TYPE) | SRM_GSP_ARC_PHIO_TAB | Tabelle zur Speicherung von archivierter PHIOs | 20050131 | ||
| 11 | Changing |
PHIOP | Call by reference | Type reference (TYPE) | SRM_GSP_ARC_PHIOP_TAB | Tabelle zur Speicherung von PHIO-Properties | 20050131 | ||
| 12 | Changing |
REIO | Call by reference | Type reference (TYPE) | SRM_GSP_ARC_REIO_TAB | Tabelle zur Speicherung von archivierter REIOs | 20050131 | ||
| 13 | Changing |
REIOP | Call by reference | Type reference (TYPE) | SRM_GSP_ARC_REIOP_TAB | Tabelle zur Speicherung von REIO-Properties | 20050131 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP_ARCHIVING |
Error occured while performing operations on archiv | 20050131 |
Method SEARCH_MATCHING_DOCUMENTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PROPERTY_QUERY | Call by reference | Type reference (TYPE) | SDM_QUERY_DESC_TAB | Specifies the property-query | 20041014 | ||
| 2 | Importing |
PROPERTY_RETRIEVAL | Value transfer | Type reference (TYPE) | SRMGS_BOOLEAN | Properties of documents have to be returned | 20041014 | ||
| 3 | Exporting |
QUERY_RESULTS | Call by reference | Type reference (TYPE) | SDM_QUERY_RESULT_LIST | Ergebnisse der Dokument-Suche | 20041014 | ||
| 4 | Exporting |
RESULT_PROPERTIES_TAB | Call by reference | Type reference (TYPE) | SDM_OBJECT_PROP_TAB | Properties of the documents | 20041014 | ||
| 5 | Importing |
RMS_ID | Value transfer | Type reference (TYPE) | STRING | RMS-ID | 20041014 | ||
| 6 | Importing |
SPS_ID | Value transfer | Type reference (TYPE) | STRING | Elementart-ID | 20041014 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_GSP_ARCHIVING |
Error occured during search of documents for archiving | 20041014 |
Method SET_GOS_SUCCESS Signature
Method SET_GOS_SUCCESS on class CL_SRM_GSP_HELPER has no parameter.
Method SET_GOS_SUCCESS on class CL_SRM_GSP_HELPER has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 700 |
