Package net.fortuna.ical4j.model.property

Class Status

java.lang.Object

net.fortuna.ical4j.model.Content

net.fortuna.ical4j.model.Property

net.fortuna.ical4j.model.property.Status

All Implemented Interfaces:

Serializable, Comparable<Property>, FluentProperty

public class Status
extends Property

$Id$

Created: [Apr 6, 2004]

Defines a STATUS iCalendar component property.

     4.8.1.11 Status

        Property Name: STATUS

        Purpose: This property defines the overall status or confirmation for
        the calendar component.

        Value Type: TEXT

        Property Parameters: Non-standard property parameters can be
        specified on this property.

        Conformance: This property can be specified in "VEVENT", "VTODO" or
        "VJOURNAL" calendar components.

        Description: In a group scheduled calendar component, the property is
        used by the "Organizer" to provide a confirmation of the event to the
        "Attendees". For example in a "VEVENT" calendar component, the
        "Organizer" can indicate that a meeting is tentative, confirmed or
        cancelled. In a "VTODO" calendar component, the "Organizer" can
        indicate that an action item needs action, is completed, is in
        process or being worked on, or has been cancelled. In a "VJOURNAL"
        calendar component, the "Organizer" can indicate that a journal entry
        is draft, final or has been cancelled or removed.

        Format Definition: The property is defined by the following notation:

          status     = "STATUS" statparam] ":" statvalue CRLF

          statparam  = *(";" xparam)

          statvalue  = "TENTATIVE"           ;Indicates event is
                                             ;tentative.
                     / "CONFIRMED"           ;Indicates event is
                                             ;definite.
                     / "CANCELLED"           ;Indicates event was
                                             ;cancelled.
             ;Status values for a "VEVENT"

          statvalue  =/ "NEEDS-ACTION"       ;Indicates to-do needs action.
                     / "COMPLETED"           ;Indicates to-do completed.
                     / "IN-PROCESS"          ;Indicates to-do in process of
                     / "CANCELLED"           ;Indicates to-do was cancelled.
             ;Status values for "VTODO".

          statvalue  =/ "DRAFT"              ;Indicates journal is draft.
                     / "FINAL"               ;Indicates journal is final.
                     / "CANCELLED"           ;Indicates journal is removed.
             ;Status values for "VJOURNAL".

        Example: The following is an example of this property for a "VEVENT"
        calendar component:

          STATUS:TENTATIVE

        The following is an example of this property for a "VTODO" calendar
        component:

          STATUS:NEEDS-ACTION

        The following is an example of this property for a "VJOURNAL"
        calendar component:

          STATUS:DRAFT
 

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Status.Factory

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VALUE_CANCELLED
static final String	VALUE_COMPLETED
static final String	VALUE_CONFIRMED
static final String	VALUE_DRAFT
static final String	VALUE_FINAL
static final String	VALUE_IN_PROCESS
static final String	VALUE_NEEDS_ACTION
static final String	VALUE_TENTATIVE
static final Status	VEVENT_CANCELLED	Cancelled VEVENT status.
static final Status	VEVENT_CONFIRMED	Confirmed VEVENT status.
static final Status	VEVENT_TENTATIVE	Tentative VEVENT status.
static final Status	VJOURNAL_CANCELLED	Cancelled VJOURNAL status.
static final Status	VJOURNAL_DRAFT	Draft VJOURNAL status.
static final Status	VJOURNAL_FINAL	Final VJOURNAL status.
static final Status	VTODO_CANCELLED	Cancelled VTODO status.
static final Status	VTODO_COMPLETED	Completed VTODO status.
static final Status	VTODO_IN_PROCESS	In-process VTODO status.
static final Status	VTODO_NEEDS_ACTION	Tentative VTODO status.

Fields inherited from class net.fortuna.ical4j.model.Property

