ezvcard.types
Class OrgDirectoryType

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

All Implemented Interfaces:

Comparable<VCardType>

public class OrgDirectoryType
extends UriType

Defines a URI representing the person's work place, which can be used to lookup information on the person's co-workers.

 VCard vcard = new VCard();
 OrgDirectoryType orgDirectory = new OrgDirectoryType("http://www.company.com/staff");
 vcard.addOrgDirectory(orgDirectory);
 

vCard property name: ORG-DIRECTORY

vCard versions: 4.0

Author:

Michael Angstadt

See Also:

RFC 6715

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

OrgDirectoryType()

OrgDirectoryType(String uri)

Method Summary

String	getAltId() Gets the ALTID.
Integer	getIndex() Gets the INDEX parameter.
String	getLanguage() Gets the LANGUAGE parameter.
Integer	getPref() Gets the preference value.
VCardVersion[]	getSupportedVersions() Gets the vCard versions that support this type.
String	getType() Gets the TYPE parameter.
void	setAltId(String altId) Sets the ALTID.
void	setIndex(Integer index) Sets the INDEX parameter.
void	setLanguage(String language) Sets the LANGUAGE 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

OrgDirectoryType

public OrgDirectoryType()

OrgDirectoryType

public OrgDirectoryType(String uri)

Parameters:

uri - the URI

Method Detail

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.

getIndex

public Integer getIndex()

Gets the INDEX parameter.

Returns:

the INDEX or null if not set

See Also:

VCardSubTypes.getIndex()

setIndex

public void setIndex(Integer index)

Sets the INDEX parameter.

Parameters:

index - the INDEX or null to remove

See Also:

VCardSubTypes.setIndex(java.lang.Integer)

getType

public String getType()

Gets the TYPE parameter.

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.

Parameters:

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

getLanguage

public String getLanguage()

Gets the LANGUAGE parameter.

Returns:

the language or null if not set

See Also:

VCardSubTypes.getLanguage()

setLanguage

public void setLanguage(String language)

Sets the LANGUAGE parameter.

Parameters:

language - the language or null to remove

See Also:

VCardSubTypes.setLanguage(java.lang.String)

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)