Skip navigation links

Oracle® Information Rights Management Server Java API Reference
11g Release 1 (11.1.1)

E12907-03


oracle.irm.engine.types.core.time
Class RelativeTimeSpan

java.lang.Object
  extended by oracle.irm.engine.types.core.time.TimeSpan
      extended by oracle.irm.engine.types.core.time.RelativeTimeSpan

All Implemented Interfaces:
Serializable

public class RelativeTimeSpan
extends TimeSpan
implements Serializable

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

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>

See Also:
Serialized Form

Nested Class Summary
static class RelativeTimeSpan.TimeBase
          Time Base enumeration.

 

Nested classes/interfaces inherited from class oracle.irm.engine.types.core.time.TimeSpan
TimeSpan.ReferencePoint

 

Constructor Summary
RelativeTimeSpan()
          No argument constructor.
RelativeTimeSpan(TimeSpan.ReferencePoint referencePoint, RelativeTimeSpan.TimeBase timeBase, TimePeriod startTime, TimePeriod stopTime)
          Constructor.

 

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.
 void setStartTime(TimePeriod value)
          Start time for the time span.
 void setStopTime(TimePeriod value)
          Stop time for the time span.
 void setTimeBase(RelativeTimeSpan.TimeBase value)
          The relative time base.

 

Methods inherited from class oracle.irm.engine.types.core.time.TimeSpan
getReferencePoint, setReferencePoint

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

RelativeTimeSpan

public RelativeTimeSpan()
No argument constructor.

RelativeTimeSpan

public RelativeTimeSpan(TimeSpan.ReferencePoint referencePoint,
                        RelativeTimeSpan.TimeBase timeBase,
                        TimePeriod startTime,
                        TimePeriod stopTime)
Constructor.

Method Detail

getTimeBase

public 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.

setTimeBase

public void setTimeBase(RelativeTimeSpan.TimeBase value)
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.
Parameters:
value - the new value for the property.

getStartTime

public 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.

setStartTime

public void setStartTime(TimePeriod value)
Start time for the time span. For a time span that just has a stop time this property can be left un-set.
Parameters:
value - the new value for the property.

getStopTime

public 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.

setStopTime

public void setStopTime(TimePeriod value)
Stop time for the time span. For an open ended time span this property can be left un-set.
Parameters:
value - the new value for the property.

Skip navigation links

Oracle® Information Rights Management Server Java API Reference
11g Release 1 (11.1.1)

E12907-03


Copyright © 2011, Oracle. All rights reserved.