Package net.fortuna.ical4j.agent

Class VFreeBusyUserAgent

java.lang.Object

net.fortuna.ical4j.agent.AbstractUserAgent<VFreeBusy>

net.fortuna.ical4j.agent.VFreeBusyUserAgent

All Implemented Interfaces:

UserAgent<VFreeBusy>

public class VFreeBusyUserAgent
extends AbstractUserAgent<VFreeBusy>

Constructor Summary

Constructors

Constructor	Description
VFreeBusyUserAgent(ProdId prodId, Organizer organizer, UidGenerator uidGenerator)

Method Summary

Modifier and Type	Method	Description
Calendar	add(VFreeBusy component)	Not applicable for this agent implementation.
Calendar	cancel(VFreeBusy... component)	Not applicable for this agent implementation.
Calendar	counter(Calendar request)	Not applicable for this agent implementation.
Calendar	declineCounter(Calendar counter)	Not applicable for this agent implementation.
Calendar	delegate(Calendar request)	Not applicable for this agent implementation.
Calendar	publish(VFreeBusy... component)	3.3.1.
Calendar	refresh(VFreeBusy component)	Not applicable for this agent implementation.
Calendar	reply(Calendar request)	3.3.3.
Calendar	request(VFreeBusy... component)	3.3.2.

Methods inherited from class net.fortuna.ical4j.agent.AbstractUserAgent

getProdId, transform, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

VFreeBusyUserAgent

public VFreeBusyUserAgent(ProdId prodId,
                          Organizer organizer,
                          UidGenerator uidGenerator)

Method Detail

publish

public Calendar publish(VFreeBusy... component)

 3.3.1.  PUBLISH

     The "PUBLISH" method in a "VFREEBUSY" calendar component is used to
     publish busy time data.  The method may be sent from one CU to any
     other.  The purpose of the method is to provide a way to send
     unsolicited busy time data.  That is, the busy time data is not being
     sent as a "REPLY" to the receipt of a "REQUEST" method.

     The "ORGANIZER" property MUST be specified in the busy time
     information.  The value is the CU address of the originator of the
     busy time information.

     The busy time information within the iCalendar object MAY be grouped
     into more than one "VFREEBUSY" calendar component.  This capability
     allows busy time periods to be grouped according to some common
     periodicity, such as a calendar week, month, or year.  In this case,
     each "VFREEBUSY" calendar component MUST include the "ORGANIZER",
     "DTSTART", and "DTEND" properties in order to specify the source of
     the busy time information and the date and time interval over which
     the busy time information covers.
 

Parameters:

component - one or more component objects

Returns:

a calendar object validated to conform to iTIP method PUBLISH

request

public Calendar request(VFreeBusy... component)

 3.3.2.  REQUEST

     The "REQUEST" method in a "VFREEBUSY" calendar component is used to
     ask a "Calendar User" for their busy time information.  The request
     may be for a busy time information bounded by a specific date and
     time interval.

     This message only permits requests for busy time information.  The
     message is sent from a "Calendar User" requesting the busy time
     information of one or more intended recipients.

     If the originator of the "REQUEST" method is not authorized to make a
     busy time request on the recipient's calendar system, then an
     exception message SHOULD be returned in a "REPLY" method, but no busy
     time data need be returned.
 

Parameters:

component - one or more component objects

Returns:

a calendar object validated to conform to iTIP method REQUEST

delegate

public Calendar delegate(Calendar request)

Not applicable for this agent implementation.

Parameters:

request - a calendar implement the iTIP REQUEST method

Returns:

a calendar delegating the request via an iTIP REQUEST method

Throws:

UnsupportedOperationException

reply

public Calendar reply(Calendar request)

 3.3.3.  REPLY

     The "REPLY" method in a "VFREEBUSY" calendar component is used to
     respond to a busy time request.  The method is sent by the recipient
     of a busy time request to the originator of the request.

     The "REPLY" method may also be used to respond to an unsuccessful
     "REQUEST" method.  Depending on the "REQUEST-STATUS" value, no busy
     time information may be returned.
 

Parameters:

request - a calendar request

Returns:

a calendar object validated to conform to iTIP method REPLY

add

public Calendar add(VFreeBusy component)

Not applicable for this agent implementation.

Parameters:

component - a calendar component to add

Returns:

a calendar object validated to conform to iTIP method ADD

Throws:

UnsupportedOperationException

cancel

public Calendar cancel(VFreeBusy... component)

Not applicable for this agent implementation.

Parameters:

component - one or more component objects

Returns:

a calendar object validated to conform to iTIP method CANCEL

Throws:

UnsupportedOperationException

refresh

public Calendar refresh(VFreeBusy component)

Not applicable for this agent implementation.

Parameters:

component - a calendar component to refresh

Returns:

a calendar object validated to conform to iTIP method REFRESH

Throws:

UnsupportedOperationException

counter

public Calendar counter(Calendar request)

Not applicable for this agent implementation.

Parameters:

request - a calendar request to counter

Returns:

a calendar object validated to conform to iTIP method COUNTER

Throws:

UnsupportedOperationException

declineCounter

public Calendar declineCounter(Calendar counter)

Not applicable for this agent implementation.

Parameters:

counter - a counter to a request

Returns:

a calendar object validated to conform to iTIP method DECLINECOUNTER

Throws:

UnsupportedOperationException