Top Description Inners Fields Constructors Methods
net.fortuna.ical4j.model.property

public Class Organizer

extends Property
Class Inheritance
Imports
net.fortuna.ical4j.model.Content, .ParameterList, .Property, .PropertyFactory, net.fortuna.ical4j.util.Strings, .Uris, net.fortuna.ical4j.validate.ValidationException, .ValidationResult, net.fortuna.ical4j.validate.property.RelationshipPropertyValidators, java.net.URI, .URISyntaxException

$Id$

Created: [Apr 6, 2004]

Defines an ORGANIZER iCalendar component property.

    4.8.4.3 Organizer

       Property Name: ORGANIZER

       Purpose: The property defines the organizer for a calendar component.

       Value Type: CAL-ADDRESS

       Property Parameters: Non-standard, language, common name, directory
       entry reference, sent by property parameters can be specified on this
       property.

       Conformance: This property MUST be specified in an iCalendar object
       that specifies a group scheduled calendar entity. This property MUST
       be specified in an iCalendar object that specifies the publication of
       a calendar user's busy time. This property MUST NOT be specified in
       an iCalendar object that specifies only a time zone definition or
       that defines calendar entities that are not group scheduled entities,
       but are entities only on a single user's calendar.

       Description: The property is specified within the "VEVENT", "VTODO",
       "VJOURNAL calendar components to specify the organizer of a group
       scheduled calendar entity. The property is specified within the
       "VFREEBUSY" calendar component to specify the calendar user
       requesting the free or busy time. When publishing a "VFREEBUSY"
       calendar component, the property is used to specify the calendar that
       the published busy time came from.

       The property has the property parameters CN, for specifying the
       common or display name associated with the "Organizer", DIR, for
       specifying a pointer to the directory information associated with the
       "Organizer", SENT-BY, for specifying another calendar user that is
       acting on behalf of the "Organizer". The non-standard parameters may
       also be specified on this property. If the LANGUAGE property
       parameter is specified, the identified language applies to the CN
       parameter value.

       Format Definition: The property is defined by the following notation:

         organizer  = "ORGANIZER" orgparam ":"
                      cal-address CRLF

         orgparam   = *(

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

                    (";" cnparam) / (";" dirparam) / (";" sentbyparam) /
                    (";" languageparam) /

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

                    (";" xparam)

                    )

       Example: The following is an example of this property:

         ORGANIZER;CN=John Smith:MAILTO:[email protected]

       The following is an example of this property with a pointer to the
       directory information associated with the organizer:

         ORGANIZER;CN=JohnSmith;DIR="ldap://host.com:6666/o=3DDC%20Associ
          ates,c=3DUS??(cn=3DJohn%20Smith)":MAILTO:[email protected]

       The following is an example of this property used by another calendar
       user who is acting on behalf of the organizer, with responses
       intended to be sent back to the organizer, not the other calendar
       user:

         ORGANIZER;SENT-BY="MAILTO:[email protected]":
          MAILTO:[email protected]
Author
Ben Fortuna

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
private URI
private static final long
Inherited from net.fortuna.ical4j.model.Property:
ACKNOWLEDGEDACTIONATTACHATTENDEEBUSYTYPECALENDAR_ADDRESSCALSCALECATEGORIESCLASSCOMMENTCOMPLETEDCONTACTCOUNTRYCREATEDDESCRIPTIONDTENDDTSTAMPDTSTARTDUEDURATIONEXDATEEXPERIMENTAL_PREFIXEXRULEEXTENDED_ADDRESSFREEBUSYGEOLAST_MODIFIEDLOCALITYLOCATIONLOCATION_TYPEMETHODNAMEORGANIZERPARTICIPANT_TYPEPERCENT_COMPLETEPOSTALCODEPRIORITYPRODIDPROXIMITYRDATERECURRENCE_IDREGIONRELATED_TOREPEATREQUEST_STATUSRESOURCE_TYPERESOURCESRRULESEQUENCESTATUSSTREET_ADDRESSSTRUCTURED_DATASTYLED_DESCRIPTIONSUMMARYTELTRANSPTRIGGERTZIDTZID_ALIAS_OFTZNAMETZOFFSETFROMTZOFFSETTOTZUNTILTZURLUIDURLVERSIONXML

Constructor Summary

AccessConstructor and Description
public
Organizer()

Default constructor.

