com.stratelia.webactiv.calendar.model
Class Priority

java.lang.Object
  com.stratelia.webactiv.calendar.model.Priority

All Implemented Interfaces:

Serializable, Comparable<Priority>

public class Priority
extends Object
implements Serializable, Comparable<Priority>

See Also:

Serialized Form

Field Summary

static int	MAXIMUM_PRIORITY The maximum alloable priority value.
static int	MINIMUM_PRIORITY The minimum allowable priority value.

Constructor Summary

Priority()
This is the default constructor.

Priority(int newval)
The purpose of this method is to create a new priority property with the given initial value.

Method Summary

int	compareTo(Priority other)
static int[]	getAllPriorities()
int	getValue()
void	setValue(int newval) The purpose of this method is to set the value of the priority property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MINIMUM_PRIORITY

public static final int MINIMUM_PRIORITY

The minimum allowable priority value. Please note that this refers to the case where no priority is set. This case happens to be represented by the value 0 which is the lowest integer value allowable.

See Also:

Constant Field Values

MAXIMUM_PRIORITY

public static final int MAXIMUM_PRIORITY

The maximum alloable priority value. Please note that this refers to the highest possible integer value for priority. When interpreting this value it is seen as the lowest priority because the value 1 is the highest priority value.

See Also:

Constant Field Values

Constructor Detail

Priority

public Priority()

This is the default constructor. It is used by Castor. You should probably use the constructor that takes an integer argument in your application code.

Priority

public Priority(int newval)
         throws CalendarException

The purpose of this method is to create a new priority property with the given initial value.

Parameters:

newval - The initial value of the priority property

Throws:

CalendarException

Method Detail

getAllPriorities

public static int[] getAllPriorities()

setValue

public final void setValue(int newval)
                    throws CalendarException

The purpose of this method is to set the value of the priority property.

Parameters:

newval - The new value for the priority property

Throws:

CalendarException

getValue

public int getValue()

compareTo

public int compareTo(Priority other)

Specified by:

compareTo in interface Comparable<Priority>