ezvcard.types
Class CalendarRequestUriType

java.lang.Object
  ezvcard.types.VCardType
      ezvcard.types.TextType
          ezvcard.types.UriType
              ezvcard.types.CalendarRequestUriType

All Implemented Interfaces:

Comparable<VCardType>

public class CalendarRequestUriType
extends UriType

A URL to use for sending a scheduling request to the person's calendar.

 VCard vcard = new VCard();
 CalendarRequestUriType caladruri = new CalendarRequestUriType("mailto:janedoe@ibm.com");
 caladruri.setPref(1);
 vcard.addCalendarRequestUri(caladruri);
 caladruri = new CalendarRequestUriType("http://www.ibm.com/janedoe/calendar");
 caladruri.setPref(2);
 vcard.addCalendarRequestUri(caladruri);
 

vCard property name: CALADRURI

vCard versions: 4.0

Author:

Michael Angstadt

Field Summary

static String

NAME

Fields inherited from class ezvcard.types.TextType

value

Fields inherited from class ezvcard.types.VCardType

group, subTypes, typeName

Constructor Summary

CalendarRequestUriType()

CalendarRequestUriType(String uri)

Method Summary

void	addPid(int localId, int clientPidMapRef) Adds a PID value.
String	getAltId() Gets the ALTID.
String	getMediaType() Gets the MEDIATYPE parameter.
List<Integer[]>	getPids() Gets all PID parameter values.
Integer	getPref() Gets the preference value.
VCardVersion[]	getSupportedVersions() Gets the vCard versions that support this type.
String	getType() Gets the TYPE parameter.
void	removePids() Removes all PID values.
void	setAltId(String altId) Sets the ALTID.
void	setMediaType(String mediaType) Sets the MEDIATYPE parameter.
void	setPref(Integer pref) Sets the preference value.
void	setType(String type) Sets the TYPE parameter.

Methods inherited from class ezvcard.types.UriType

doMarshalXml, doUnmarshalHtml, doUnmarshalXml

Methods inherited from class ezvcard.types.TextType

doMarshalText, doUnmarshalText, getValue, setValue

Methods inherited from class ezvcard.types.VCardType

compareTo, doMarshalSubTypes, getGroup, getQName, getSubTypes, getTypeName, marshalSubTypes, marshalText, marshalXml, setGroup, unmarshalHtml, unmarshalText, unmarshalXml

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

CalendarRequestUriType

public CalendarRequestUriType()

CalendarRequestUriType

public CalendarRequestUriType(String uri)

Parameters:

uri - the calendar request URI

Method Detail

getMediaType

public String getMediaType()

Gets the MEDIATYPE parameter.

vCard versions: 4.0

Returns:

the media type or null if not set

setMediaType

public void setMediaType(String mediaType)

Sets the MEDIATYPE parameter.

vCard versions: 4.0

Parameters:

mediaType - the media type or null to remove

getPids

public List<Integer[]> getPids()

Gets all PID parameter values.

vCard versions: 4.0

Returns:

the PID values or empty set if there are none

See Also:

VCardSubTypes.getPids()

addPid

public void addPid(int localId,
                   int clientPidMapRef)

Adds a PID value.

vCard versions: 4.0

Parameters:

localId - the local ID

clientPidMapRef - the ID used to reference the property's globally unique identifier in the CLIENTPIDMAP property.

See Also:

VCardSubTypes.addPid(int, int)

removePids

public void removePids()

Removes all PID values.

vCard versions: 4.0

See Also:

VCardSubTypes.removePids()

getPref

public Integer getPref()

Gets the preference value.

vCard versions: 4.0

Returns:

the preference value or null if it doesn't exist

See Also:

VCardSubTypes.getPref()

setPref

public void setPref(Integer pref)

Sets the preference value.

vCard versions: 4.0

Parameters:

pref - the preference value or null to remove

See Also:

VCardSubTypes.setPref(java.lang.Integer)

getAltId

public String getAltId()

Gets the ALTID.

vCard versions: 4.0

Returns:

the ALTID or null if it doesn't exist

See Also:

VCardSubTypes.getAltId()

setAltId

public void setAltId(String altId)

Sets the ALTID.

vCard versions: 4.0

Parameters:

altId - the ALTID or null to remove

See Also:

VCardSubTypes.setAltId(java.lang.String)

getType

public String getType()

Gets the TYPE parameter.

vCard versions: 4.0

Returns:

the TYPE value (typically, this will be either "work" or "home") or null if it doesn't exist

setType

public void setType(String type)

Sets the TYPE parameter.

vCard versions: 4.0

Parameters:

type - the TYPE value (this should be either "work" or "home") or null to remove

getSupportedVersions

public VCardVersion[] getSupportedVersions()

Description copied from class: VCardType

Gets the vCard versions that support this type.

Overrides:

getSupportedVersions in class VCardType

Returns:

the vCard versions that support this type.