org.alfresco.jlan.server.filesys.db

Class RetentionDetails

java.lang.Object

org.alfresco.jlan.server.filesys.db.RetentionDetails

public class RetentionDetails
extends java.lang.Object

File Retention Details Class

Contains the start and end date/times that a file/folder is to be retained. During the retention period the file/folder may not be deleted or modified.

Constructor Summary

Constructors

Constructor and Description
RetentionDetails(int fid, long endTime) Class constructor
RetentionDetails(int fid, long startTime, long endTime) Class constructor

Method Summary

Methods

Modifier and Type	Method and Description
long	getEndTime() Return the end of retention date/time
int	getFileId() Return the file id
long	getStartTime() Return the start of retention date/time
boolean	hasStartTime() Check if a start date/time is set
boolean	isWithinRetentionPeriod(long timeNow) Check if the file is within the retention period
java.lang.String	toString() Return the retention period as a string

Methods inherited from class java.lang.Object

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

Constructor Detail

RetentionDetails

public RetentionDetails(int fid,
                long endTime)

Class constructor

Parameters:

fid - int

endTime - long

RetentionDetails

public RetentionDetails(int fid,
                long startTime,
                long endTime)

Class constructor

Parameters:

fid - int

startTime - long

endTime - long

Method Detail

getFileId

public final int getFileId()

Return the file id

Returns:

int

hasStartTime

public final boolean hasStartTime()

Check if a start date/time is set

Returns:

boolean

getStartTime

public final long getStartTime()

Return the start of retention date/time

Returns:

long

getEndTime

public final long getEndTime()

Return the end of retention date/time

Returns:

long

isWithinRetentionPeriod

public final boolean isWithinRetentionPeriod(long timeNow)

Check if the file is within the retention period

Parameters:

timeNow - long

Returns:

boolean

toString

public java.lang.String toString()

Return the retention period as a string

Overrides:

toString in class java.lang.Object

Returns:

String