net.fortuna.ical4j.model.component
Class VVenue

java.lang.Object
  extended by net.fortuna.ical4j.model.Component
      extended by net.fortuna.ical4j.model.component.CalendarComponent
          extended by net.fortuna.ical4j.model.component.VVenue
All Implemented Interfaces:
java.io.Serializable

public class VVenue
extends CalendarComponent

$Id $ [Apr 5, 2004] Defines an iCalendar VVENUE component.

 4.  Venue Component

    Component Name: "VVENUE"

    Purpose: Provide a grouping of component properties that describe an
    event venue.

    Format Definition: A "VVENUE" calendar component is defined by the
    following notation:
      venuec  = "BEGIN" ":" "VVENUE" CRLF
              venueprop
              "END" ":" "VVENUE" CRLF

      venueprop  = *(

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

                uid

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

                name / description / street-address / extended-address /
                locality / region / country / postal-code / tzid / geo /
                location-type / categories

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

                tel / url
              )

    Description: A "VVENUE" calendar component is a grouping of component
    properties that represent a venue where an event occurs.  This
    extends the "LOCATION" property of "VEVENT" and "TODO" components,
    providing the ability to specify detailed information about the event
    venue.

 

Author:
Ben Fortuna, Mike Douglass
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
VVenue()
          Default constructor.
VVenue(PropertyList properties)
          Constructs a new instance containing the specified properties.
 
Method Summary
 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

VVenue

public VVenue()
Default constructor.


VVenue

public VVenue(PropertyList properties)
Constructs a new instance containing the specified properties.

Parameters:
properties - a list of properties
Method Detail

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


Copyright © 2004-2009 Modularity. All Rights Reserved.