net.fortuna.ical4j.model.property
Class Transp
Property
net.fortuna.ical4j.model.property.Transp
public class Transp
extends Property
$Id: Transp.java,v 1.13 2008/12/16 12:34:51 fortuna Exp $
Created: [Apr 6, 2004]
Defines a TRANSP iCalendar component property.
4.8.2.7 Time Transparency
Property Name: TRANSP
Purpose: This property defines whether an event is transparent or not
to busy time searches.
Value Type: TEXT
Property Parameters: Non-standard property parameters can be
specified on this property.
Conformance: This property can be specified once in a "VEVENT"
calendar component.
Description: Time Transparency is the characteristic of an event that
determines whether it appears to consume time on a calendar. Events
that consume actual time for the individual or resource associated
with the calendar SHOULD be recorded as OPAQUE, allowing them to be
detected by free-busy time searches. Other events, which do not take
up the individual's (or resource's) time SHOULD be recorded as
TRANSPARENT, making them invisible to free-busy time searches.
Format Definition: The property is specified by the following
notation:
transp = "TRANSP" tranparam ":" transvalue CRLF
tranparam = *(";" xparam)
transvalue = "OPAQUE" ;Blocks or opaque on busy time searches.
/ "TRANSPARENT" ;Transparent on busy time searches.
;Default value is OPAQUE
Example: The following is an example of this property for an event
that is transparent or does not block on free/busy time searches:
TRANSP:TRANSPARENT
The following is an example of this property for an event that is
opaque or blocks on free/busy time searches:
TRANSP:OPAQUE
Transp() - Default constructor.
|
Transp(ParameterList aList, String aValue)
|
Transp(String aValue)
|
OPAQUE
public static final Transp OPAQUE
TRANSPARENT
public static final Transp TRANSPARENT
Transp
public Transp()
Default constructor.
Transp
public Transp(ParameterList aList,
String aValue)
aList
- a list of parameters for this componentaValue
- a value string for this component
Transp
public Transp(String aValue)
aValue
- a value string for this component
getValue
public final String getValue()
setValue
public void setValue(String aValue)
validate
public final void validate()
throws ValidationException