com.cc.framework.ui.model.imp
Class AppointmentImp

java.lang.Object
  com.cc.framework.ui.model.imp.AppointmentImp

All Implemented Interfaces:

Appointment

Direct Known Subclasses:

CheckableAppointmentImp

public class AppointmentImp

extends java.lang.Object

implements Appointment

Appointment definition

Version:

$Revision: 1.15 $

Author:

Harald Schulz

Field Summary

private boolean	allDayEvent This Flag indicates that this is an all day event.
private java.util.Calendar	endTime The End Time.
private java.lang.String	id The Unique Id for this Appointment
private java.lang.String	imageRef Reference to an image for this Appointment Item
private java.lang.String	link Optional Hyperlink
private RecurrencePattern	pattern The recurrence pattern for recurring appointments
private AppointmentPriority	priority Priority
private java.util.Calendar	startTime The Start Time of the Appointment.
private java.lang.String	subject Short description for this Appointment Item
private java.lang.String	text Description Text

Constructor Summary

AppointmentImp()
Creates a simple appointment

AppointmentImp(java.lang.String id, java.lang.String subject, java.util.Calendar startTime, AppointmentPriority priority)
Creates a simple all day event

AppointmentImp(java.lang.String id, java.lang.String subject, java.util.Calendar startTime, java.util.Calendar endTime, AppointmentPriority priority)
Creates a simple appointment

AppointmentImp(java.lang.String id, java.lang.String subject, java.util.Calendar startTime, int duration, AppointmentPriority priority)
Creates a simple appointment

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
AppointmentImp	setAllDayEvent(boolean allDayEvent) Makes this appointment an all day event
void	setEndTime(java.util.Calendar calendar) Sets the appointments end time
AppointmentImp	setImageRef(java.lang.String imageRef) Sets the image reference for this appointment.
AppointmentImp	setLink(java.lang.String string) Sets the hyperlink that should be associated with this appointment.
void	setPriority(AppointmentPriority priority) Sets the appointments priority
AppointmentImp	setRecurrencePattern(RecurrencePattern pattern) Sets the recurrence pattern for recurring appointments
void	setStartTime(java.util.Calendar calendar) Sets the appointments start time
AppointmentImp	setSubject(java.lang.String string) Sets the appointments subject text.
AppointmentImp	setText(java.lang.String string) Sets the long descriptive text for this appointment
void	setUniqueId(java.lang.String id) Sets the unique identifier for this appointment
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

id

private java.lang.String id

The Unique Id for this Appointment

allDayEvent

private boolean allDayEvent

This Flag indicates that this is an all day event.

startTime

private java.util.Calendar startTime

The Start Time of the Appointment. A null value indicates an open beginning

endTime

private java.util.Calendar endTime

The End Time. A null value indicates an open end

priority

private AppointmentPriority priority

Priority

pattern

private RecurrencePattern pattern

The recurrence pattern for recurring appointments

subject

private java.lang.String subject

Short description for this Appointment Item

text

private java.lang.String text

Description Text

link

private java.lang.String link

Optional Hyperlink

imageRef

private java.lang.String imageRef

Reference to an image for this Appointment Item

Constructor Detail

AppointmentImp

public AppointmentImp()

Creates a simple appointment

AppointmentImp

public AppointmentImp(java.lang.String id,
                      java.lang.String subject,
                      java.util.Calendar startTime,
                      java.util.Calendar endTime,
                      AppointmentPriority priority)

Creates a simple appointment

Parameters:

id - The unique Id of this appointment

subject - The Appointments Subject

startTime - Start Time

endTime - End Time or null

priority - Priority

AppointmentImp

public AppointmentImp(java.lang.String id,
                      java.lang.String subject,
                      java.util.Calendar startTime,
                      int duration,
                      AppointmentPriority priority)

Creates a simple appointment

Parameters:

id - The unique Id of this appointment

subject - The Appointments Subject

startTime - Start Time

duration - Duration

priority - Priority

AppointmentImp

public AppointmentImp(java.lang.String id,
                      java.lang.String subject,
                      java.util.Calendar startTime,
                      AppointmentPriority priority)

Creates a simple all day event

Parameters:

id - The unique Id of this appointment

subject - The Appointments Subject

startTime - Start Time

priority - Priority

Method Detail

getPriority

public AppointmentPriority getPriority()

Description copied from interface: Appointment

Returns the Priority of this appointment

Specified by:

getPriority in interface Appointment

Returns:

Priority

See Also:

Appointment.getPriority()

getRecurrencePattern

public RecurrencePattern getRecurrencePattern()

