org.jasig.schedassist.model
Class VisibleWindow

java.lang.Object
  org.jasig.schedassist.model.VisibleWindow

public final class VisibleWindow
extends Object

Class to represent the IScheduleOwner's preferences for schedule visibility. windowHoursStart defines the minimum amount of time from "now" (in hours) that a IScheduleVisitor is allowed to schedule an appointment. windowWeeksEnd defines the maximum amount of time from "now" (in weeks) that a IScheduleVisitor is allowed to schedule an appointment.

Version:

$Id: VisibleWindow.java 690 2009-05-14 16:57:58Z npblair $

Author:

Nicholas Blair, nblair@doit.wisc.edu

Field Summary

static VisibleWindow

DEFAULT Default value for VisibleWindow is 24 hours (start) and 3 weeks (end).

Method Summary

Date	calculateCurrentWindowEnd() This method uses the current system time and this instance's windowWeeksEnd field to return a Date that represents the timestamp of the end of the Window relative to "now."
Date	calculateCurrentWindowStart() This method uses the current system time and this instance's windowHoursStart field to return a Date that represents the timestamp of the start of the Window relative to "now."
static VisibleWindow	fromKey(String key) Static method to generate a VisibleWindow from it's String storage format.
String	getKey()
int	getWindowHoursStart()
int	getWindowWeeksEnd()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static VisibleWindow DEFAULT

Default value for VisibleWindow is 24 hours (start) and 3 weeks (end).

Method Detail

getKey

public String getKey()

Returns:

the key

getWindowHoursStart

public int getWindowHoursStart()

Returns:

the windowHoursStart

getWindowWeeksEnd

public int getWindowWeeksEnd()

Returns:

the windowWeeksEnd

calculateCurrentWindowStart

public Date calculateCurrentWindowStart()

This method uses the current system time and this instance's windowHoursStart field to return a Date that represents the timestamp of the start of the Window relative to "now."

Returns:

calculateCurrentWindowEnd

public Date calculateCurrentWindowEnd()

This method uses the current system time and this instance's windowWeeksEnd field to return a Date that represents the timestamp of the end of the Window relative to "now."

Returns:

fromKey

public static VisibleWindow fromKey(String key)

Static method to generate a VisibleWindow from it's String storage format. The lone argument must be formatted as follows:

         windowHoursStart,windowWeeksEnd
         

Both values must be integers, separated by a single comma.

Parameters:

key -

Returns:

an appropriate visible window from the key

Throws:

IllegalArgumentException