Package net.fortuna.ical4j.model.property

Class Method

java.lang.Object

net.fortuna.ical4j.model.Content

net.fortuna.ical4j.model.Property

net.fortuna.ical4j.model.property.Method

All Implemented Interfaces:

Serializable, Comparable<Property>, FluentProperty

public class Method
extends Property

$Id$

Created: [Apr 6, 2004]

Defines a METHOD iCalendar property.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Method.Factory

Field Summary

Fields

Modifier and Type	Field	Description
static final Method	ADD	Add one or more instances to an existing VEVENT, VTODO, or VJOURNAL.
static final Method	CANCEL	Cancel one or more instances of an existing VEVENT, VTODO, or VJOURNAL.
static final Method	COUNTER	The Counter method is used by an "Attendee" to negotiate a change in the calendar entry.
static final Method	DECLINE_COUNTER	Used by the "Organizer" to decline the proposed counter-proprosal.
static final Method	PUBLISH	Used to publish a calendar entry to one or more Calendar Users.
static final Method	REFRESH	The Refresh method is used by an "Attendee" to request the latest version of a calendar entry.
static final Method	REPLY	A Reply is used in response to a Request to convey "Attendee" status to the "Organizer".
static final Method	REQUEST	Used to schedule a calendar entry with other Calendar Users.
static final String	VALUE_ADD
static final String	VALUE_CANCEL
static final String	VALUE_COUNTER
static final String	VALUE_DECLINECOUNTER
static final String	VALUE_PUBLISH
static final String	VALUE_REFRESH
static final String	VALUE_REPLY
static final String	VALUE_REQUEST

Fields inherited from class net.fortuna.ical4j.model.Property

ACKNOWLEDGED, ACTION, ATTACH, ATTENDEE, BUSYTYPE, CALENDAR_ADDRESS, CALSCALE, CATEGORIES, CLASS, COMMENT, COMPLETED, CONTACT, COUNTRY, CREATED, DESCRIPTION, DTEND, DTSTAMP, DTSTART, DUE, DURATION, EXDATE, EXPERIMENTAL_PREFIX, EXRULE, EXTENDED_ADDRESS, FREEBUSY, GEO, LAST_MODIFIED, LOCALITY, LOCATION, LOCATION_TYPE, METHOD, NAME, ORGANIZER, PARTICIPANT_TYPE, PERCENT_COMPLETE, POSTALCODE, PRIORITY, PRODID, PROXIMITY, RDATE, RECURRENCE_ID, REGION, RELATED_TO, REPEAT, REQUEST_STATUS, RESOURCE_TYPE, RESOURCES, RRULE, SEQUENCE, STATUS, STREET_ADDRESS, STRUCTURED_DATA, STYLED_DESCRIPTION, SUMMARY, TEL, TRANSP, TRIGGER, TZID, TZID_ALIAS_OF, TZNAME, TZOFFSETFROM, TZOFFSETTO, TZUNTIL, TZURL, UID, URL, VERSION, XML

Constructor Summary

Constructors

Constructor	Description
Method()	Default constructor.
Method(String aValue)
Method(ParameterList aList, String aValue)

Method Summary

Modifier and Type	Method	Description
final String	getValue()
void	setValue(String aValue)	Sets the current value of the property.
ValidationResult	validate()	Perform validation on a property.

Methods inherited from class net.fortuna.ical4j.model.Property

compareTo, copy, equals, getFluentTarget, getName, getParameter, getParameters, getParameters, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.fortuna.ical4j.model.FluentProperty

withParameter

Field Details

VALUE_PUBLISH

public static final String VALUE_PUBLISH

See Also:

• Constant Field Values

VALUE_REQUEST

public static final String VALUE_REQUEST

See Also:

• Constant Field Values

VALUE_REPLY

public static final String VALUE_REPLY

See Also:

• Constant Field Values

VALUE_ADD

public static final String VALUE_ADD

See Also:

• Constant Field Values

VALUE_CANCEL

public static final String VALUE_CANCEL

See Also:

• Constant Field Values

VALUE_REFRESH

public static final String VALUE_REFRESH

See Also:

• Constant Field Values

VALUE_COUNTER

public static final String VALUE_COUNTER

See Also:

• Constant Field Values

VALUE_DECLINECOUNTER

public static final String VALUE_DECLINECOUNTER

See Also:

• Constant Field Values

PUBLISH

public static final Method PUBLISH

Used to publish a calendar entry to one or more Calendar Users. There is no interactivity between the publisher and any other calendar user. An example might include a baseball team publishing its schedule to the public. [RFC 2446]

REQUEST

public static final Method REQUEST

Used to schedule a calendar entry with other Calendar Users. Requests are interactive in that they require the receiver to respond using the Reply methods. Meeting Requests, Busy Time requests and the assignment of VTODOs to other Calendar Users are all examples. Requests are also used by the "Organizer" to update the status of a calendar entry. [RFC 2446]

REPLY

public static final Method REPLY

A Reply is used in response to a Request to convey "Attendee" status to the "Organizer". Replies are commonly used to respond to meeting and task requests. [RFC2446]

ADD

public static final Method ADD

Add one or more instances to an existing VEVENT, VTODO, or VJOURNAL. [RFC 2446]

CANCEL

public static final Method CANCEL

Cancel one or more instances of an existing VEVENT, VTODO, or VJOURNAL. [RFC 2446]

REFRESH

public static final Method REFRESH

The Refresh method is used by an "Attendee" to request the latest version of a calendar entry. [RFC 2446]

COUNTER

public static final Method COUNTER

The Counter method is used by an "Attendee" to negotiate a change in the calendar entry. Examples include the request to change a proposed Event time or change the due date for a VTODO. [RFC 2446]

DECLINE_COUNTER

public static final Method DECLINE_COUNTER

Used by the "Organizer" to decline the proposed counter-proprosal. [RFC 2446]

Constructor Details

Method

public Method()

Default constructor.

Method

public Method(String aValue)

Parameters:

aValue - a value string for this component

Method

public Method(ParameterList aList,
 String aValue)

Parameters:

aList - a list of parameters for this component

aValue - a value string for this component

Method Details

setValue

public void setValue(String aValue)

Sets the current value of the property.

Specified by:

setValue in class Property

Parameters:

aValue - a string representation of the property value

getValue

public final String getValue()

Specified by:

getValue in class Content

Returns:

the content value

validate

public ValidationResult validate()
                          throws ValidationException

Description copied from class: Property

Perform validation on a property.

Specified by:

validate in class Property

Throws:

ValidationException - where the property is not in a valid state