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.add(new Description("1. Agenda.., 2. Action Items.."));
| Modifier and Type | Class and Description |
|---|---|
| public static class | VJournal.
Default factory. |
| Modifier and Type | Field and Description |
|---|---|
| private static final Map | |
| private static final long |
| Access | Constructor and Description |
|---|---|
| public | |
| public | |
| public | |
| public |
| Modifier and Type | Method and Description |
|---|---|
| public VJournal | copy()
Overrides net. Implements net. Create a (deep) copy of this component. |
| public ComponentList | Returns: Returns the underlying component list.Implements net.
|
| public final Optional | Returns: the optional date-stamp property
Deprecated
use
ChangeManagementPropertyAccessor#getDateTimeStamp()
|
| public final <T extends Temporal> Optional | Returns: The DtStart object representation of the start Date
Deprecated
use
DateTimePropertyAccessor#getDateTimeStart()
Convenience method to pull the DTSTART out of the property list. |
| protected ComponentFactory | newFactory()
Implements abstract net. Returns a new component factory used to create deep copies. |
| public void | setComponentList(ComponentList<Component> components)
Implements net.
|
| public ValidationResult | validate(final boolean
indicates whether to validate the component's properties recurse)Implements abstract net. Perform validation on a component. |
| public ValidationResult | validate(Method
the applicable method method)Overrides net. Performs method-specific ITIP validation. |
| methodValidators | back to summary |
|---|---|
| private static final Map<Method, Validator<VJournal>> methodValidators | |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID Hides net. | |
| VJournal | back to summary |
|---|---|
| public VJournal() Default constructor. | |
| VJournal | back to summary |
|---|---|
| public VJournal(boolean initialise) | |
| VJournal | back to summary |
|---|---|
| public VJournal(final PropertyList properties) Constructor.
| |
| VJournal | back to summary |
|---|---|
| public VJournal(final Temporal start, final String summary) Constructs a new VJOURNAL instance associated with the specified time with the specified summary. | |
| copy | back to summary |
|---|---|
| public VJournal copy() Overrides net. Implements net. Doc from net. Create a (deep) copy of this component. | |
| getComponentList | back to summary |
|---|---|
| public ComponentList Implements net.
| |
| getDateStamp | back to summary |
|---|---|
| public final Optional Deprecated | |
| getStartDate | back to summary |
|---|---|
| public final <T extends Temporal> Optional Deprecated Convenience method to pull the DTSTART out of the property list. | |
| newFactory | back to summary |
|---|---|
| protected ComponentFactory Implements abstract net. Doc from net. Returns a new component factory used to create deep copies.
| |
| setComponentList | back to summary |
|---|---|
| public void setComponentList(ComponentList<Component> components) Implements net.
| |
| validate | back to summary |
|---|---|
| public ValidationResult validate(final boolean recurse) throws ValidationException Implements abstract net. Doc from net. Perform validation on a component.
| |
| validate | back to summary |
|---|---|
| public ValidationResult validate(Method method) throws ValidationException Overrides net. Performs method-specific ITIP validation.
| |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public VJournal | |
| public VJournal | createComponent(PropertyList properties)
Implements net.
|
| Factory | back to summary |
|---|---|
| public Factory() | |
| createComponent | back to summary |
|---|---|
| public VJournal createComponent() Implements net.
| |
| createComponent | back to summary |
|---|---|
| public VJournal createComponent(PropertyList properties) Implements net.
| |