biweekly.property
Class RelatedTo

java.lang.Object
  biweekly.property.ICalProperty
      biweekly.property.ValuedProperty<String>
          biweekly.property.TextProperty
              biweekly.property.RelatedTo

public class RelatedTo
extends TextProperty

Defines a relationship between the component that this property belongs to and another component.

Examples:

 RelatedTo relatedTo = new RelatedTo("uid-value");
 

Author:

Michael Angstadt

Specification Reference:

RFC 5545 p.115-6

Field Summary

Fields inherited from class biweekly.property.ValuedProperty

value

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

RelatedTo(String uid)
Creates a related-to property.

Method Summary

RelationshipType	getRelationshipType() Gets the relationship type.
void	setRelationshipType(RelationshipType relationshipType) Sets the relationship type.

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

RelatedTo

public RelatedTo(String uid)

Creates a related-to property.

Parameters:

uid - the value of the Uid property of the component that this property is referencing

Method Detail

getRelationshipType

public RelationshipType getRelationshipType()

Gets the relationship type.

Returns:

the relationship type (e.g. "child") or null if not set

Specification Reference:

RFC 5545 p.25

setRelationshipType

public void setRelationshipType(RelationshipType relationshipType)

Sets the relationship type.

Parameters:

relationshipType - the relationship type (e.g. "child") or null to remove

Specification Reference:

RFC 5545 p.25