com.ace.moab.api.reservation
Class ReservationTime

java.lang.Object
  com.ace.moab.api.reservation.ReservationTime

public class ReservationTime
extends java.lang.Object

Author:

scott

Constructor Summary

ReservationTime()

Method Summary

java.lang.String	getDays() Get the days that a weekly reservation should run on
int	getDepth() Get the reservation's frequency depth
com.moab.api.statistics.TimeWindow	getFrequency() Return the frequency (Period) of the standing reservation
java.lang.String	getMoabEndTime() Returns the end time of a reservation in the format that is useful for moab's Standing Reservations.
java.lang.String	getMoabStartTime() Returns the start time of a reservation in the format that is useful for moab's Standing Reservations.
static void	setDayandTime(com.moab.api.scheduler.MoabTime moabTime, java.lang.String text) Set a calendar's Day, Hour, Minute, and Second values from an input String
void	setDays(java.lang.String days) Set the days that a weekly reservation should run on
void	setDepth(int depth) Set the reservation's frequency depth
void	setEndTime(com.moab.api.scheduler.MoabTime endTime) Set the time of day and possibly the day of the week to end the reservation
void	setFrequency(com.moab.api.statistics.TimeWindow frequency) Set the frequency (Period) of the standing reservation
void	setStartTime(com.moab.api.scheduler.MoabTime startTime) Set the time of day and possibly the day of the week to start the reservation
static void	setTimeOfDay(com.moab.api.scheduler.MoabTime moabTime, java.lang.String text) Formats input text into a calendar object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReservationTime

public ReservationTime()

Method Detail

getMoabStartTime

public java.lang.String getMoabStartTime()

Returns the start time of a reservation in the format that is useful for moab's Standing Reservations. This method uses the TimeWindow to determine which format is correct For example, a daily reservation should have a time of the day, but not an actual date to begin.

Returns:

String of the start time in the correct format

getMoabEndTime

public java.lang.String getMoabEndTime()

Returns the end time of a reservation in the format that is useful for moab's Standing Reservations. This method uses the TimeWindow to determine which format is correct For example, a daily reservation should have a time of the day, but not an actual date to begin.

Returns:

String of the end time in the correct format

setTimeOfDay

public static void setTimeOfDay(com.moab.api.scheduler.MoabTime moabTime,
                                java.lang.String text)

Formats input text into a calendar object.

Parameters:

text - text in format HH:MM:SS AM/PM

Calendar - object with correct values set

setDayandTime

public static void setDayandTime(com.moab.api.scheduler.MoabTime moabTime,
                                 java.lang.String text)

Set a calendar's Day, Hour, Minute, and Second values from an input String

Parameters:

text - String in format hh:mm:ss am/pm

moabTime - Calendar object to set correct values

getFrequency

public com.moab.api.statistics.TimeWindow getFrequency()

Return the frequency (Period) of the standing reservation

Returns:

the the frequency (Period) of the standing reservation

setFrequency

public void setFrequency(com.moab.api.statistics.TimeWindow frequency)

Set the frequency (Period) of the standing reservation

Parameters:

frequency - the frequency (Period) of the standing reservation

setStartTime

public void setStartTime(com.moab.api.scheduler.MoabTime startTime)

Set the time of day and possibly the day of the week to start the reservation

Parameters:

startTime - the time of day and possibly the day of the week to start the reservation

setEndTime

public void setEndTime(com.moab.api.scheduler.MoabTime endTime)

Set the time of day and possibly the day of the week to end the reservation

Parameters:

weekEnd - the time of day and possibly the day of the week to end the reservation

getDays

public java.lang.String getDays()

Get the days that a weekly reservation should run on

Returns:

the days that a weekly reservation should run on

setDays

public void setDays(java.lang.String days)

Set the days that a weekly reservation should run on

Parameters:

days - the days that a weekly reservation should run on in a comma delimited list

getDepth

public int getDepth()

Get the reservation's frequency depth

Returns:

the reservation's frequency depth

setDepth

public void setDepth(int depth)

Set the reservation's frequency depth

Parameters:

depth - the reservation's frequency depth