net.fortuna.ical4j.model.component

Class VAvailability

java.lang.Object

net.fortuna.ical4j.model.Component

net.fortuna.ical4j.model.component.CalendarComponent

net.fortuna.ical4j.model.component.VAvailability

All Implemented Interfaces:

java.io.Serializable

public class VAvailability
extends CalendarComponent

$Id: VAvailability.java,v 1.5 2009/01/07 10:02:30 fortuna Exp $ [Apr 5, 2004] Defines an iCalendar VAVAILABILITY component.

   Component Name:  VAVAILABILITY

   Purpose:  Provide a grouping of component properties that describe
      the availability associated with a calendar user.

   Format Definition:  A "VAVAILABILITY" calendar component is defined
      by the following notation:

          availabilityc  = "BEGIN" ":" "VAVAILABILITY" CRLF
                           availabilityprop *availablec
                           "END" ":" "VAVAILABILITY" CRLF

          availabilityprop  = *(

                            ; the following are REQUIRED,
                            ; but MUST NOT occur more than once

                            dtstamp / dtstart / uid

                            ; the following are OPTIONAL,
                            ; but MUST NOT occur more than once

                            busytype / created / last-mod /
                            organizer / seq / summary / url /

                            ; either 'dtend' or 'duration' may appear
                            ; in a 'availabilityprop', but 'dtend' and
                            ; 'duration' MUST NOT occur in the same
                            ; 'availabilityprop'

                            dtend / duration /

                            ; the following are OPTIONAL,
                            ; and MAY occur more than once

                            categories / comment / contact / x-prop

                            )


 

See Also:

Serialized Form

Field Summary

Fields inherited from class net.fortuna.ical4j.model.Component

AVAILABLE, BEGIN, END, EXPERIMENTAL_PREFIX, VALARM, VAVAILABILITY, VEVENT, VFREEBUSY, VJOURNAL, VTIMEZONE, VTODO, VVENUE

Constructor Summary

Constructors

Constructor and Description
VAvailability() Default constructor.
VAvailability(PropertyList properties) Constructs a new instance containing the specified properties.
VAvailability(PropertyList properties, ComponentList available) Constructor.

Method Summary

Modifier and Type	Method and Description
ComponentList	getAvailable() Returns the list of available times.
java.lang.String	toString()
void	validate(boolean recurse) Perform validation on a component.
void	validateAdd() Apply validation for METHOD=ADD.
void	validateCancel() Apply validation for METHOD=CANCEL.
void	validateCounter() Apply validation for METHOD=COUNTER.
void	validateDeclineCounter() Apply validation for METHOD=DECLINE-COUNTER.
void	validatePublish() Apply validation for METHOD=PUBLISH.
void	validateRefresh() Apply validation for METHOD=REFRESH.
void	validateReply() Apply validation for METHOD=REPLY.
void	validateRequest() Apply validation for METHOD=REQUEST.

Methods inherited from class net.fortuna.ical4j.model.Component

calculateRecurrenceSet, copy, equals, getName, getProperties, getProperties, getProperty, hashCode, validate, validateProperties

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VAvailability

public VAvailability()

Default constructor.

VAvailability

public VAvailability(PropertyList properties)

Constructs a new instance containing the specified properties.

Parameters:

properties - a list of properties

VAvailability

public VAvailability(PropertyList properties,
                     ComponentList available)

Constructor.

Parameters:

properties - a list of properties

alarms - a list of available components

Method Detail

getAvailable

public final ComponentList getAvailable()

Returns the list of available times.

Returns:

a component list

toString

public final java.lang.String toString()

Overrides:

toString in class Component

See Also:

Object.toString()

validate

public final void validate(boolean recurse)
                    throws ValidationException

Description copied from class: Component

Perform validation on a component.

Specified by:

validate in class Component

Parameters:

recurse - indicates whether to validate the component's properties

Throws:

ValidationException - where the component is not in a valid state

validateAdd

public void validateAdd()
                 throws ValidationException

Description copied from class: CalendarComponent

Apply validation for METHOD=ADD.

Specified by:

validateAdd in class CalendarComponent

Throws:

ValidationException

validateCancel

public void validateCancel()
                    throws ValidationException

Description copied from class: CalendarComponent

Apply validation for METHOD=CANCEL.

Specified by:

validateCancel in class CalendarComponent

Throws:

ValidationException

validateCounter

public void validateCounter()
                     throws ValidationException

Description copied from class: CalendarComponent

Apply validation for METHOD=COUNTER.

Specified by:

validateCounter in class CalendarComponent

Throws:

ValidationException

validateDeclineCounter

public void validateDeclineCounter()
                            throws ValidationException

Description copied from class: CalendarComponent

Apply validation for METHOD=DECLINE-COUNTER.

Specified by:

validateDeclineCounter in class CalendarComponent

Throws:

ValidationException

validatePublish

public void validatePublish()
                     throws ValidationException

Description copied from class: CalendarComponent

Apply validation for METHOD=PUBLISH.

Specified by:

validatePublish in class CalendarComponent

Throws:

ValidationException

validateRefresh

public void validateRefresh()
                     throws ValidationException

Description copied from class: CalendarComponent

Apply validation for METHOD=REFRESH.

Specified by:

validateRefresh in class CalendarComponent

Throws:

ValidationException

validateReply

public void validateReply()
                   throws ValidationException

Description copied from class: CalendarComponent

Apply validation for METHOD=REPLY.

Specified by:

validateReply in class CalendarComponent

Throws:

ValidationException

validateRequest

public void validateRequest()
                     throws ValidationException

Description copied from class: CalendarComponent

Apply validation for METHOD=REQUEST.

Specified by:

validateRequest in class CalendarComponent

Throws:

ValidationException