jfxtras.scene.control.agenda.icalendar.editors.revisors.Reviser Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jfxtras-all Show documentation

Miscellaneous components for JavaFX

The newest version!

package jfxtras.scene.control.agenda.icalendar.editors.revisors;

import java.util.List;

import jfxtras.icalendarfx.VCalendar;
import jfxtras.icalendarfx.properties.calendar.Version;
import jfxtras.icalendarfx.properties.calendar.Method.MethodType;
import jfxtras.scene.control.agenda.icalendar.ICalendarAgenda;
import jfxtras.scene.control.agenda.icalendar.editors.ChangeDialogOption;

/**
 * Interface for the edit behavior of a VComponent
 * 
 * Reviser options from {@link ChangeDialogOption} include:
 * 

 * One
 * 
All
 * 
All and ignore recurrences
 * 
This-and-Future
 * 
This-and-Future and ignore recurrences 
 * 
 * 
 * 
 * @author David Bal
 *
 */
public interface Reviser
{
    /** Revise list of iTIP VCalendar components that represent the changes. */
    List revise();
    
    // TODO - ADD A INITIALIZE METHOD FOR AN ARRAY OF INPUT OBJECT PARAMETERS

    /* EMPTY iTIP VCALENDAR MESSAGES 
     * These convenience factory methods return an empty VCalendar with the
     * necessary properties set for various types if iTIP messages including
     * PUBLISH, REQUEST and CANCEL */
    public static VCalendar emptyPublishiTIPMessage()
    {
        return new VCalendar()
                .withMethod(MethodType.PUBLISH)
                .withProductIdentifier(ICalendarAgenda.DEFAULT_PRODUCT_IDENTIFIER)
                .withVersion(new Version());
    }

    public static VCalendar emptyRequestiTIPMessage()
    {
        return new VCalendar()
                .withMethod(MethodType.REQUEST)
                .withProductIdentifier(ICalendarAgenda.DEFAULT_PRODUCT_IDENTIFIER)
                .withVersion(new Version());
    }
}