SAP ABAP Class CL_ARC_UTILITY (Helper for General Storage Tasks)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-ILM-IRM (Application Component) Information Retention Manager
⤷
S_ARC (Package) ILM Services
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-ILM-IRM (Application Component) Information Retention Manager⤷
S_ARC (Package) ILM ServicesProperties
| Class | CL_ARC_UTILITY | |
| Short Description | Helper for General Storage Tasks | |
| Super Class | ||
| Instantiability of a Class | 0 | Private |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_ARC | ILM Services |
| Created | 20071113 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  IF_LRM_RTP_TYPES |
Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
Interfaces
Class CL_ARC_UTILITY has no interface implemented.
Friends
Class CL_ARC_UTILITY has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_ALLOWED_CHARS |
Constant | Public | Type reference (TYPE) | STRING | '0123456789abcdefghijklmnopqrstuvwxyz_-.!~' | 20071113 | ||
| 2 | GC_UNDEFINED_DATE |
Constant | Public | Type reference (TYPE) | STRING | '99991231000000' | 20071113 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CHECK_COL_NAME |
Static method | Public | Method | Check of Collection Name for Impermissible Characters | 20071113 |
| 2 | CONVERT_TIMESTAMP_OUTBOUND |
Static method | Public | Method | Convert Short Time Stamp by yyyy-mm-dd | 20111006 |
| 3 | SET_EXPIRATION_DATE |
Static method | Public | Method | Set Expiration Date at the Expiration Date Node | 20071113 |
Events
Class CL_ARC_UTILITY has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | DECISION_TABLE_UUID | Public | Type reference (TYPE) | CHAR32 | FDT UUID | 20080725 | |
| 2 | RETENTION_PERIOD_MAX_END | Public | Type reference (TYPE) | TZNTSTMPS | End of Maximum Retention Period | 20071116 | |
| 3 | RETENTION_PERIOD_MIN_BEGIN | Public | Type reference (TYPE) | TZNTSTMPS | Minimum Retention Period Start | 20071115 | |
| 4 | TY_IRM_OBJECT_TYPE | Public | See coding | Object Type | 20080725 | TY_IRM_OBJECT_TYPE(30) TYPE c
|
|
| 5 | TY_S_FIELDNAME_A_VALUE_AS_STR | Public | See coding | 20080811 | BEGIN OF ty_s_fieldname_a_value_as_str,
v_field_name TYPE fieldname,
v_field_value TYPE string,
END OF ty_s_fieldname_a_value_as_str
|
||
| 6 | TY_S_FIELD_DATA_ELEMENTS | Public | See coding | 20080725 | BEGIN OF ty_s_field_data_elements,
v_field_name TYPE fieldname,
v_data_element TYPE rollname,
END OF ty_s_field_data_elements
|
||
| 7 | TY_S_INSTANCE_ORIGIN | Public | See coding | 20080725 | BEGIN OF ty_s_instance_origin ,
v_system_id TYPE sysysid,
v_system_id_original TYPE sysysid,
v_client TYPE mandt,
v_client_original TYPE mandt,
END OF ty_s_instance_origin
|
||
| 8 | TY_S_RETENTION_LOCATION | Public | Type reference (TYPE) | IF_LRM_RTP_TYPES=>TY_S_RETENTION_LOCATION | Storage Location | 20080721 | |
| 9 | TY_S_RETENTION_LOCATION_IRM | Public | See coding | 20080725 | BEGIN OF ty_s_retention_location_irm,
v_object_type TYPE ty_irm_object_type,
t_routing_parameter_org TYPE ty_t_routing_org_field_info,
s_routing_parameter_time TYPE ty_s_routing_time_field_info,
v_archive_store TYPE admi_astor,
v_content_repository TYPE scms_crep,
v_log_filename TYPE fileintern,
v_fdt_decision_table_uuid TYPE sysuuid_c,
END OF ty_s_retention_location_irm
|
||
| 10 | TY_S_RETENTION_LOCATION_LRM | Public | See coding | 20080725 | BEGIN OF ty_s_retention_location_lrm,
v_object_type TYPE ty_irm_object_type,
t_routing_parameter_org TYPE ty_t_routing_org_field_info,
s_routing_parameter_time TYPE ty_s_routing_time_field_info,
v_archive_store TYPE admi_astor,
v_content_repository TYPE scms_crep,
v_log_filename TYPE fileintern,
END OF ty_s_retention_location_lrm
|
||
| 11 | TY_S_RETENTION_PERIOD | Public | See coding | Retention Time | 20071115 | BEGIN OF TY_S_RETENTION_PERIOD,
v_retention_period_begin TYPE tzntstmps,
v_retention_period_min_end TYPE tzntstmps,
v_retention_period_max_end TYPE tzntstmps,
END OF TY_S_RETENTION_PERIOD
|
|
| 12 | TY_S_RETENTION_SITE | Public | See coding | 20080725 | BEGIN OF ty_s_retention_site,
v_archive_store TYPE admi_astor,
v_content_repository TYPE scms_crep,
v_log_filename TYPE fileintern,
END OF ty_s_retention_site
|
||
| 13 | TY_S_ROUTING_ORG_FIELD_INFO | Public | See coding | Routing Field Name + Value + Description | 20071115 | BEGIN OF ty_s_routing_org_field_info,
v_routing_field_name TYPE fieldname,
v_routing_field_value TYPE REF TO data,
v_routing_field_data_element TYPE rollname,
END OF ty_s_routing_org_field_info
|
|
| 14 | TY_S_ROUTING_PARAMETERS | Public | See coding | 20080725 | BEGIN OF ty_s_routing_parameters,
object_name TYPE string,
home_path TYPE string,
org_path_ext TYPE string,
date_path_ext TYPE string,
org_uri TYPE string,
org_path TYPE string,
date_uri TYPE string,
date_path TYPE string,
session_path TYPE string,
session_uri TYPE string,
webdav_dest TYPE rfcdest,
expiration_date TYPE timestamp,
start_of_retention_date TYPE timestamp,
archive_store TYPE admi_astor,
crep TYPE scms_crep,
log_filename TYPE fileintern,
END OF ty_s_routing_parameters
|
||
| 15 | TY_S_ROUTING_PATH | Public | See coding | 20080725 | BEGIN OF ty_s_routing_path,
pos_inh_obj_name TYPE i,
inh_obj_name TYPE ty_irm_object_type,
pos_org_part1 TYPE i,
name_org_part1 TYPE fieldname,
pos_org_part2 TYPE i,
name_org_part2 TYPE fieldname,
pos_org_part3 TYPE i,
name_org_part3 TYPE fieldname,
pos_org_part4 TYPE i,
name_org_part4 TYPE fieldname,
pos_date_part TYPE i,
name_date_part TYPE fieldname,
END OF ty_s_routing_path
|
||
| 16 | TY_S_ROUTING_TIME_FIELD_INFO | Public | See coding | Routing Field Name + Time Stamp + Description | 20071115 | BEGIN OF ty_s_routing_time_field_info,
v_routing_field_name TYPE fieldname,
v_routing_field_value TYPE tzntstmps,
END OF ty_s_routing_time_field_info
|
|
| 17 | TY_S_ROUT_PARAMS_FROM_IRM | Public | See coding | 20080725 | BEGIN OF ty_s_rout_params_from_irm,
object_type TYPE ty_irm_object_type,
expiration_date TYPE timestamp,
* begin max_retention
max_retention_date TYPE timestamp,
* end max_retention
start_of_retention_date TYPE timestamp,
t_routing_parameter_org TYPE ty_t_routing_org_field_info,
s_routing_parameter_time TYPE ty_s_routing_time_field_info,
s_routing_parameter_base_time TYPE tzntstmps,
archive_store TYPE admi_astor,
crep TYPE scms_crep,
log_filename TYPE fileintern,
fdt_decision_table_uuid TYPE sysuuid_c,
data_object_kind TYPE lrm_data_object_kind,
END OF ty_s_rout_params_from_irm
|
||
| 18 | TY_S_TABLE_AND_FIELD | Public | See coding | 20080725 | BEGIN OF ty_s_table_and_field,
v_table_name TYPE tabname,
v_table_field_name TYPE fieldname,
END OF ty_s_table_and_field
|
||
| 19 | TY_S_TABNAME_FIELDNAME_VALUES | Public | See coding | Table Name + Field Name + Table of Field Values | 20071115 | BEGIN OF ty_s_tabname_fieldname_values,
v_table_name TYPE tabname,
v_field_name TYPE fieldname,
t_field_value TYPE ty_t_field_value,
END OF ty_s_tabname_fieldname_values
|
|
| 20 | TY_TH_FIELDNAME_A_VALUE_AS_STR | Public | See coding | 20080811 | ty_th_fieldname_a_value_as_str TYPE HASHED TABLE OF ty_s_fieldname_a_value_as_str
WITH UNIQUE KEY v_field_name
|
||
| 21 | TY_TH_TABNAME_FIELDNAME_VALUES | Public | See coding | Table with: Table Name + Field Name + Table of Field Values | 20071115 | ty_th_tabname_fieldname_values TYPE HASHED TABLE OF ty_s_tabname_fieldname_values
WITH UNIQUE KEY v_table_name v_field_name
|
|
| 22 | TY_T_FIELD_DATA_ELEMENTS | Public | See coding | 20080725 | ty_t_field_data_elements TYPE STANDARD TABLE OF ty_s_field_data_elements WITH DEFAULT KEY
|
||
| 23 | TY_T_FIELD_VALUE | Public | See coding | Table with: Reference to Field Values | 20071115 | TY_T_FIELD_VALUE TYPE STANDARD TABLE OF REF TO data WITH DEFAULT KEY
|
|
| 24 | TY_T_OBJECT_TYPE | Public | See coding | 20080725 | ty_t_object_type TYPE STANDARD TABLE OF TY_IRM_OBJECT_TYPE WITH DEFAULT KEY
|
||
| 25 | TY_T_ROUTING_ORG_FIELD_INFO | Public | See coding | Table with: Routing Field Name + Value + Description | 20071115 | ty_t_routing_org_field_info TYPE STANDARD TABLE OF ty_s_routing_org_field_info WITH DEFAULT KEY
|
|
| 26 | TY_T_ROUTING_PARAMETERS | Public | See coding | 20080725 | ty_t_routing_parameters TYPE STANDARD TABLE OF ty_s_routing_parameters WITH DEFAULT KEY
|
||
| 27 | TY_T_ROUT_PARAMS_FROM_IRM | Public | See coding | 20080725 | ty_t_rout_params_from_irm TYPE STANDARD TABLE OF ty_s_rout_params_from_irm WITH DEFAULT KEY
|
||
| 28 | TY_T_TABLE_AND_FIELD | Public | See coding | 20080725 | ty_t_table_and_field TYPE STANDARD TABLE OF ty_s_table_and_field
WITH DEFAULT KEY
|
Method Signatures
Method CHECK_COL_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IV_COL_NAME | Call by reference | Type reference (TYPE) | STRING | Name einer Kollektion | 20071113 | ||
| 2 | Importing |
IV_FIELD_NAME | Call by reference | Type reference (TYPE) | FIELDNAME | Feldname der Herkunft einer Kollektion | 20071113 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_ARC_DAS |
DAS-Konnektor: Ausnahmen auf T100 Basis | 20071113 |
Method CONVERT_TIMESTAMP_OUTBOUND Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_TIMESTAMP | Call by reference | Type reference (TYPE) | TIMESTAMP | UTC-Zeitstempel in Kurzform (JJJJMMTThhmmss) | 20111006 | ||
| 2 |  Returning |
RV_DATE | Value transfer | Type reference (TYPE) | STRING | 20111006 |
Method CONVERT_TIMESTAMP_OUTBOUND on class CL_ARC_UTILITY has no exception.
Method SET_EXPIRATION_DATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_EXPIRATION_DATE | Call by reference | Type reference (TYPE) | TIMESTAMP | Ablaufdatum einer Kollektion/Resource | 20071113 | ||
| 2 | Importing |
IV_START_OF_RETENTION | Call by reference | Type reference (TYPE) | TIMESTAMP | Beginn der Aufbewahrungsfrist | 20071113 | ||
| 3 | Importing |
IV_URI | Call by reference | Type reference (TYPE) | STRING | URI des Expirationdate-Knotens | 20071113 | ||
| 4 | Importing |
IV_WEBDAV_DEST | Call by reference | Type reference (TYPE) | ADMI_WEBDAV_DESTINATION | HTTP-Verbindung zum XML-DAS für WebDAV | 20071113 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ARC_DAS |
DAS-Konnektor: Ausnahmen auf T100 Basis | 20071113 | |
| 2 | CX_XADK |
XADK: Ausnahmen | 20080429 | |
| 3 | CX_XADK_DAS_CLIENT |
XADK: DA Service Client Ausnahmen | 20071113 | |
| 4 | CX_XADK_DAS_SERVER |
XADK: DA Service Server Ausnahmen | 20071113 | |
| 5 | CX_XADK_SYSTEM |
XADK: Ausnahmen des WebServer oder Ablagesystems | 20071113 |
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 711 |
