org.shredzone.commons.pdb.record

Class ScheduleRecord

java.lang.Object

org.shredzone.commons.pdb.record.AbstractRecord

org.shredzone.commons.pdb.record.ScheduleRecord

All Implemented Interfaces:

DatedRecord, Record

public class ScheduleRecord
extends AbstractRecord
implements DatedRecord

An Record implementation for the Calendar PDB.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScheduleRecord.Alarm Defines an Alarm.
static class	ScheduleRecord.Repeat Defines the repetition of a schedule.
static class	ScheduleRecord.ShortDate Contains an immutable date.
static class	ScheduleRecord.ShortTime Contains an immutable time.

Field Summary

Fields inherited from class org.shredzone.commons.pdb.record.AbstractRecord

ATTR_BUSY, ATTR_DELETE, ATTR_DIRTY, ATTR_SECRET

Constructor Summary

Constructors

Constructor and Description
ScheduleRecord(int attribute) Creates a new ScheduleRecord entry.

Method Summary

Modifier and Type	Method and Description
ScheduleRecord.Alarm	getAlarm() Gets the alarm for this entry.
String	getCategory() Gets the category of the schedule.
String	getDescription() Gets the description for this schedule.
ScheduleRecord.ShortTime	getEndTime() Gets the ending time of the schedule.
List<ScheduleRecord.ShortDate>	getExceptions() Gets the exceptions of a repeated schedule.
String	getLocation() Gets the location of the schedule.
String	getNote() Gets an optional note.
Calendar	getRecordDate() Gets the date of this record.
ScheduleRecord.Repeat	getRepeat() Gets the repetition of this schedule.
ScheduleRecord.ShortDate	getSchedule() Gets the scheduled date.
ScheduleRecord.ShortTime	getStartTime() Gets the starting time of the schedule.
void	setAlarm(ScheduleRecord.Alarm alarm)
void	setCategory(String category)
void	setDescription(String description)
void	setEndTime(ScheduleRecord.ShortTime endTime)
void	setLocation(String location)
void	setNote(String note)
void	setRepeat(ScheduleRecord.Repeat repeat)
void	setSchedule(ScheduleRecord.ShortDate schedule)
void	setStartTime(ScheduleRecord.ShortTime startTime)
String	toString()

Methods inherited from class org.shredzone.commons.pdb.record.AbstractRecord

getCategoryIndex, isBusy, isDelete, isDirty, isSecret

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.shredzone.commons.pdb.record.Record

getCategoryIndex, isBusy, isDelete, isDirty, isSecret

Constructor Detail

ScheduleRecord

public ScheduleRecord(int attribute)

Creates a new ScheduleRecord entry.

Parameters:

attribute - Record's attribute

Method Detail

getSchedule

public ScheduleRecord.ShortDate getSchedule()

Gets the scheduled date.

setSchedule

public void setSchedule(ScheduleRecord.ShortDate schedule)

getStartTime

public ScheduleRecord.ShortTime getStartTime()

Gets the starting time of the schedule. May be null if the schedule is for the entire day.

setStartTime

public void setStartTime(ScheduleRecord.ShortTime startTime)

getEndTime

public ScheduleRecord.ShortTime getEndTime()

Gets the ending time of the schedule. May be null. If the ending time is before the starting time, it is related to the next day.

setEndTime

public void setEndTime(ScheduleRecord.ShortTime endTime)

getAlarm

public ScheduleRecord.Alarm getAlarm()

Gets the alarm for this entry. May be null if there is no alarm.

setAlarm

public void setAlarm(ScheduleRecord.Alarm alarm)

getRepeat

public ScheduleRecord.Repeat getRepeat()

Gets the repetition of this schedule. May be null if the schedule does not repeat.

setRepeat

public void setRepeat(ScheduleRecord.Repeat repeat)

getExceptions

public List<ScheduleRecord.ShortDate> getExceptions()

Gets the exceptions of a repeated schedule. Is never null, but may be empty.

getDescription

public String getDescription()

Gets the description for this schedule. May be null.

setDescription

public void setDescription(String description)

getNote

public String getNote()

Gets an optional note. May be null.

setNote

public void setNote(String note)

getLocation

public String getLocation()

Gets the location of the schedule. May be null.

setLocation

public void setLocation(String location)

getCategory

public String getCategory()

Gets the category of the schedule.

setCategory

public void setCategory(String category)

getRecordDate

public Calendar getRecordDate()

Description copied from interface: DatedRecord

Gets the date of this record. Usually this is the creation date. For schedules this is the date of the schedule.

Specified by:

getRecordDate in interface DatedRecord

Returns:

Calendar, or null if this record has no date set.

toString

public String toString()

Overrides:

toString in class Object