biweekly.property

Class Organizer

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.ValuedProperty<String>

biweekly.property.TextProperty

biweekly.property.Organizer

public class Organizer
extends TextProperty

This property has different meanings depending on the component it belongs to:

• VEvent - The organizer of the event.
• VTodo - The creator of the to-do task.
• VJournal - The owner of the journal entry.
• VFreeBusy - The person requesting the free/busy time.

Code sample:

 VEvent event = new VEvent();
 
 Organizer organizer = Organizer.email("johndoe@example.com");
 organizer.setCommonName("John Doe");
 event.setOrganizer(organizer);
 

Author:

Michael Angstadt

See Also:

RFC 5545 p.111-2

Field Summary

Fields inherited from class biweekly.property.ValuedProperty

value

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
Organizer(String uri) Creates an organizer property

Method Summary

Methods

Modifier and Type	Method and Description
static Organizer	email(String email) Creates an organizer property using an email address as its value.
String	getCommonName() Gets the display name of the person.
String	getDirectoryEntry() Gets a URI that contains additional information about the person.
String	getLanguage() Gets the language that the common name parameter is written in.
String	getSentBy() Gets a person that is acting on behalf of the person defined in the property.
void	setCommonName(String commonName) Sets the display name of the person.
void	setDirectoryEntry(String directoryEntry) Sets a URI that contains additional information about the person.
void	setLanguage(String language) Sets the language that the common name parameter is written in.
void	setSentBy(String sentBy) Sets a person that is acting on behalf of the person defined in the property.

Methods inherited from class biweekly.property.ValuedProperty

getValue, setValue, validate

Methods inherited from class biweekly.property.ICalProperty

addParameter, getParameter, getParameters, getParameters, removeParameter, setParameter, setParameter, setParameters, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Organizer

public Organizer(String uri)

Creates an organizer property

Parameters:

uri - a URI representing the organizer (typically, an email address, e.g. "mailto:johndoe@example.com")

Method Detail

email

public static Organizer email(String email)

Creates an organizer property using an email address as its value.

Parameters:

email - the email address (e.g. "johndoe@example.com")

Returns:

the property

getSentBy

public String getSentBy()

Description copied from class: ICalProperty

Gets a person that is acting on behalf of the person defined in the property.

Returns:

a URI representing the person (typically, an email URI, e.g. "mailto:janedoe@example.com") or null if not set

See Also:

RFC 5545 p.27

setSentBy

public void setSentBy(String sentBy)

Description copied from class: ICalProperty

Sets a person that is acting on behalf of the person defined in the property.

Parameters:

sentBy - a URI representing the person (typically, an email URI, e.g. "mailto:janedoe@example.com") or null to remove

See Also:

RFC 5545 p.27

getCommonName

public String getCommonName()

Description copied from class: ICalProperty

Gets the display name of the person.

Returns:

the display name (e.g. "John Doe") or null if not set

See Also:

RFC 5545 p.15-6

setCommonName

public void setCommonName(String commonName)

Description copied from class: ICalProperty

Sets the display name of the person.

Parameters:

commonName - the display name (e.g. "John Doe") or null to remove

See Also:

RFC 5545 p.15-6

getDirectoryEntry

public String getDirectoryEntry()

Description copied from class: ICalProperty

Gets a URI that contains additional information about the person.

Returns:

the URI (e.g. an LDAP URI) or null if not set

See Also:

RFC 5545 p.18

setDirectoryEntry

public void setDirectoryEntry(String directoryEntry)

Description copied from class: ICalProperty

Sets a URI that contains additional information about the person.

Parameters:

directoryEntry - the URI (e.g. an LDAP URI) or null to remove

See Also:

RFC 5545 p.18

getLanguage

public String getLanguage()

Gets the language that the common name parameter is written in.

Returns:

the language (e.g. "en" for English) or null if not set

See Also:

RFC 5545 p.21

setLanguage

public void setLanguage(String language)

Sets the language that the common name parameter is written in.

Parameters:

language - the language (e.g. "en" for English) or null to remove

See Also:

RFC 5545 p.21