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
| Modifier and Type | Class and Description |
|---|---|
| public static class |
| Modifier and Type | Field and Description |
|---|---|
| private static final long | |
| private String | |
| public static final String | |
| public static final String | |
| public static final String | |
| public static final String | |
| public static final String | |
| public static final String | |
| public static final String | |
| public static final String |
| Access | Constructor and Description |
|---|---|
| public | |
| public | |
| public | Status(final ParameterList
a list of parameters for this component aList, final String a value string for this component aValue)
|
| Modifier and Type | Method and Description |
|---|---|
| public final String | |
| protected PropertyFactory | newFactory()
Implements abstract net. Returns a new property factory used to create deep copies. |
| public void | setValue(final String
a string representation of the property value aValue)Implements abstract net. Sets the current value of the property. |
| public ValidationResult | validate()
Implements abstract net. Perform validation on a property. |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID | |
| value | back to summary |
|---|---|
| private String value | |
| VALUE_CANCELLED | back to summary |
|---|---|
| public static final String VALUE_CANCELLED | |
| VALUE_COMPLETED | back to summary |
|---|---|
| public static final String VALUE_COMPLETED | |
| VALUE_CONFIRMED | back to summary |
|---|---|
| public static final String VALUE_CONFIRMED | |
| VALUE_DRAFT | back to summary |
|---|---|
| public static final String VALUE_DRAFT | |
| VALUE_FINAL | back to summary |
|---|---|
| public static final String VALUE_FINAL | |
| VALUE_IN_PROCESS | back to summary |
|---|---|
| public static final String VALUE_IN_PROCESS | |
| VALUE_NEEDS_ACTION | back to summary |
|---|---|
| public static final String VALUE_NEEDS_ACTION | |
| VALUE_TENTATIVE | back to summary |
|---|---|
| public static final String VALUE_TENTATIVE | |
| Status | back to summary |
|---|---|
| public Status() Default constructor. | |
| Status | back to summary |
|---|---|
public Status(final String aValue)
| |
| Status | back to summary |
|---|---|
public Status(final ParameterList aList, final String aValue)
| |
| getValue | back to summary |
|---|---|
| public final String getValue() Implements abstract net.
| |
| newFactory | back to summary |
|---|---|
| protected PropertyFactory Implements abstract net. Doc from net. Returns a new property factory used to create deep copies.
| |
| setValue | back to summary |
|---|---|
| public void setValue(final String aValue) Implements abstract net. Doc from net. Sets the current value of the property. | |
| validate | back to summary |
|---|---|
| public ValidationResult validate() throws ValidationException Implements abstract net. Doc from net. Perform validation on a property.
| |
| Modifier and Type | Field and Description |
|---|---|
| private static final long |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public Status | createProperty(final ParameterList
a list of property parameters parameters, final String a property value value)Implements net.
|
| public Status |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID | |
| Factory | back to summary |
|---|---|
| public Factory() | |
| createProperty | back to summary |
|---|---|
| public Status createProperty(final ParameterList parameters, final String value) Implements net.
| |
| createProperty | back to summary |
|---|---|
| public Status createProperty() Implements net.
| |