Class VAvailability

  • All Implemented Interfaces:
    Serializable

    public class VAvailability
    extends CalendarComponent
    $Id$ [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
    • Constructor Detail

      • VAvailability

        public VAvailability()
        Default constructor.
      • VAvailability

        public VAvailability​(boolean initialise)
      • 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> available)
        Constructor.
        Parameters:
        properties - a list of properties
        available - a list of available components
    • Method Detail

      • getAvailable

        public final ComponentList<Available> getAvailable()
        Returns the list of available times.
        Returns:
        a component list
      • validate

        public final void validate​(boolean recurse)
                            throws ValidationException
        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
      • getValidator

        protected Validator getValidator​(Method method)
        Specified by:
        getValidator in class CalendarComponent
        Parameters:
        method - a method to validate on
        Returns:
        a validator for the specified method or null if the method is not supported