com.groiss.cal
Interface CalEvent

All Superinterfaces:

java.lang.Cloneable

All Known Implementing Classes:

SimpleEvent

public interface CalEvent
extends java.lang.Cloneable

a calendar event returned by CalInfo

Field Summary

static int	DAILY
static int	MONTHLY
static int	NONE
static int	WEEKLY
static int	YEARLY

Method Summary

java.lang.Object	clone()
int	getCaption() returns the caption to use for this event.
EventType	getEventType()
java.util.Date	getFromDate()
int	getInterval()
java.lang.String	getLocation()
Persistent	getObject() returns the object this CalEvent was initially fetched for
java.util.List<Persistent>	getObjects() the objects, this event belongs to
java.util.Date	getRecEndDate()
int	getRecurrenceType()
java.lang.String	getSubject()
java.lang.String	getText()
java.lang.String	getUID() get the unique identifier for this event
java.util.Date	getUntilDate()
boolean	hasReminder() should a reminder be used?
boolean	isPrivateEvent()
boolean	isWholeDay()
boolean	mayEdit(User user) check if the given user may edit this event
boolean	mayView(User user) check if the given user may view this event
java.lang.String	onClick()

Field Detail

NONE

static final int NONE

See Also:

Constant Field Values

DAILY

static final int DAILY

See Also:

Constant Field Values

WEEKLY

static final int WEEKLY

See Also:

Constant Field Values

MONTHLY

static final int MONTHLY

See Also:

Constant Field Values

YEARLY

static final int YEARLY

See Also:

Constant Field Values

Method Detail

clone

java.lang.Object clone()

getCaption

int getCaption()

returns the caption to use for this event.

Returns:

the caption's index CalInfo.getCaptions()

getFromDate

java.util.Date getFromDate()

Returns:

Returns the fromDate.

getInterval

int getInterval()

Returns:

Returns the interval.

getLocation

java.lang.String getLocation()

Returns:

Returns the location.

getRecEndDate

java.util.Date getRecEndDate()

Returns:

Returns the recEndDate.

getRecurrenceType

int getRecurrenceType()

Returns:

Returns the recurrenceType.

getSubject

java.lang.String getSubject()

Returns:

Returns the subject.

getText

java.lang.String getText()

Returns:

Returns the text.

getUID

java.lang.String getUID()

get the unique identifier for this event

Returns:

the unique identifier for this event

getUntilDate

java.util.Date getUntilDate()

Returns:

Returns the untilDate.

isPrivateEvent

boolean isPrivateEvent()

Returns:

Returns the privateDate.

isWholeDay

boolean isWholeDay()

Returns:

Returns the wholeDay.

onClick

java.lang.String onClick()

Returns:

javascript-code for onclick event

hasReminder

boolean hasReminder()

should a reminder be used?

Returns:

true or false

mayView

boolean mayView(User user)

check if the given user may view this event

Parameters:

user -

Returns:

true or false

mayEdit

boolean mayEdit(User user)

check if the given user may edit this event

Parameters:

user -

Returns:

true or false

getEventType

EventType getEventType()

Returns:

the EventType of this event

getObjects

java.util.List<Persistent> getObjects()

the objects, this event belongs to

Returns:

the objects

getObject

Persistent getObject()

returns the object this CalEvent was initially fetched for

Returns:

the object