CalendarEvent (eXtreme Distance Learning 1.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES All Classes

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.gotjava.model.calendar
Class CalendarEvent

java.lang.Object
  |
  +--com.gotjava.model.AbstractPersistableObject
        |
        +--com.gotjava.model.calendar.CalendarEvent

All Implemented Interfaces:: com.gotjava.model.PersistableObject, java.io.Serializable

public class CalendarEvent
extends com.gotjava.model.AbstractPersistableObject

JavaBean implementation of a simplified VEVENT object based on the iCalendar specification (RFC2445). For more information see the calsch group documentation at http://www.calsch.org/

Currently only the very basic fields are avaliable. Repeating events are not yet supported and the categories mechanism is not final.

Author:: J Aaron Farr
See Also:: Serialized Form

Constructor Summary

CalendarEvent()


Method Summary

java.lang.String getCategory()
          Event category (see RFC2445 4.8.1.2 ).

java.lang.String getClassification()
          Event classification (see RFC2445 4.8.1.3 ).

java.util.Date getCreationDate()


java.util.Date getDtend()
          Event end time (see RFC2445 4.8.2.2 ).

java.util.Date getDtstart()
          Event start time (see RFC2445 4.8.2.4 )

long getDuration()
          Event duration (see RFC2445 4.8.2.5 )

java.util.Date getLastModified()
          Event last-modified date (see RFC2445 4.8.7.3 )

java.lang.String getLocation()
          Event location, ie- place of occurance.

java.util.Date getModifiedDate()


com.gotjava.model.signon.JLCPUser getOrganizer()
          Event organizer.

int getPriority()
          Event priority (see RFC2445 4.8.1.9 ).

int getSeq()
          Event sequence (see RFC2445 4.8.7.4 ).

java.lang.String getStatus()
          Event status (see RFC2445 4.8.1.11 ).

java.lang.String getSummary()
          Event summary or description (see RFC2445 4.8.1.12 )

java.lang.String getUid()
          Event Unique Identifier (see RFC2445 4.8.4.7 ).

java.lang.String getUrl()
          Event URL.

com.gotjava.model.signon.JLCPUser getUser()


boolean isTransparent()
          Event transparency (see RFC2445 4.8.2.7 ).

void setCategory(java.lang.String category)
          Event category (see RFC2445 4.8.1.2 )

void setClassification(java.lang.String classification)
          Event classification (see RFC2445 4.8.1.3 ).

void setCreationDate(java.util.Date date)


void setDtend(java.util.Date dtend)
          Event end time (see RFC2445 4.8.2.2 )

void setDtstart(java.util.Date dtstart)
          Event start time (see RFC2445 4.8.2.4 )

void setDuration(long duration)
          Event duration (see RFC2445 4.8.2.5 ).

void setLastModified(java.util.Date lastModified)
          Event last-modified date (see RFC2445 4.8.7.3 )

void setLocation(java.lang.String location)
          Event location, ie- place of occurance.

void setModifiedDate(java.util.Date date)


void setOrganizer(com.gotjava.model.signon.JLCPUser organizer)
          Event organizer.

void setPriority(int priority)
          Event priority (see RFC2445 4.8.1.9 ).

void setSeq(int seq)
          Event sequence (see RFC2445 4.8.7.4 ).

void setStatus(java.lang.String status)
          Event status (see RFC2445 4.8.1.11 ).

void setSummary(java.lang.String summary)
          Event summary or description (see RFC2445 4.8.1.12 )

void setTransparent(boolean transparent)
          Event transparency (see RFC2445 4.8.2.7 ).

void setUid(java.lang.String uid)
          Event Unique Identifier (see RFC2445 4.8.4.7 ).

void setUrl(java.lang.String url)
          Event URL.

void setUser(com.gotjava.model.signon.JLCPUser user)


Methods inherited from class com.gotjava.model.AbstractPersistableObject

getId, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

CalendarEvent

public CalendarEvent()

Method Detail

getDtstart

public java.util.Date getDtstart()

Event start time (see RFC2445 4.8.2.4 )

setDtstart

public void setDtstart(java.util.Date dtstart)

Event start time (see RFC2445 4.8.2.4 )

getDtend

public java.util.Date getDtend()

Event end time (see RFC2445 4.8.2.2 ).

setDtend

public void setDtend(java.util.Date dtend)

Event end time (see RFC2445 4.8.2.2 )

Note: the RFC specifies that one can set the end time _or_ the duration, not both. Setting the duration will affect this field.

getClassification

public java.lang.String getClassification()

Event classification (see RFC2445 4.8.1.3 ). Used for access and security classification. The use of this is not yet implemented in JLCP.

setClassification

public void setClassification(java.lang.String classification)

Event classification (see RFC2445 4.8.1.3 ). Used for access and security classification. The use of this is not yet implemented in JLCP.

getLocation

public java.lang.String getLocation()

Event location, ie- place of occurance. (see RFC2445 4.8.1.7 ). This is seperate from locale and i18n.

setLocation

public void setLocation(java.lang.String location)

Event location, ie- place of occurance. (see RFC2445 4.8.1.7 ). This is seperate from locale and i18n.

getOrganizer

public com.gotjava.model.signon.JLCPUser getOrganizer()

Event organizer. (see RFC2445 4.8.4.3 ) This is used for shared events. Personal events do not have an organizer.

setOrganizer

public void setOrganizer(com.gotjava.model.signon.JLCPUser organizer)

Event organizer. (see RFC2445 4.8.4.3 ) This is used for shared events. Personal events do not have an organizer.

getPriority

public int getPriority()

Event priority (see RFC2445 4.8.1.9 ). Should be a value 0-9. Zero is an undefined priority. One is the highest with nine as the lowest priority. Other integer values are reserved.

setPriority

public void setPriority(int priority)

Event priority (see RFC2445 4.8.1.9 ). Should be a value 0-9. Zero is an undefined priority. One is the highest with nine as the lowest priority. Other integer values are reserved.

isTransparent

public boolean isTransparent()

Event transparency (see RFC2445 4.8.2.7 ). If an event is transparent then it will not be flagged as "busy" time.

setTransparent

public void setTransparent(boolean transparent)

Event transparency (see RFC2445 4.8.2.7 ). If an event is transparent then it will not be flagged as "busy" time.

getUrl

public java.lang.String getUrl()

Event URL. (see RFC2445 4.8.4.6 ) Any valid URL associated with the event.

setUrl

public void setUrl(java.lang.String url)

Event URL. (see RFC2445 4.8.4.6 ) Any valid URL associated with the event.

getUid

public java.lang.String getUid()

Event Unique Identifier (see RFC2445 4.8.4.7 ).

[DateInMilliseconds]-[SeqId]-[username]@[hostname]

Example: 1048004868316-5936-user@jlcp.org

setUid

public void setUid(java.lang.String uid)

Event Unique Identifier (see RFC2445 4.8.4.7 ).

[DateInMilliseconds]-[SeqId]-[username]@[hostname]

Example: 1048004868316-5936-user@jlcp.org

This field is set by the CalendarManager.

getLastModified

public java.util.Date getLastModified()

Event last-modified date (see RFC2445 4.8.7.3 )

setLastModified

public void setLastModified(java.util.Date lastModified)

Event last-modified date (see RFC2445 4.8.7.3 )

getSeq

public int getSeq()

Event sequence (see RFC2445 4.8.7.4 ). Used to track modications made to the event

setSeq

public void setSeq(int seq)