com.dynalivery.repository.util
Class ExpirationOptions

java.lang.Object
  |
  +--com.dynalivery.repository.util.ExpirationOptions

public class ExpirationOptions

extends java.lang.Object

implements java.io.Serializable

This class describes the desired expiration options when checking in an output file, modifying an output file or creating/modifying a folder.

See Also:

Serialized Form

Field Summary

static int	FILE_EXPIRES_IN_N_DAYS expiration mode indicating the file expires in the specified number of days
static int	FILE_EXPIRES_IN_N_MINUTES expiration mode indicating the file expires in the specified number of minutes
static int	FILE_NEVER_EXPIRES expiration mode indicating the file never expires
static int	USE_DEFAULTS expiration mode indicating the folder defaults should be used

Constructor Summary

ExpirationOptions()
Public constructor with no parameters.

ExpirationOptions(int mode, int interval)
Public constructor which allows mode and interval to be explicitly set

Method Summary

java.lang.String	getExpirationModeString() Get expiration mode string
int	getExpirationPropertiesMode() Returns the ExpirationProperties mode for this ExpirationOptions
java.sql.Timestamp	getExpirationTimestamp() Calculate expiration timestamp
int	getInterval() get the expiration interval
int	getMode() get the expiration mode
java.lang.String	toString() Returns a String which describes this expiration setting
void	validate() Validate ExpirationOptions settings

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

USE_DEFAULTS

public static final int USE_DEFAULTS

expiration mode indicating the folder defaults should be used

FILE_NEVER_EXPIRES

public static final int FILE_NEVER_EXPIRES

expiration mode indicating the file never expires

FILE_EXPIRES_IN_N_MINUTES

public static final int FILE_EXPIRES_IN_N_MINUTES

expiration mode indicating the file expires in the specified number of minutes

FILE_EXPIRES_IN_N_DAYS

public static final int FILE_EXPIRES_IN_N_DAYS

expiration mode indicating the file expires in the specified number of days

Constructor Detail

ExpirationOptions

public ExpirationOptions()

Public constructor with no parameters. This indicates that the folder defaults should be used.

ExpirationOptions

public ExpirationOptions(int mode,
                         int interval)

Public constructor which allows mode and interval to be explicitly set

Parameters:

mode - the expiration mode

interval - the expiration interval

Method Detail

getMode

public int getMode()

get the expiration mode

Returns:

expiration mode integer value

getInterval

public int getInterval()

get the expiration interval

Returns:

the expiration interval

toString

public java.lang.String toString()

Returns a String which describes this expiration setting

Overrides:

toString in class java.lang.Object

Returns:

a String which describes this expiration setting

getExpirationModeString

public java.lang.String getExpirationModeString()

Get expiration mode string

Returns:

String which describes this expiration

validate

public void validate()
              throws InvalidParameterException

Validate ExpirationOptions settings

Throws:

InvalidParameterException - if invalid settings

getExpirationTimestamp

public java.sql.Timestamp getExpirationTimestamp()

Calculate expiration timestamp

Returns:

the correct Timestamp value

getExpirationPropertiesMode

public int getExpirationPropertiesMode()

Returns the ExpirationProperties mode for this ExpirationOptions

Returns:

the ExpirationProperties mode for this ExpirationOptions