Created: [Apr 6, 2004]
Defines a UID iCalendar component property.
4.8.4.7 Unique Identifier
Property Name: UID
Purpose: This property defines the persistent, globally unique
identifier for the calendar component.
Value Type: TEXT
Property Parameters: Non-standard property parameters can be
specified on this property.
Conformance: The property MUST be specified in the "VEVENT", "VTODO",
"VJOURNAL" or "VFREEBUSY" calendar components.
Description: The UID itself MUST be a globally unique identifier. The
generator of the identifier MUST guarantee that the identifier is
unique. There are several algorithms that can be used to accomplish
this. The identifier is RECOMMENDED to be the identical syntax to the
[RFC 822] addr-spec. A good method to assure uniqueness is to put the
domain name or a domain literal IP address of the host on which the
identifier was created on the right hand side of the "@", and on the
left hand side, put a combination of the current calendar date and
time of day (i.e., formatted in as a DATE-TIME value) along with some
other currently unique (perhaps sequential) identifier available on
the system (for example, a process id number). Using a date/time
value on the left hand side and a domain name or domain literal on
the right hand side makes it possible to guarantee uniqueness since
no two hosts should be using the same domain name or IP address at
the same time. Though other algorithms will work, it is RECOMMENDED
that the right hand side contain some domain identifier (either of
the host itself or otherwise) such that the generator of the message
identifier can guarantee the uniqueness of the left hand side within
the scope of that domain.
This is the method for correlating scheduling messages with the
referenced "VEVENT", "VTODO", or "VJOURNAL" calendar component.
The full range of calendar components specified by a recurrence set
is referenced by referring to just the "UID" property value
corresponding to the calendar component. The "RECURRENCE-ID" property
allows the reference to an individual instance within the recurrence
set.
This property is an important method for group scheduling
applications to match requests with later replies, modifications or
deletion requests. Calendaring and scheduling applications MUST
generate this property in "VEVENT", "VTODO" and "VJOURNAL" calendar
components to assure interoperability with other group scheduling
applications. This identifier is created by the calendar system that
generates an iCalendar object.
Implementations MUST be able to receive and persist values of at
least 255 characters for this property.
Format Definition: The property is defined by the following notation:
uid = "UID" uidparam ":" text CRLF
uidparam = *(";" xparam)
Example: The following is an example of this property:
UID:[email protected]
| Modifier and Type | Class and Description |
|---|---|
| public static class |
| Modifier and Type | Field and Description |
|---|---|
| private static final long | |
| private String |
| Access | Constructor and Description |
|---|---|
| public | |
| public | |
| public | Uid(final ParameterList
a list of parameters for this component aList, final String a value string for this component aValue)
|
| Modifier and Type | Method and Description |
|---|---|
| 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. |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID | |
| value | back to summary |
|---|---|
| private String value | |
| Uid | back to summary |
|---|---|
| public Uid() Default constructor. | |
| Uid | back to summary |
|---|---|
public Uid(final String aValue)
| |
| Uid | back to summary |
|---|---|
public Uid(final ParameterList aList, final String aValue)
| |
| 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 Uid | createProperty(final ParameterList
a list of property parameters parameters, final String a property value value)Implements net.
|
| public Uid |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID | |
| Factory | back to summary |
|---|---|
| public Factory() | |
| createProperty | back to summary |
|---|---|
| public Uid createProperty(final ParameterList parameters, final String value) Implements net.
| |
| createProperty | back to summary |
|---|---|
| public Uid createProperty() Implements net.
| |