Package net.fortuna.ical4j.agent

Class VJournalUserAgent

java.lang.Object

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

net.fortuna.ical4j.agent.VJournalUserAgent

All Implemented Interfaces:

UserAgent<VJournal>

public class VJournalUserAgent
extends AbstractUserAgent<VJournal>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Calendar	add(VJournal component)	3.5.2.
Calendar	cancel(VJournal... component)	3.5.3.
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(VJournal... component)	3.5.1.
Calendar	refresh(VJournal component)	Not applicable for this agent implementation.
Calendar	reply(Calendar request)	Not applicable for this agent implementation.
Calendar	request(VJournal... component)	Not applicable for this agent implementation.

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

VJournalUserAgent

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

Method Detail

publish

public Calendar publish(VJournal... component)

 3.5.1.  PUBLISH

     The "PUBLISH" method in a "VJOURNAL" calendar component has no
     associated response.  It is simply a posting of an iCalendar object
     that may be added to a calendar.  It MUST have an "Organizer".  It
     MUST NOT have "Attendees".  The expected usage is for encapsulating
     an arbitrary journal entry as an iCalendar object.  The "Organizer"
     MAY subsequently update (with another "PUBLISH" method) or cancel
     (with a "CANCEL" method) a previously published journal entry.
 

Parameters:

component - one or more component objects

Returns:

a calendar object validated to conform to iTIP method PUBLISH

request

public Calendar request(VJournal... component)

Not applicable for this agent implementation.

Parameters:

component - one or more component objects

Returns:

a calendar object validated to conform to iTIP method REQUEST

Throws:

UnsupportedOperationException

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)

Not applicable for this agent implementation.

Parameters:

request - a calendar request

Returns:

a calendar object validated to conform to iTIP method REPLY

Throws:

UnsupportedOperationException

add

public Calendar add(VJournal component)

 3.5.2.  ADD

     The "ADD" method allows the "Organizer" to add one or more new
     instances to an existing "VJOURNAL" using a single iTIP message
     without having to send the entire "VJOURNAL" with all the existing
     instance data, as it would have to do if the "REQUEST" method were
     used.

     The "UID" must be that of the existing journal entry.  If the "UID"
     property value in the "ADD" is not found on the recipient's calendar,
     then the recipient MAY treat the "ADD" as a "PUBLISH".

     When handling an "ADD" message, the "Attendee" treats each component
     in the "ADD" message as if it were referenced via an "RDATE" in the
     main component.  There is no response to the "Organizer".
 

Parameters:

component - a calendar component to add

Returns:

a calendar object validated to conform to iTIP method ADD

cancel

public Calendar cancel(VJournal... component)

 3.5.3.  CANCEL

     The "CANCEL" method in a "VJOURNAL" calendar component is used to
     send a cancellation notice of an existing journal entry.  The message
     is sent by the "Organizer" of a journal entry.  For a recurring
     journal entry, either the whole journal entry or instances of a
     journal entry may be cancelled.  To cancel the complete range of a
     recurring journal entry, the "UID" property value for the journal
     entry MUST be specified and a "RECURRENCE-ID" property MUST NOT be
     specified in the "CANCEL" method.  In order to cancel an individual
     instance of the journal entry, the "RECURRENCE-ID" property value for
     the journal entry MUST be specified in the "CANCEL" method.

     There are two options for canceling a sequence of instances of a
     recurring "VJOURNAL" calendar component:

     a.  The "RECURRENCE-ID" property for an instance in the sequence MUST
     be specified with the "RANGE" property parameter value of
     "THISANDFUTURE" to indicate cancellation of the specified
     "VJOURNAL" calendar component and all instances after.

     b.  Individual recurrence instances may be cancelled by specifying
     multiple "VJOURNAL" components each with a "RECURRENCE-ID"
     property corresponding to one of the instances to be cancelled.

     When a "VJOURNAL" is cancelled, the "SEQUENCE" property value MUST be
     incremented as described in Section 2.1.4.
 

Parameters:

component - one or more component objects

Returns:

a calendar object validated to conform to iTIP method CANCEL

refresh

public Calendar refresh(VJournal 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