io.milton.http.caldav.CalendarSearchService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of milton-api Show documentation
The newest version!
/*
 * Copyright 2013 McEvoy Software Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.milton.http.caldav;

import io.milton.http.exceptions.BadRequestException;
import io.milton.http.exceptions.NotAuthorizedException;
import io.milton.principal.CalDavPrincipal;
import io.milton.resource.CalendarResource;
import io.milton.resource.ICalResource;
import io.milton.resource.SchedulingResponseItem;

import java.util.AbstractMap;
import java.util.Date;
import java.util.List;

/**
 * Allows searching for calendar items by date range
 * 
 * A default implementation will be used in CaldavProtocol, but you can
 * implement your own to optimise for SQL searching, etc
 *
 * @author brad
 */
public interface CalendarSearchService {

    /**
     * Query the free busy status of the given principal
     * 

     * http://tools.ietf.org/html/rfc6638#section-2.1
     *
     * @param principal
     * @param iCalText
     * @return
     */
    List queryFreeBusy(CalDavPrincipal principal, String iCalText);

    List findCalendarResources(CalendarResource calendar, Date start, Date finish) throws NotAuthorizedException, BadRequestException;

    List findCalendarResources(CalendarResource calendar, Date start, Date finish, AbstractMap.SimpleImmutableEntry propFilter) throws NotAuthorizedException, BadRequestException;

    /**
     * Return a list of events which represent invitations for the given user
     *
     * @param attendee
     * @return
     * @throws NotAuthorizedException
     * @throws BadRequestException
     */
    List findAttendeeResources(CalDavPrincipal attendee) throws NotAuthorizedException, BadRequestException;

    /**
     * Return a CTag which represents the state of all events which repreent
     * invitations for the given user
     *
     * @param attendee
     * @return
     * @throws NotAuthorizedException
     * @throws BadRequestException
     */
    String findAttendeeResourcesCTag(CalDavPrincipal attendee) throws NotAuthorizedException, BadRequestException;

    /**
     * Returns the name of the collection which contains scheduling collections
     * such as inbox and outbox:
     * 
     * Eg For scheduling inbox href like /users/joe/scheduling/inbox this would
     * return scheuduling
     *
     * @return
     */
    String getSchedulingColName();

    /**
     * Returns the name of the scheduling inbox collection, eg 'inbox'
     *
     * @return
     */
    String getSchedulingInboxColName();

    /**
     * Returns the name of the scheduling outbox collection, eg 'outbox'
     *
     * @return
     */
    String getSchedulingOutboxColName();

}