public class VJournal extends CalendarComponent
4.6.3 Journal Component
Component Name: VJOURNAL
Purpose: Provide a grouping of component properties that describe a
journal entry.
Formal Definition: A "VJOURNAL" calendar component is defined by the
following notation:
journalc = "BEGIN" ":" "VJOURNAL" CRLF
jourprop
"END" ":" "VJOURNAL" CRLF
jourprop = *(
; the following are optional,
; but MUST NOT occur more than once
class / created / description / dtstart / dtstamp /
last-mod / organizer / recurid / seq / status /
summary / uid / url /
; the following are optional,
; and MAY occur more than once
attach / attendee / categories / comment /
contact / exdate / exrule / related / rdate /
rrule / rstatus / x-prop
)
Example 1 - Creating a journal associated with an event:
DtStart meetingDate = (DtStart) meeting.getProperties().getProperty(
Property.DTSTART);
VJournal minutes = new VJournal(meetingDate.getTime(),
"Progress Meeting - Minutes");
// add timezone information..
TzId tzParam = meetingDate.getParameters().getParmaeter(Parameter.TZID);
minutes.getProperties().getProperty(Property.DTSTART).getParameters().add(
tzParam);
// add description..
minutes.getProperties().add(new Description("1. Agenda.., 2. Action Items.."));
| Constructor and Description |
|---|
VJournal()
Default constructor.
|
VJournal(Date start,
java.lang.String summary)
Constructs a new VJOURNAL instance associated with the specified time with the specified summary.
|
VJournal(PropertyList properties)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
Clazz |
getClassification() |
Created |
getCreated() |
DtStamp |
getDateStamp() |
Description |
getDescription() |
LastModified |
getLastModified() |
Organizer |
getOrganizer() |
RecurrenceId |
getRecurrenceId() |
Sequence |
getSequence() |
DtStart |
getStartDate()
Convenience method to pull the DTSTART out of the property list.
|
Status |
getStatus() |
Summary |
getSummary() |
Uid |
getUid()
Returns the UID property of this component if available.
|
Url |
getUrl() |
void |
validate(boolean recurse)
Perform validation on a component.
|
void |
validateAdd()
Component/Property Presence
------------------- ----------------------------------------------
METHOD 1 MUST be "ADD"
VJOURNAL 1
DESCRIPTION 1 Can be null.
|
void |
validateCancel()
Component/Property Presence
------------------- ---------------------------------------------
METHOD 1 MUST be "CANCEL"
VJOURNAL 1+ All MUST have the same UID
DTSTAMP 1
ORGANIZER 1
SEQUENCE 1
UID 1 MUST be the UID of the original REQUEST
ATTACH 0+
ATTENDEE 0+
CATEGORIES 0 or 1 This property MAY contain a list of values
CLASS 0 or 1
COMMENT 0 or 1
CONTACT 0+
CREATED 0 or 1
DESCRIPTION 0 or 1
DTSTART 0 or 1
EXDATE 0+
EXRULE 0+
LAST-MODIFIED 0 or 1
RDATE 0+
RECURRENCE-ID 0 or 1 only if referring to an instance of a
recurring calendar component.
|
void |
validateCounter()
Apply validation for METHOD=COUNTER.
|
void |
validateDeclineCounter()
Apply validation for METHOD=DECLINE-COUNTER.
|
void |
validatePublish()
Component/Property Presence
------------------- ----------------------------------------------
METHOD 1 MUST be "PUBLISH"
VJOURNAL 1+
DESCRIPTION 1 Can be null.
|
void |
validateRefresh()
Apply validation for METHOD=REFRESH.
|
void |
validateReply()
Apply validation for METHOD=REPLY.
|
void |
validateRequest()
Apply validation for METHOD=REQUEST.
|
calculateRecurrenceSet, copy, equals, getName, getProperties, getProperties, getProperty, hashCode, toString, validate, validatePropertiespublic VJournal()
public VJournal(PropertyList properties)
properties - a list of propertiespublic VJournal(Date start, java.lang.String summary)
start - the date the journal entry is associated withsummary - the journal summarypublic final void validate(boolean recurse)
throws ValidationException
Componentvalidate in class Componentrecurse - indicates whether to validate the component's propertiesValidationException - where the component is not in a valid statepublic void validatePublish()
throws ValidationException
Component/Property Presence
------------------- ----------------------------------------------
METHOD 1 MUST be "PUBLISH"
VJOURNAL 1+
DESCRIPTION 1 Can be null.
DTSTAMP 1
DTSTART 1
ORGANIZER 1
UID 1
ATTACH 0+
CATEGORIES 0 or 1 This property MAY contain a list of values
CLASS 0 or 1
COMMENT 0 or 1
CONTACT 0+
CREATED 0 or 1
EXDATE 0+
EXRULE 0+
LAST-MODIFIED 0 or 1
RDATE 0+
RECURRENCE-ID 0 or 1 MUST only if referring to an instance of a
recurring calendar component. Otherwise
it MUST NOT be present.
RELATED-TO 0+
RRULE 0+
SEQUENCE 0 or 1 MUST echo the original SEQUENCE number.
MUST be present if non-zero. MAY be
present if zero.
STATUS 0 or 1 MAY be one of DRAFT/FINAL/CANCELLED
SUMMARY 0 or 1 Can be null
URL 0 or 1
X-PROPERTY 0+
ATTENDEE 0
VALARM 0+
VTIMEZONE 0+ MUST be present if any date/time refers to
a timezone
X-COMPONENT 0+
VEVENT 0
VFREEBUSY 0
VTODO 0
validatePublish in class CalendarComponentValidationExceptionpublic void validateAdd()
throws ValidationException
Component/Property Presence
------------------- ----------------------------------------------
METHOD 1 MUST be "ADD"
VJOURNAL 1
DESCRIPTION 1 Can be null.
DTSTAMP 1
DTSTART 1
ORGANIZER 1
SEQUENCE 1 MUST be greater than 0
UID 1 MUST match that of the original journal
ATTACH 0+
CATEGORIES 0 or 1 This property MAY contain a list of values
CLASS 0 or 1
COMMENT 0 or 1
CONTACT 0+
CREATED 0 or 1
EXDATE 0+
EXRULE 0+
LAST-MODIFIED 0 or 1
RDATE 0+
RELATED-TO 0+
RRULE 0+
STATUS 0 or 1 MAY be one of DRAFT/FINAL/CANCELLED
SUMMARY 0 or 1 Can be null
URL 0 or 1
X-PROPERTY 0+
ATTENDEE 0
RECURRENCE-ID 0
VALARM 0+
VTIMEZONE 0 or 1 MUST be present if any date/time refers to
a timezone
X-COMPONENT 0+
VEVENT 0
VFREEBUSY 0
VTODO 0
validateAdd in class CalendarComponentValidationExceptionpublic void validateCancel()
throws ValidationException
Component/Property Presence
------------------- ---------------------------------------------
METHOD 1 MUST be "CANCEL"
VJOURNAL 1+ All MUST have the same UID
DTSTAMP 1
ORGANIZER 1
SEQUENCE 1
UID 1 MUST be the UID of the original REQUEST
ATTACH 0+
ATTENDEE 0+
CATEGORIES 0 or 1 This property MAY contain a list of values
CLASS 0 or 1
COMMENT 0 or 1
CONTACT 0+
CREATED 0 or 1
DESCRIPTION 0 or 1
DTSTART 0 or 1
EXDATE 0+
EXRULE 0+
LAST-MODIFIED 0 or 1
RDATE 0+
RECURRENCE-ID 0 or 1 only if referring to an instance of a
recurring calendar component. Otherwise
it MUST NOT be present.
RELATED-TO 0+
RRULE 0+
STATUS 0 or 1 MAY be present, must be "CANCELLED" if
present
SUMMARY 0 or 1
URL 0 or 1
X-PROPERTY 0+
REQUEST-STATUS 0
VTIMEZONE 0+ MUST be present if any date/time refers to
a timezone
X-COMPONENT 0+
VALARM 0
VEVENT 0
VFREEBUSY 0
VTODO 0
validateCancel in class CalendarComponentValidationExceptionpublic void validateCounter()
throws ValidationException
CalendarComponentvalidateCounter in class CalendarComponentValidationExceptionpublic void validateDeclineCounter()
throws ValidationException
CalendarComponentvalidateDeclineCounter in class CalendarComponentValidationExceptionpublic void validateRefresh()
throws ValidationException
CalendarComponentvalidateRefresh in class CalendarComponentValidationExceptionpublic void validateReply()
throws ValidationException
CalendarComponentvalidateReply in class CalendarComponentValidationExceptionpublic void validateRequest()
throws ValidationException
CalendarComponentvalidateRequest in class CalendarComponentValidationExceptionpublic final Clazz getClassification()
public final Created getCreated()
public final Description getDescription()
public final DtStart getStartDate()
public final LastModified getLastModified()
public final Organizer getOrganizer()
public final DtStamp getDateStamp()
public final Sequence getSequence()
public final Status getStatus()
public final Summary getSummary()
public final Url getUrl()
public final RecurrenceId getRecurrenceId()
public final Uid getUid()