Created: [Apr 6, 2004]
Defines a SEQUENCE iCalendar component property.
4.8.7.4 Sequence Number
Property Name: SEQUENCE
Purpose: This property defines the revision sequence number of the
calendar component within a sequence of revisions.
Value Type: integer
Property Parameters: Non-standard property parameters can be
specified on this property.
Conformance: The property can be specified in "VEVENT", "VTODO" or
"VJOURNAL" calendar component.
Description: When a calendar component is created, its sequence
number is zero (US-ASCII decimal 48). It is monotonically incremented
by the "Organizer's" CUA each time the "Organizer" makes a
significant revision to the calendar component. When the "Organizer"
makes changes to one of the following properties, the sequence number
MUST be incremented:
. "DTSTART"
. "DTEND"
. "DUE"
. "RDATE"
. "RRULE"
. "EXDATE"
. "EXRULE"
. "STATUS"
In addition, changes made by the "Organizer" to other properties can
also force the sequence number to be incremented. The "Organizer" CUA
MUST increment the sequence number when ever it makes changes to
properties in the calendar component that the "Organizer" deems will
jeopardize the validity of the participation status of the
"Attendees". For example, changing the location of a meeting from one
locale to another distant locale could effectively impact the
participation status of the "Attendees".
The "Organizer" includes this property in an iCalendar object that it
sends to an "Attendee" to specify the current version of the calendar
component.
The "Attendee" includes this property in an iCalendar object that it
sends to the "Organizer" to specify the version of the calendar
component that the "Attendee" is referring to.
A change to the sequence number is not the mechanism that an
"Organizer" uses to request a response from the "Attendees". The
"RSVP" parameter on the "ATTENDEE" property is used by the
"Organizer" to indicate that a response from the "Attendees" is
requested.
Format Definition: This property is defined by the following
notation:
seq = "SEQUENCE" seqparam ":" integer CRLF
; Default is "0"
seqparam = *(";" xparam)
Example: The following is an example of this property for a calendar
component that was just created by the "Organizer".
SEQUENCE:0
The following is an example of this property for a calendar component
that has been revised two different times by the "Organizer".
SEQUENCE:2
| Modifier and Type | Class and Description |
|---|---|
| public static class |
| Modifier and Type | Field and Description |
|---|---|
| private int | |
| private static final long |
| Access | Constructor and Description |
|---|---|
| public | |
| public | |
| public | Sequence(final ParameterList
a list of parameters for this component aList, final String a value string for this component aValue)
|
| public | |
| public | Sequence(final ParameterList
a list of parameters for this component aList, final int a sequence number aSequenceNo)
|
| Modifier and Type | Method and Description |
|---|---|
| public int | compareTo(@NotNull Property
the object to be compared. o)Implements java. Compares this object with the specified object for order. |
| public final int | |
| public final String | |
| protected PropertyFactory | newFactory()
Implements abstract net. Returns a new property factory used to create deep copies. |
| public final 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. |
| sequenceNo | back to summary |
|---|---|
| private int sequenceNo | |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID | |
| Sequence | back to summary |
|---|---|
| public Sequence() Default constructor. | |
| Sequence | back to summary |
|---|---|
public Sequence(final String aValue)
| |
| Sequence | back to summary |
|---|---|
public Sequence(final ParameterList aList, final String aValue)
| |
| Sequence | back to summary |
|---|---|
public Sequence(final int aSequenceNo)
| |
| Sequence | back to summary |
|---|---|
public Sequence(final ParameterList aList, final int aSequenceNo)
| |
| compareTo | back to summary |
|---|---|
| public int compareTo(@NotNull Property o) Implements java. Doc from java. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure The implementor must also ensure that the relation is transitive:
Finally, the implementor must ensure that | |
| getSequenceNo | back to summary |
|---|---|
public final int getSequenceNo()
| |
| 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 final 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 Sequence | createProperty(final ParameterList
a list of property parameters parameters, final String a property value value)Implements net.
|
| public Sequence |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID | |
| Factory | back to summary |
|---|---|
| public Factory() | |
| createProperty | back to summary |
|---|---|
| public Sequence createProperty(final ParameterList parameters, final String value) Implements net.
| |
| createProperty | back to summary |
|---|---|
| public Sequence createProperty() Implements net.
| |