Created: [Apr 6, 2004]
Defines a PRIORITY iCalendar component property.
4.8.1.9 Priority
Property Name: PRIORITY
Purpose: The property defines the relative priority for a calendar
component.
Value Type: INTEGER
Property Parameters: Non-standard property parameters can be
specified on this property.
Conformance: The property can be specified in a "VEVENT" or "VTODO"
calendar component.
Description: The priority is specified as an integer in the range
zero to nine. A value of zero (US-ASCII decimal 48) specifies an
undefined priority. A value of one (US-ASCII decimal 49) is the
highest priority. A value of two (US-ASCII decimal 50) is the second
highest priority. Subsequent numbers specify a decreasing ordinal
priority. A value of nine (US-ASCII decimal 58) is the lowest
priority.
A CUA with a three-level priority scheme of "HIGH", "MEDIUM" and
"LOW" is mapped into this property such that a property value in the
range of one (US-ASCII decimal 49) to four (US-ASCII decimal 52)
specifies "HIGH" priority. A value of five (US-ASCII decimal 53) is
the normal or "MEDIUM" priority. A value in the range of six (US-
ASCII decimal 54) to nine (US-ASCII decimal 58) is "LOW" priority.
A CUA with a priority schema of "A1", "A2", "A3",
"B1", "B2", ...,
"C3" is mapped into this property such that a property value of one
(US-ASCII decimal 49) specifies "A1", a property value of two (US-
ASCII decimal 50) specifies "A2", a property value of three (US-ASCII
decimal 51) specifies "A3", and so forth up to a property value of 9
(US-ASCII decimal 58) specifies "C3".
Other integer values are reserved for future use.
Within a "VEVENT" calendar component, this property specifies a
priority for the event. This property may be useful when more than
one event is scheduled for a given time period.
Within a "VTODO" calendar component, this property specified a
priority for the to-do. This property is useful in prioritizing
multiple action items for a given time period.
Format Definition: The property is specified by the following
notation:
priority = "PRIORITY" prioparam ":" privalue CRLF
;Default is zero
prioparam = *(";" xparam)
privalue = integer ;Must be in the range [0..9]
; All other values are reserved for future use
The following is an example of a property with the highest priority:
PRIORITY:1
The following is an example of a property with a next highest
priority:
PRIORITY:2
Example: The following is an example of a property with no priority.
This is equivalent to not specifying the "PRIORITY" property:
PRIORITY:0
| Modifier and Type | Class and Description |
|---|---|
| public static class |
| Modifier and Type | Field and Description |
|---|---|
| private int | |
| private static final long | |
| public static final int | |
| public static final int | |
| public static final int | |
| public static final int |
| Access | Constructor and Description |
|---|---|
| public | |
| public | Priority(final ParameterList
a list of parameters for this component aList, final String a value string for this component aValue)
|
| public | |
| public | Priority(final ParameterList
a list of parameters for this component aList, final int an int representation of a priority level aLevel)
|
| Modifier and Type | Method and Description |
|---|---|
| public final int | |
| public final String | |
| protected PropertyFactory | newFactory()
Implements abstract net. Returns a new property factory used to create deep copies. |
| public void | |
| 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. |
| level | back to summary |
|---|---|
| private int level | |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID | |
| VALUE_HIGH | back to summary |
|---|---|
| public static final int VALUE_HIGH | |
| VALUE_LOW | back to summary |
|---|---|
| public static final int VALUE_LOW | |
| VALUE_MEDIUM | back to summary |
|---|---|
| public static final int VALUE_MEDIUM | |
| VALUE_UNDEFINED | back to summary |
|---|---|
| public static final int VALUE_UNDEFINED | |
| Priority | back to summary |
|---|---|
| public Priority() Default constructor. | |
| Priority | back to summary |
|---|---|
public Priority(final ParameterList aList, final String aValue)
| |
| Priority | back to summary |
|---|---|
public Priority(final int aLevel)
| |
| Priority | back to summary |
|---|---|
public Priority(final ParameterList aList, final int aLevel)
| |
| getLevel | back to summary |
|---|---|
public final int getLevel()
| |
| 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.
| |
| setLevel | back to summary |
|---|---|
public void setLevel(final int level)
| |
| 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 Priority | createProperty(final ParameterList
a list of property parameters parameters, final String a property value value)Implements net.
|
| public Priority |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID | |
| Factory | back to summary |
|---|---|
| public Factory() | |
| createProperty | back to summary |
|---|---|
| public Priority createProperty(final ParameterList parameters, final String value) Implements net.
| |
| createProperty | back to summary |
|---|---|
| public Priority createProperty() Implements net.
| |