Skip navigation links

oracle.imaging
Class Application.StorageStage

java.lang.Object
oracle.imaging.Application.StorageStage

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

Application

public static class Application.StorageStage

extends java.lang.Object

implements java.io.Serializable

A data structure specifying a storage stage, consisting of a volume and duration to remain on that volume, for documents within an application. An array of these structures defines the storage policy for an application.

See Also:

Serialized Form

Nested Class Summary

static class

Application.StorageStage.DurationUnit Defines the available units for specifiying storage durations.

Constructor Summary

Application.StorageStage()
Constructor.

Application.StorageStage(java.lang.String volumeName)
Constructs a StorageStage with an indefinite duration.

Application.StorageStage(java.lang.String volumeName, int duration, Application.StorageStage.DurationUnit durationUnit)
Constructs a StorageStage with a fixed duration.

Method Summary

int	getDuration() Get the storage duration in days.
Application.StorageStage.DurationUnit	getDurationUnit() Get the storage duration unit of time.
java.lang.String	getVolume() Get the volume property
boolean	isIndefinite() Indicates whether the duration is indefinite.
void	setDuration(int aDuration) Set the storage duration in days.
void	setDurationUnit(Application.StorageStage.DurationUnit aDurationUnit) Set the storage duration unit of time.
void	setIndefinite(boolean isForever) Sets (or clears) an indefinite duration.
void	setVolume(java.lang.String volumeName) Set the volume property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Application.StorageStage

public Application.StorageStage()

Constructor.

Application.StorageStage

public Application.StorageStage(java.lang.String volumeName,
                                int duration,
                                Application.StorageStage.DurationUnit durationUnit)

Constructs a StorageStage with a fixed duration.

Parameters:

volumeName -

duration - Specified in whole days.

durationUnit -

Application.StorageStage

public Application.StorageStage(java.lang.String volumeName)

Constructs a StorageStage with an indefinite duration.

Parameters:

volumeName -

Method Detail

setVolume

public void setVolume(java.lang.String volumeName)

Set the volume property.

Parameters:

volumeName -

getVolume

public java.lang.String getVolume()

Get the volume property

Returns:

the Volume associated with this storage stage

setDuration

public void setDuration(int aDuration)

Set the storage duration in days.

Parameters:

aDuration - Specified in whole days.

getDuration

public int getDuration()

Get the storage duration in days.

Returns:

the storage duration for this storage stage

setDurationUnit

public void setDurationUnit(Application.StorageStage.DurationUnit aDurationUnit)

Set the storage duration unit of time.

Parameters:

aDurationUnit -

getDurationUnit

public Application.StorageStage.DurationUnit getDurationUnit()

Get the storage duration unit of time.

Returns:

the duration unit associated with this storage stage

setIndefinite

public void setIndefinite(boolean isForever)

Sets (or clears) an indefinite duration.

Parameters:

isForever - true if the duration is indefinite; otherwise false

isIndefinite

public boolean isIndefinite()

Indicates whether the duration is indefinite.

Returns:

true if the duration is indefinite; otherwise false

Skip navigation links