Skip navigation links

oracle.irm.engine.core.time
Interface RelativeTimeSpan

All Superinterfaces:

TimeSpan

public interface RelativeTimeSpan

extends TimeSpan

A relative time span. A relative time span defines a start time and stop time that is relative to an absolute point in time.

Creation

Instances of Relative Time Span objects can be created using the following factory style method(s).

RelativeTimeSpan object = createRelativeTimeSpan(
    timeBase,
    startTime,
    stopTime);

RelativeTimeSpan object = createRelativeTimeSpan(
    referencePoint,
    timeBase,
    startTime,
    stopTime);

XML Serialization

Relative Time Span instances can be serialized as an XML document. This XML document can also be used to recreate a Relative Time Span object. The following XML document shows an example Relative Time Span in XML form.

<?xml version="1.0" encoding="UTF-8"?>
<core:RelativeTimeSpan xmlns:core="http://xmlns.oracle.com/irm/core">
<referencePoint>CURRENT</referencePoint>
<timeBase>CLASSIFICATION</timeBase>
<startTime>
<amount>60</amount>
<units>SECONDS</units>
</startTime>
<stopTime>
<amount>120</amount>
<units>SECONDS</units>
</stopTime>
</core:RelativeTimeSpan>

Nested Class Summary

static class

RelativeTimeSpan.TimeBase Relative time bases.

Nested classes/interfaces inherited from interface oracle.irm.engine.core.time.TimeSpan

TimeSpan.ReferencePoint

Method Summary

TimePeriod	getStartTime() Start time for the time span.
TimePeriod	getStopTime() Stop time for the time span.
RelativeTimeSpan.TimeBase	getTimeBase() The relative time base.

Methods inherited from interface oracle.irm.engine.core.time.TimeSpan

getReferencePoint, getStartTime, getStopTime

Method Detail

getTimeBase

RelativeTimeSpan.TimeBase getTimeBase()

The relative time base. The time base value determines that absolute time the relative time span refers. e.g. For one month after the classification was applied compared to current time.

Returns:

the value of the property. This method will never return null.

getStartTime

TimePeriod getStartTime()

Start time for the time span. For a time span that just has a stop time this property can be left un-set.

Returns:

the value of the property. This method can return null.

getStopTime

TimePeriod getStopTime()

Stop time for the time span. For an open ended time span this property can be left un-set.

Returns:

the value of the property. This method can return null.

Skip navigation links