com.cc.framework.ui.model
Interface Appointment

All Known Implementing Classes:

AppointmentImp

public interface Appointment

Appointment Definition

Version:

$Revision: 1.8 $

Author:

Harald Schulz

Method Summary

java.util.Calendar	getEndTime() The EndTime property contains the time at which the appointment is to terminate every time it recurs.
java.lang.String	getImageRef() This method returns the image reference that is assigned to this appointment.
java.lang.String	getLink() Retrieves a optional Hyperlink that can be associated with this appointment.
AppointmentPriority	getPriority() Returns the Priority of this appointment
RecurrencePattern	getRecurrencePattern() Returns the Recurrence Pattern for recurring appointments
java.util.Calendar	getStartTime() Returns the starting time of the appointment
java.lang.String	getSubject() Retrieves a short description for this Appointment
java.lang.String	getText() Retrieves a long description for this Appointment
java.lang.String	getUniqueId() Returns the unique Id or this appointment.
boolean	isAllDayEvent() Checks if this is an all Day Event
boolean	isMultiDayEvent() Checks if the appointment spans multiple days
boolean	isRecurring() The isRecurring property indicates whether this appointment is specified as recurring
boolean	match(java.util.Calendar date) This method checks if the recurrence pattern matches the given date

Method Detail

getUniqueId

public java.lang.String getUniqueId()

Returns the unique Id or this appointment. This is the value the application must use to identify an appointment.

Returns:

unique Id

getStartTime

public java.util.Calendar getStartTime()

Returns the starting time of the appointment

Returns:

starting time

isAllDayEvent

public boolean isAllDayEvent()

Checks if this is an all Day Event

Returns:

true if this is an all day event

isMultiDayEvent

public boolean isMultiDayEvent()

Checks if the appointment spans multiple days

Returns:

true if the appointment spans multiple days

getEndTime

public java.util.Calendar getEndTime()

The EndTime property contains the time at which the appointment is to terminate every time it recurs. EndTime is always valid on a newly created RecurrencePattern object and defaults to the EndTime property of the AppointmentItem object that created this recurrence pattern. The EndTime property ignores seconds and truncates the time component to the minute.

Returns:

End Time

isRecurring

public boolean isRecurring()

The isRecurring property indicates whether this appointment is specified as recurring

Returns:

The isRecurring property contains true if the appointment is recurring and false if it is not. isRecurring defaults to false in a newly created AppointmentItem object

getRecurrencePattern

public RecurrencePattern getRecurrencePattern()

Returns the Recurrence Pattern for recurring appointments

Returns:

RecurrencePattern

getSubject

public java.lang.String getSubject()

Retrieves a short description for this Appointment

Returns:

Short description

getText

public java.lang.String getText()

Retrieves a long description for this Appointment

Returns:

Long Description

getLink

public java.lang.String getLink()

Retrieves a optional Hyperlink that can be associated with this appointment.

Returns:

Hyperlink or null

getPriority

public AppointmentPriority getPriority()

Returns the Priority of this appointment

Returns:

Priority

getImageRef

public java.lang.String getImageRef()

This method returns the image reference that is assigned to this appointment. The concrete image will be resolved with the help of the SchedulerControl's image map

Returns:

Image reference

match

public boolean match(java.util.Calendar date)

This method checks if the recurrence pattern matches the given date

Parameters:

date - The date to check

Returns:

true if the pattern matches the Date