ACKNOWLEDGED, ACTION, ATTACH, ATTENDEE, BUSYTYPE, CALENDAR_ADDRESS, CALSCALE, CATEGORIES, CLASS, COMMENT, COMPLETED, CONTACT, COUNTRY, CREATED, DESCRIPTION, DTEND, DTSTAMP, DTSTART, DUE, DURATION, EXDATE, EXPERIMENTAL_PREFIX, EXRULE, EXTENDED_ADDRESS, FREEBUSY, GEO, LAST_MODIFIED, LOCALITY, LOCATION, LOCATION_TYPE, METHOD, NAME, ORGANIZER, PARTICIPANT_TYPE, PERCENT_COMPLETE, POSTALCODE, PRIORITY, PRODID, PROXIMITY, RDATE, RECURRENCE_ID, REGION, RELATED_TO, REPEAT, REQUEST_STATUS, RESOURCE_TYPE, RESOURCES, RRULE, SEQUENCE, STATUS, STREET_ADDRESS, STRUCTURED_DATA, STYLED_DESCRIPTION, SUMMARY, TEL, TRANSP, TRIGGER, TZID, TZID_ALIAS_OF, TZNAME, TZOFFSETFROM, TZOFFSETTO, TZUNTIL, TZURL, UID, URL, VERSION, XML

Constructor Summary

Constructors

Constructor	Description
Status()	Default constructor.
Status(String aValue)
Status(ParameterList aList, String aValue)

Method Summary

Modifier and Type	Method	Description
final String	getValue()
void	setValue(String aValue)	Sets the current value of the property.
ValidationResult	validate()	Perform validation on a property.

Methods inherited from class net.fortuna.ical4j.model.Property

compareTo, copy, equals, getFluentTarget, getName, getParameter, getParameters, getParameters, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.fortuna.ical4j.model.FluentProperty

withParameter

Field Details

VALUE_TENTATIVE

public static final String VALUE_TENTATIVE

See Also:

• Constant Field Values

VALUE_CONFIRMED

public static final String VALUE_CONFIRMED

See Also:

• Constant Field Values

VALUE_CANCELLED

public static final String VALUE_CANCELLED

See Also:

• Constant Field Values

VALUE_NEEDS_ACTION

public static final String VALUE_NEEDS_ACTION

See Also:

• Constant Field Values

VALUE_COMPLETED

public static final String VALUE_COMPLETED

See Also:

• Constant Field Values

VALUE_IN_PROCESS

public static final String VALUE_IN_PROCESS

See Also:

• Constant Field Values

VALUE_DRAFT

public static final String VALUE_DRAFT

See Also:

• Constant Field Values

VALUE_FINAL

public static final String VALUE_FINAL

See Also:

• Constant Field Values

VEVENT_TENTATIVE

public static final Status VEVENT_TENTATIVE

Tentative VEVENT status.

VEVENT_CONFIRMED

public static final Status VEVENT_CONFIRMED

Confirmed VEVENT status.

VEVENT_CANCELLED

public static final Status VEVENT_CANCELLED

Cancelled VEVENT status.

VTODO_NEEDS_ACTION

public static final Status VTODO_NEEDS_ACTION

Tentative VTODO status.

VTODO_COMPLETED

public static final Status VTODO_COMPLETED

Completed VTODO status.

VTODO_IN_PROCESS

public static final Status VTODO_IN_PROCESS

In-process VTODO status.

VTODO_CANCELLED

public static final Status VTODO_CANCELLED

Cancelled VTODO status.

VJOURNAL_DRAFT

public static final Status VJOURNAL_DRAFT

Draft VJOURNAL status.

VJOURNAL_FINAL

public static final Status VJOURNAL_FINAL

Final VJOURNAL status.

VJOURNAL_CANCELLED

public static final Status VJOURNAL_CANCELLED

Cancelled VJOURNAL status.

Constructor Details

Status

public Status()

Default constructor.

Status

public Status(String aValue)

Parameters:

aValue - a value string for this component

Status

public Status(ParameterList aList,
 String aValue)

Parameters:

aList - a list of parameters for this component

aValue - a value string for this component

Method Details

setValue

public void setValue(String aValue)

Sets the current value of the property.

Specified by:

setValue in class Property

Parameters:

aValue - a string representation of the property value

getValue

public final String getValue()

Specified by:

getValue in class Content

Returns:

the content value

validate

public ValidationResult validate()
                          throws ValidationException

Description copied from class: Property

Perform validation on a property.

Specified by:

validate in class Property

Throws:

ValidationException - where the property is not in a valid state