SAP ABAP Interface IF_DTS_READER (Read Entry in Downtime Schedule)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
SV-SMG-OP (Application Component) Solution Directory
⤷
SDTS1 (Package) API for Editing and Reading Downtime Schedule
⤷
⤷
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface composition (i COMPRISING i_ref) | IF_DTS_EDITOR | Edit Entry in Downtime Schedule | 20070518 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_DTS_ENTRY | Entry in the downtime schedule | 20070518 |
Properties
| Interface | IF_DTS_READER | |
| Short Description | Read Entry in Downtime Schedule |
General Data
| Package | SDTS1 | API for Editing and Reading Downtime Schedule |
| Created | 20070518 | SAP |
| Last changed | 20130531 | SAP |
| Unicode checks active |
Forward declarations
Interface IF_DTS_READER has no forward declaration.
Interfaces
Interface IF_DTS_READER has no interface.
Friends
Interface IF_DTS_READER has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | C_CAT_PLANNED_AVAILABILITY | Constant | Public | Type reference (TYPE) | DTSCATEGORY | 121 | Category: Planned Availability | 20070529 | |
| 2 | C_CAT_PLANNED_DOWNTIME | Constant | Public | Type reference (TYPE) | DTSCATEGORY | 1 | Category: Planned Downtime | 20070529 | |
| 3 | C_CAT_UNPLANNED_DOWNTIME | Constant | Public | Type reference (TYPE) | DTSCATEGORY | 61 | Category: Unplanned Downtime | 20070529 | |
| 4 | C_COMPTP_CCMS | Constant | Public | Type reference (TYPE) | DTSCOMPTP | 'CCMS' | Component defined in CCMS | 20071008 | |
| 5 | C_COMPTP_LOCAL | Constant | Public | Type reference (TYPE) | DTSCOMPTP | 'LOCAL' | Not defined anywhere | 20070608 | |
| 6 | C_COMPTP_SLD | Constant | Public | Type reference (TYPE) | DTSCOMPTP | 'SLD' | Component defined in SLD | 20070604 | |
| 7 | C_COMPTP_SMSY | Constant | Public | Type reference (TYPE) | DTSCOMPTP | 'SMSY' | Component defined in Solution Manager SMSY | 20070604 | |
| 8 | C_COMP_LOCAL | Constant | Public | Type reference (TYPE) | DTSCOMPKEY | '$LOCALSYST' | Component of local system | 20070604 | |
| 9 | C_DISTR_FAILED_MANAGED | Constant | Public | Type reference (TYPE) | DTSDISTRSTAT | 11 | Distribution to managed system | 20070518 | |
| 10 | C_DISTR_LOCAL | Constant | Public | Type reference (TYPE) | DTSDISTRSTAT | 0 | No distribution | 20070518 | |
| 11 | C_DISTR_SYNCH_MANAGED | Constant | Public | Type reference (TYPE) | DTSDISTRSTAT | 1 | Distribution to managed system | 20070518 | |
| 12 | C_MONSTAT_FULL | Constant | Public | Type reference (TYPE) | DTSMONSTAT | 255 | Full Monitoring | 20070529 | |
| 13 | C_MONSTAT_NO_ALERTS | Constant | Public | Type reference (TYPE) | DTSMONSTAT | 100 | Suppress Alerts | 20070529 | |
| 14 | C_MONSTAT_NO_INCIDENTS | Constant | Public | Type reference (TYPE) | DTSMONSTAT | 200 | Suppress Error Messages | 20070529 | |
| 15 | C_MONSTAT_OFF | Constant | Public | Type reference (TYPE) | DTSMONSTAT | 50 | Monitoring Pause | 20070529 | |
| 16 | ENTRY_ID | Instance attribute | Public | Type reference (TYPE) | DTSGUID | DTS: GUID of an entry in the downtime schedule | 20070518 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Get the downtime category | 20070518 | |
| 2 | Instance method | Public | Method | Get the key for a component in the landscape | 20070622 | |
| 3 | Instance method | Public | Method | Get time and user of creation of entry | 20070518 | |
| 4 | Instance method | Public | Method | Get the distribution status | 20070518 | |
| 5 | Instance method | Public | Method | Get info text for downtime | 20070518 | |
| 6 | Instance method | Public | Method | Get time and user of last change | 20070518 | |
| 7 | Instance method | Public | Method | Get the monitoring status | 20070518 | |
| 8 | Instance method | Public | Method | Get all downtime periods | 20070518 | |
| 9 | Instance method | Public | Method | Get technical reason for downtime | 20070518 | |
| 10 | Instance method | Public | Method | Get system responsible | 20070518 | |
| 11 | Instance method | Public | Method | Get the recurrence rules for the downtime | 20070518 | |
| 12 | Instance method | Public | Method | 20070909 | ||
| 13 | Instance method | Public | Method | Returns true if distributed successfully | 20070518 | |
| 14 | Instance method | Public | Method | Returns true if end of downtime has not yet been set | 20070518 |
Events
Interface IF_DTS_READER has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TS_RULE_DATES | Public | See coding | Rule ID and validity | 20070619 | begin of ts_rule_dates,
rule_id type sc_ruleid,
start_date type sydatum,
end_date type sydatum,
end of ts_rule_dates
|
|
| 2 | TT_RULE_DATES | Public | See coding | Sorted table of rule_id and validity | 20070619 | tt_rule_dates type sorted table of ts_rule_dates with non-unique key start_date end_date
|
|
| 3 | TT_RULE_ID | Public | See coding | Table of SC_RULEID (See function group SSC_RULES) | 20070522 | TT_RULE_ID type standard table of sc_ruleid with DEFAULT KEY
|
Method Signatures
Method GET_CATEGORY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RP_RESULT | Value transfer | Type reference (TYPE) | DTSCATEGORY | DTS: Downtime Category | 20070518 |
Method GET_CATEGORY on Interface IF_DTS_READER has no exception.
Method GET_COMPONENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IP_COMPTYPE | Call by reference | Type reference (TYPE) | DTSCOMPTP | Convert to component type | 20071008 | |||
| 2 | RS_RESULT | Value transfer | Type reference (TYPE) | SSDTSCOMP | DTS: Component | 20070622 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Exception in DTS API | 20070622 |
Method GET_CREATED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RS_RESULT | Value transfer | Type reference (TYPE) | SSDTSMOD | DTS: Modification entry | 20070518 |
Method GET_CREATED on Interface IF_DTS_READER has no exception.
Method GET_DISTRIBUTION_STATUS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RP_RESULT | Value transfer | Type reference (TYPE) | DTSDISTRSTAT | DTS: Distribution Status for Synch | 20070518 |
Method GET_DISTRIBUTION_STATUS on Interface IF_DTS_READER has no exception.
Method GET_INFO_TEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RP_RESULT | Value transfer | Type reference (TYPE) | DTSINFOTXT | DTS: Infotext | 20070518 |
Method GET_INFO_TEXT on Interface IF_DTS_READER has no exception.
Method GET_LAST_CHANGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RS_RESULT | Value transfer | Type reference (TYPE) | SSDTSMOD | DTS: Modification entry | 20070518 |
Method GET_LAST_CHANGE on Interface IF_DTS_READER has no exception.
Method GET_MONITORING_STATUS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RP_RESULT | Value transfer | Type reference (TYPE) | DTSMONSTAT | DTS: Monitoring Status | 20070518 |
Method GET_MONITORING_STATUS on Interface IF_DTS_READER has no exception.
Method GET_PERIODS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_PERIODS | Call by reference | Type reference (TYPE) | TSDTSDUR | DTS: List of Downtimeperiods | 20070518 | |||
| 2 | IP_COUNT | Call by reference | Type reference (TYPE) | I | Number of periods to return | 20070606 | |||
| 3 | IP_FROM | Call by reference | Type reference (TYPE) | DTSTSFROM | DTS: Timestamp for start of downtime | 20070606 | |||
| 4 | IP_UNTIL | Call by reference | Type reference (TYPE) | DTSTSUNTIL | DTS: Timestamp for end of downtime | 20070606 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Exception in DTS API | 20070522 |
Method GET_REASON Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RP_RESULT | Value transfer | Type reference (TYPE) | DTSREASON | DTS: Technical downtime reason | 20070518 |
Method GET_REASON on Interface IF_DTS_READER has no exception.
Method GET_RESPONSIBLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RP_RESULT | Value transfer | Type reference (TYPE) | DTSOWNER | DTS: System Owner | 20070518 |
Method GET_RESPONSIBLE on Interface IF_DTS_READER has no exception.
Method GET_RULES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_RULES | Call by reference | Type reference (TYPE) | TT_RULE_ID | Table of recurrence rule ids (see FuGr SSC_RULES) | 20070518 | |||
| 2 | ET_RULE_DATES | Call by reference | Type reference (TYPE) | TT_RULE_DATES | Sorted table of rule_id and validity | 20070619 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Exception in DTS API | 20070619 | ||
| 2 | Exception in recurrence rule | 20070522 |
Method IS_ACTIVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RP_RESULT | Value transfer | Type reference (TYPE) | FLAG | X = true | 20070909 |
Method IS_ACTIVE on Interface IF_DTS_READER has no exception.
Method IS_DISTRIBUTED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RP_RESULT | Value transfer | Type reference (TYPE) | FLAG | X = true | 20070518 |
Method IS_DISTRIBUTED on Interface IF_DTS_READER has no exception.
Method IS_PERIOD_OPEN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RP_RESULT | Value transfer | Type reference (TYPE) | FLAG | X = true | 20070518 |
Method IS_PERIOD_OPEN on Interface IF_DTS_READER has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 710 |