Top Constructors Methods
net.fortuna.ical4j.agent

public Class VJournalUserAgent

extends AbstractUserAgent<VJournal>
Class Inheritance
Imports
net.fortuna.ical4j.model.Calendar, net.fortuna.ical4j.model.component.VJournal, net.fortuna.ical4j.model.property.Organizer, .ProdId, .Uid, java.util.function.Supplier

Constructor Summary

AccessConstructor and Description
public
VJournalUserAgent(ProdId prodId, Organizer organizer, Supplier<Uid> uidGenerator)

Method Summary

Modifier and TypeMethod and Description
public Calendar
add(VJournal
a calendar component to add
component
)

Implements net.fortuna.ical4j.agent.UserAgent.add.

3.5.2.
public Calendar
cancel(VJournal...
one or more component objects
component
)

Implements net.fortuna.ical4j.agent.UserAgent.cancel.

3.5.3.
public Calendar
counter(Calendar
a calendar request to counter
request
)

Implements net.fortuna.ical4j.agent.UserAgent.counter.

Not applicable for this agent implementation.

public Calendar
declineCounter(Calendar
a counter to a request
counter
)

Implements net.fortuna.ical4j.agent.UserAgent.declineCounter.

Not applicable for this agent implementation.

public Calendar
delegate(Calendar
a calendar implement the iTIP REQUEST method
request
)

Implements net.fortuna.ical4j.agent.UserAgent.delegate.

Not applicable for this agent implementation.

public Calendar
publish(VJournal...
one or more component objects
component
)

Implements net.fortuna.ical4j.agent.UserAgent.publish.

3.5.1.
public Calendar
refresh(VJournal
a calendar component to refresh
component
)

Implements net.fortuna.ical4j.agent.UserAgent.refresh.

Not applicable for this agent implementation.

public Calendar
reply(Calendar
a calendar request
request
)

Implements net.fortuna.ical4j.agent.UserAgent.reply.

Not applicable for this agent implementation.

public Calendar
request(VJournal...
one or more component objects
component
)

Implements net.fortuna.ical4j.agent.UserAgent.request.

Not applicable for this agent implementation.

Inherited from net.fortuna.ical4j.agent.AbstractUserAgent:
getProdIdtransformvalidatewrap

Constructor Detail

VJournalUserAgentback to summary
public VJournalUserAgent(ProdId prodId, Organizer organizer, Supplier<Uid> uidGenerator)

Method Detail

addback to summary
public Calendar add(VJournal component)

Implements net.fortuna.ical4j.agent.UserAgent.add.

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:VJournal

Doc from net.fortuna.ical4j.agent.UserAgent.add.

a calendar component to add

Returns:Calendar

Doc from net.fortuna.ical4j.agent.UserAgent.add.

a calendar object validated to conform to iTIP method ADD

Annotations
@Override
cancelback to summary
public Calendar cancel(VJournal... component)

Implements net.fortuna.ical4j.agent.UserAgent.cancel.

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:VJournal[]

Doc from net.fortuna.ical4j.agent.UserAgent.cancel.

one or more component objects

Returns:Calendar

Doc from net.fortuna.ical4j.agent.UserAgent.cancel.

a calendar object validated to conform to iTIP method CANCEL

Annotations
@Override
counterback to summary
public Calendar counter(Calendar request)

Implements net.fortuna.ical4j.agent.UserAgent.counter.

Not applicable for this agent implementation.

Parameters
request:Calendar

Doc from net.fortuna.ical4j.agent.UserAgent.counter.

a calendar request to counter

Returns:Calendar

Doc from net.fortuna.ical4j.agent.UserAgent.counter.

a calendar object validated to conform to iTIP method COUNTER

Annotations
@Override
declineCounterback to summary
public Calendar declineCounter(Calendar counter)

Implements net.fortuna.ical4j.agent.UserAgent.declineCounter.

Not applicable for this agent implementation.

Parameters
counter:Calendar

Doc from net.fortuna.ical4j.agent.UserAgent.declineCounter.

a counter to a request

Returns:Calendar

Doc from net.fortuna.ical4j.agent.UserAgent.declineCounter.

a calendar object validated to conform to iTIP method DECLINECOUNTER

Annotations
@Override
delegateback to summary
public Calendar delegate(Calendar request)

Implements net.fortuna.ical4j.agent.UserAgent.delegate.

Not applicable for this agent implementation.

Parameters
request:Calendar

Doc from net.fortuna.ical4j.agent.UserAgent.delegate.

a calendar implement the iTIP REQUEST method

Returns:Calendar

Doc from net.fortuna.ical4j.agent.UserAgent.delegate.

a calendar delegating the request via an iTIP REQUEST method

Annotations
@Override
publishback to summary
public Calendar publish(VJournal... component)

Implements net.fortuna.ical4j.agent.UserAgent.publish.

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:VJournal[]

Doc from net.fortuna.ical4j.agent.UserAgent.publish.

one or more component objects

Returns:Calendar

Doc from net.fortuna.ical4j.agent.UserAgent.publish.

a calendar object validated to conform to iTIP method PUBLISH

Annotations
@Override
refreshback to summary
public Calendar refresh(VJournal component)

Implements net.fortuna.ical4j.agent.UserAgent.refresh.

Not applicable for this agent implementation.

Parameters
component:VJournal

Doc from net.fortuna.ical4j.agent.UserAgent.refresh.

a calendar component to refresh

Returns:Calendar

Doc from net.fortuna.ical4j.agent.UserAgent.refresh.

a calendar object validated to conform to iTIP method REFRESH

Annotations
@Override
replyback to summary
public Calendar reply(Calendar request)

Implements net.fortuna.ical4j.agent.UserAgent.reply.

Not applicable for this agent implementation.

Parameters
request:Calendar

Doc from net.fortuna.ical4j.agent.UserAgent.reply.

a calendar request

Returns:Calendar

Doc from net.fortuna.ical4j.agent.UserAgent.reply.

a calendar object validated to conform to iTIP method REPLY

Annotations
@Override
requestback to summary
public Calendar request(VJournal... component)

Implements net.fortuna.ical4j.agent.UserAgent.request.

Not applicable for this agent implementation.

Parameters
component:VJournal[]

Doc from net.fortuna.ical4j.agent.UserAgent.request.

one or more component objects

Returns:Calendar

Doc from net.fortuna.ical4j.agent.UserAgent.request.

a calendar object validated to conform to iTIP method REQUEST

Annotations
@Override