net.fortuna.ical4j.model.property
public class FreeBusy extends Property
4.8.2.6 Free/Busy Time Property Name: FREEBUSY Purpose: The property defines one or more free or busy time intervals. Value Type: PERIOD. The date and time values MUST be in an UTC time format. Property Parameters: Non-standard or free/busy time type property parameters can be specified on this property. Conformance: The property can be specified in a "VFREEBUSY" calendar component. Property Parameter: "FBTYPE" and non-standard parameters can be specified on this property. Description: These time periods can be specified as either a start and end date-time or a start date-time and duration. The date and time MUST be a UTC time format. "FREEBUSY" properties within the "VFREEBUSY" calendar component SHOULD be sorted in ascending order, based on start time and then end time, with the earliest periods first. The "FREEBUSY" property can specify more than one value, separated by the COMMA character (US-ASCII decimal 44). In such cases, the "FREEBUSY" property values SHOULD all be of the same "FBTYPE" property parameter type (e.g., all values of a particular "FBTYPE" listed together in a single property). Format Definition: The property is defined by the following notation: freebusy = "FREEBUSY" fbparam ":" fbvalue CRLF fbparam = *( ; the following is optional, ; but MUST NOT occur more than once (";" fbtypeparam) / ; the following is optional, ; and MAY occur more than once (";" xparam) ) fbvalue = period *["," period] ;Time value MUST be in the UTC time format.
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 and Description |
---|
FreeBusy()
Default constructor.
|
FreeBusy(ParameterList aList,
PeriodList pList) |
FreeBusy(ParameterList aList,
String aValue) |
FreeBusy(PeriodList pList) |
FreeBusy(String aValue) |
Modifier and Type | Method and Description |
---|---|
PeriodList |
getPeriods() |
String |
getValue() |
void |
setValue(String aValue)
Sets the current value of the property.
|
void |
validate()
Perform validation on a property.
|
copy, equals, getName, getParameter, getParameters, getParameters, hashCode, isCalendarProperty, toString
public FreeBusy()
public FreeBusy(String aValue) throws ParseException
aValue
- a freebusy valueParseException
- where the specified string is not a valid freebusy valuepublic FreeBusy(ParameterList aList, String aValue) throws ParseException
aList
- a list of parameters for this componentaValue
- a value string for this componentParseException
- when the specified string is not a valid list of periodspublic FreeBusy(PeriodList pList)
pList
- a list of periodspublic FreeBusy(ParameterList aList, PeriodList pList)
aList
- a list of parameters for this componentpList
- a list of periodspublic final void validate() throws ValidationException
validate
in class Property
ValidationException
- where the property is not in a valid statepublic final PeriodList getPeriods()
public final void setValue(String aValue) throws ParseException
setValue
in class Property
aValue
- a string representation of the property valueParseException
- possibly thrown by setting the value of certain propertiesCopyright © 2004-2013 Micronode. All Rights Reserved.