edu.cmu.andrew.icalendar
Interface Agenda

All Known Implementing Classes:

AbstractAgenda

public interface Agenda

Method Summary

String	getCalid() Returns the canonical name of this agenda.
String	getCN() Returns the canonical human friendly name of this agenda.
Date	getCreated() Return the time when this agenda was created.
List	getEvents() Returns the set of events referred to by this agenda.
List	getEventsByDate(Date startdate, Date enddate) Returns the set of events referred to by this agenda, narrowed by the specified date range.
AgendaType	getType() Returns the type of this agenda.
Writer	outputEmptyAgenda(Writer w) Outputs an iCalendar object to the specified writer.
Writer	outputICalendar(Writer writer) Outputs an iCalendar object to the specified writer.
Writer	outputICalendar(Writer w, Date start, Date end) Outputs an iCalendar object to the specified writer.

Method Detail

getCalid

public String getCalid()

Returns the canonical name of this agenda.

getCN

public String getCN()

Returns the canonical human friendly name of this agenda.

getType

public AgendaType getType()

Returns the type of this agenda.

getEvents

public List getEvents()

Returns the set of events referred to by this agenda.

getEventsByDate

public List getEventsByDate(Date startdate,
                            Date enddate)

Returns the set of events referred to by this agenda, narrowed by the specified date range.

outputICalendar

public Writer outputICalendar(Writer writer)
                       throws IOException

Outputs an iCalendar object to the specified writer. This outputs an ICalendar object containing all of the events in the agenda.

Parameters:

writer - where to output the ICalendar object

Returns:

the writer after output

getCreated

public Date getCreated()

Return the time when this agenda was created.

outputICalendar

public Writer outputICalendar(Writer w,
                              Date start,
                              Date end)
                       throws IOException

Outputs an iCalendar object to the specified writer. This outputs an ICalendar object containing the requested date subset of this agenda.

Parameters:

w - where output should go

start - when to start

end - when to end

outputEmptyAgenda

public Writer outputEmptyAgenda(Writer w)
                         throws IOException

Outputs an iCalendar object to the specified writer. This contains no events.

Parameters:

w - where the output should go

Returns:

the writer after output