net.fortuna.ical4j.model.property

Class Priority


public class Priority
extends Property

$Id: Priority.java,v 1.13 2008/12/16 12:34:51 fortuna Exp $ 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
 

Field Summary

static Priority
HIGH
static Priority
LOW
static Priority
MEDIUM
static Priority
UNDEFINED

Constructor Summary

Priority()
Default constructor.
Priority(ParameterList aList, String aValue)
Priority(ParameterList aList, int aLevel)
Priority(int aLevel)

Method Summary

int
getLevel()
String
getValue()
void
setLevel(int level)
void
setValue(String aValue)
void
validate()

Field Details

HIGH

public static final Priority HIGH

LOW

public static final Priority LOW

MEDIUM

public static final Priority MEDIUM

UNDEFINED

public static final Priority UNDEFINED

Constructor Details

Priority

public Priority()
Default constructor.

Priority

public Priority(ParameterList aList,
                String aValue)
Parameters:
aList - a list of parameters for this component
aValue - a value string for this component

Priority

public Priority(ParameterList aList,
                int aLevel)
Parameters:
aList - a list of parameters for this component
aLevel - an int representation of a priority level

Priority

public Priority(int aLevel)
Parameters:
aLevel - an int representation of a priority level

Method Details

getLevel

public final int getLevel()
Returns:
Returns the level.

getValue

public final String getValue()

setLevel

public void setLevel(int level)
Parameters:
level - The level to set.

setValue

public void setValue(String aValue)

validate

public final void validate()
            throws ValidationException