Description copied from interface: Appointment

Returns the Recurrence Pattern for recurring appointments

Specified by:

getRecurrencePattern in interface Appointment

Returns:

RecurrencePattern

See Also:

Appointment.getRecurrencePattern()

getStartTime

public java.util.Calendar getStartTime()

Description copied from interface: Appointment

Returns the starting time of the appointment

Specified by:

getStartTime in interface Appointment

Returns:

starting time

See Also:

Appointment.getStartTime()

getEndTime

public java.util.Calendar getEndTime()

Description copied from interface: Appointment

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.

Specified by:

getEndTime in interface Appointment

Returns:

End Time

See Also:

Appointment.getEndTime()

isRecurring

public boolean isRecurring()

Description copied from interface: Appointment

The isRecurring property indicates whether this appointment is specified as recurring

Specified by:

isRecurring in interface Appointment

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

See Also:

Appointment.isRecurring()

getLink

public java.lang.String getLink()

Description copied from interface: Appointment

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

Specified by:

getLink in interface Appointment

Returns:

Hyperlink or null

See Also:

Appointment.getLink()

getText

public java.lang.String getText()

Description copied from interface: Appointment

Retrieves a long description for this Appointment

Specified by:

getText in interface Appointment

Returns:

Long Description

See Also:

Appointment.getText()

setRecurrencePattern

public AppointmentImp setRecurrencePattern(RecurrencePattern pattern)

Sets the recurrence pattern for recurring appointments

Parameters:

pattern - Recurrence pattern

Returns:

the appointment

getSubject

public java.lang.String getSubject()

Description copied from interface: Appointment

Retrieves a short description for this Appointment

Specified by:

getSubject in interface Appointment

Returns:

Short description

See Also:

Appointment.getSubject()

isAllDayEvent

public boolean isAllDayEvent()

Description copied from interface: Appointment

Checks if this is an all Day Event

Specified by:

isAllDayEvent in interface Appointment

Returns:

true if this is an all day event

See Also:

Appointment.isAllDayEvent()

isMultiDayEvent

public boolean isMultiDayEvent()

Description copied from interface: Appointment

Checks if the appointment spans multiple days

Specified by:

isMultiDayEvent in interface Appointment

Returns:

true if the appointment spans multiple days

See Also:

Appointment.isMultiDayEvent()

getImageRef

public java.lang.String getImageRef()

Description copied from interface: Appointment

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

Specified by:

getImageRef in interface Appointment

Returns:

Image reference

See Also:

Appointment.getImageRef()

getUniqueId

public java.lang.String getUniqueId()

Description copied from interface: Appointment

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

Specified by:

getUniqueId in interface Appointment

Returns:

unique Id

See Also:

Appointment.getUniqueId()

setUniqueId

public void setUniqueId(java.lang.String id)

Sets the unique identifier for this appointment

Parameters:

id - unique identifier

setAllDayEvent

public AppointmentImp setAllDayEvent(boolean allDayEvent)

Makes this appointment an all day event

Parameters:

allDayEvent - true if this is an all day event

Returns:

the appointment object

setImageRef

public AppointmentImp setImageRef(java.lang.String imageRef)

Sets the image reference for this appointment. The image reference will be mapped against the image map of the scheduler control.

Parameters:

imageRef - image for this appointment or null

Returns:

the appointment object

setLink

public AppointmentImp setLink(java.lang.String string)

Sets the hyperlink that should be associated with this appointment.

Parameters:

string - Hyperlink

Returns:

the appointment object

setSubject

public AppointmentImp setSubject(java.lang.String string)

Sets the appointments subject text. The subject will be shown in the scheduler control

Parameters:

string - Subject text

Returns:

the appointment object

setText

public AppointmentImp setText(java.lang.String string)

Sets the long descriptive text for this appointment

Parameters:

string - Text

Returns:

the appointment object

setPriority

public void setPriority(AppointmentPriority priority)

Sets the appointments priority

Parameters:

priority - the priority

setEndTime

public void setEndTime(java.util.Calendar calendar)

Sets the appointments end time

Parameters:

calendar - end time

setStartTime

public void setStartTime(java.util.Calendar calendar)

Sets the appointments start time

Parameters:

calendar - Start Time

match

public boolean match(java.util.Calendar date)

Description copied from interface: Appointment

This method checks if the recurrence pattern matches the given date

Specified by:

match in interface Appointment

Parameters:

date - The date to check

Returns:

true if the pattern matches the Date

See Also:

Appointment.match(java.util.Calendar)

toString

public java.lang.String toString()

See Also:

Object.toString()