public
Organizer(String
an organizer URI
value
)

Constructs a new instance with the specified value.

public
Organizer(final ParameterList
a list of parameters for this component
aList
,
final String
a value string for this component
aValue
)

public
Organizer(final URI
a URI representation of a calendar address
aUri
)

public
Organizer(final ParameterList
a list of parameters for this component
aList
,
final URI
a URI representation of a calendar address
aUri
)

Method Summary

Modifier and TypeMethod and Description
public final URI

Returns:

Returns the calAddress.
getCalAddress
()

public final String
protected PropertyFactory<Organizer>
newFactory()

Implements abstract net.fortuna.ical4j.model.Property.newFactory.

Returns a new property factory used to create deep copies.

public final void
setCalAddress(final URI
The calAddress to set.
calAddress
)

public final void
setValue(final String
a string representation of the property value
aValue
)

Implements abstract net.fortuna.ical4j.model.Property.setValue.

Sets the current value of the property.

public ValidationResult
validate()

Implements abstract net.fortuna.ical4j.model.Property.validate.

Perform validation on a property.

Inherited from net.fortuna.ical4j.model.Property:
addcompareTocopyequalsgetFluentTargetgetNamegetParametergetParametergetParameterListgetParametersgetPrefixgetRequiredParametergetRequiredParameterhashCoderemoveremoveAllreplacesetParameterssetPrefixtoString

Field Detail

calAddressback to summary
private URI calAddress
serialVersionUIDback to summary
private static final long serialVersionUID

Hides net.fortuna.ical4j.model.Property.serialVersionUID.

Constructor Detail

Organizerback to summary
public Organizer()

Default constructor.

Organizerback to summary
public Organizer(String value)

Constructs a new instance with the specified value.

Parameters
value:String

an organizer URI

Organizerback to summary
public Organizer(final ParameterList aList, final String aValue)
Parameters
aList:ParameterList

a list of parameters for this component

aValue:String

a value string for this component

Organizerback to summary
public Organizer(final URI aUri)
Parameters
aUri:URI

a URI representation of a calendar address

Organizerback to summary
public Organizer(final ParameterList aList, final URI aUri)
Parameters
aList:ParameterList

a list of parameters for this component

aUri:URI

a URI representation of a calendar address

Method Detail

getCalAddressback to summary
public final URI getCalAddress()
Returns:URI

Returns the calAddress.

getValueback to summary
public final String getValue()

Implements abstract net.fortuna.ical4j.model.Content.getValue.

Returns:String

Doc from net.fortuna.ical4j.model.Content.getValue.

the content value

Annotations
@Override
newFactoryback to summary
protected PropertyFactory<Organizer> newFactory()

Implements abstract net.fortuna.ical4j.model.Property.newFactory.

Doc from net.fortuna.ical4j.model.Property.newFactory.

Returns a new property factory used to create deep copies.

Returns:PropertyFactory<Organizer>

a property factory instance

Annotations
@Override
setCalAddressback to summary
public final void setCalAddress(final URI calAddress)
Parameters
calAddress:URI

The calAddress to set.

setValueback to summary
public final void setValue(final String aValue)

Implements abstract net.fortuna.ical4j.model.Property.setValue.

Doc from net.fortuna.ical4j.model.Property.setValue.

Sets the current value of the property.

Parameters
aValue:String

a string representation of the property value

Annotations
@Override
validateback to summary
public ValidationResult validate() throws ValidationException

Implements abstract net.fortuna.ical4j.model.Property.validate.

Doc from net.fortuna.ical4j.model.Property.validate.

Perform validation on a property.

Annotations
@Override
Exceptions
ValidationException:
where the property is not in a valid state
net.fortuna.ical4j.model.property back to summary

public Class Organizer.Factory

extends Factory
implements PropertyFactory<Organizer>
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.PropertyFactory, java.io.Serializable

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Organizer
createProperty(final ParameterList
a list of property parameters
parameters
,
final String
a property value
value
)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

public Organizer
Inherited from net.fortuna.ical4j.model.Content.Factory:
supports

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

Factoryback to summary
public Factory()

Method Detail

createPropertyback to summary
public Organizer createProperty(final ParameterList parameters, final String value)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Parameters
parameters:ParameterList

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a list of property parameters

value:String

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a property value

Returns:Organizer

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override
createPropertyback to summary
public Organizer createProperty()

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Returns:Organizer

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override