Serializable
public class Transp extends 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
Modifier and Type | Class | Description |
---|---|---|
static class |
Transp.Factory |
Modifier and Type | Field | Description |
---|---|---|
static Transp |
OPAQUE |
Opaque.
|
static Transp |
TRANSPARENT |
Transparent.
|
ACKNOWLEDGED, ACTION, ATTACH, ATTENDEE, BUSYTYPE, CALSCALE, CATEGORIES, CLASS, COMMENT, COMPLETED, CONTACT, COUNTRY, CREATED, DESCRIPTION, DTEND, DTSTAMP, DTSTART, DUE, DURATION, EXDATE, EXPERIMENTAL_PREFIX, EXRULE, EXTENDED_ADDRESS, FREEBUSY, GEO, LAST_MODIFIED, LOCALITY, LOCATION, LOCATION_TYPE, METHOD, NAME, ORGANIZER, PERCENT_COMPLETE, POSTALCODE, PRIORITY, PRODID, RDATE, RECURRENCE_ID, REGION, RELATED_TO, REPEAT, REQUEST_STATUS, RESOURCES, RRULE, SEQUENCE, STATUS, STREET_ADDRESS, SUMMARY, TEL, TRANSP, TRIGGER, TZID, TZNAME, TZOFFSETFROM, TZOFFSETTO, TZURL, UID, URL, VERSION
Constructor | Description |
---|---|
Transp() |
Default constructor.
|
Transp(String aValue) |
|
Transp(ParameterList aList,
String aValue) |
Modifier and Type | Method | Description |
---|---|---|
String |
getValue() |
|
protected PropertyFactory<Transp> |
newFactory() |
Returns a new property factory used to create deep copies.
|
void |
setValue(String aValue) |
Sets the current value of the property.
|
void |
validate() |
Perform validation on a property.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
add, copy, equals, getName, getParameter, getParameters, getParameters, hashCode, remove, removeAll, replace, setParameters, toString
public static final Transp OPAQUE
public static final Transp TRANSPARENT
public Transp()
public Transp(String aValue)
aValue
- a value string for this componentpublic Transp(ParameterList aList, String aValue)
aList
- a list of parameters for this componentaValue
- a value string for this componentpublic void setValue(String aValue)
public final String getValue()
public void validate() throws ValidationException
Property
validate
in class Property
ValidationException
- where the property is not in a valid stateprotected PropertyFactory<Transp> newFactory()
Property
newFactory
in class Property