Serializablepublic class Priority extends 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 | Description |
|---|---|---|
static class |
Priority.Factory |
| Modifier and Type | Field | Description |
|---|---|---|
static Priority |
HIGH |
High priority.
|
static Priority |
LOW |
Low priority.
|
static Priority |
MEDIUM |
Medium priority.
|
static Priority |
UNDEFINED |
Undefined priority.
|
ACKNOWLEDGED, ACTION, ATTACH, ATTENDEE, BUSYTYPE, 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, PERCENT_COMPLETE, POSTALCODE, PRIORITY, PRODID, RDATE, RECURRENCE_ID, REGION, RELATED_TO, REPEAT, REQUEST_STATUS, RESOURCES, RRULE, SEQUENCE, STATUS, STREET_ADDRESS, SUMMARY, TEL, TRANSP, TRIGGER, TZID, TZNAME, TZOFFSETFROM, TZOFFSETTO, TZURL, UID, URL, VERSION| Constructor | Description |
|---|---|
Priority() |
Default constructor.
|
Priority(int aLevel) |
|
Priority(ParameterList aList,
int aLevel) |
|
Priority(ParameterList aList,
String aValue) |
| Modifier and Type | Method | Description |
|---|---|---|
int |
getLevel() |
|
String |
getValue() |
|
protected PropertyFactory<Priority> |
newFactory() |
Returns a new property factory used to create deep copies.
|
void |
setLevel(int level) |
|
void |
setValue(String aValue) |
Sets the current value of the property.
|
void |
validate() |
Perform validation on a property.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitadd, copy, equals, getName, getParameter, getParameters, getParameters, hashCode, remove, removeAll, replace, setParameters, toStringpublic static final Priority UNDEFINED
public static final Priority HIGH
public static final Priority MEDIUM
public static final Priority LOW
public Priority()
public Priority(ParameterList aList, String aValue)
aList - a list of parameters for this componentaValue - a value string for this componentpublic Priority(int aLevel)
aLevel - an int representation of a priority levelpublic Priority(ParameterList aList, int aLevel)
aList - a list of parameters for this componentaLevel - an int representation of a priority levelpublic final int getLevel()
public void setValue(String aValue)
public final String getValue()
public void setLevel(int level)
level - The level to set.public void validate()
throws ValidationException
Propertyvalidate in class PropertyValidationException - where the property is not in a valid stateprotected PropertyFactory<Priority> newFactory()
PropertynewFactory in class Property