org.opentripplanner.model.calendar.CalendarService Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of otp Show documentation

The OpenTripPlanner multimodal journey planning system

There is a newer version: 2.6.0

package org.opentripplanner.model.calendar;

import org.opentripplanner.model.Agency;
import org.opentripplanner.model.FeedScopedId;

import java.util.Set;
import java.util.TimeZone;

public interface CalendarService {

    /**
     * @return the set of all service ids used in the data set
     */
    Set getServiceIds();

    /**
     * @param serviceId the target service id
     * @return the set of all service dates for which the specified service id is
     *         active
     */
    Set getServiceDatesForServiceId(FeedScopedId serviceId);

    /**
     * Determine the set of service ids that are active on the specified service
     * date.
     *
     * @param date the target service date
     * @return the set of service ids that are active on the specified service
     * date
     */
    Set getServiceIdsOnDate(ServiceDate date);

    /**
     * Returns the instantiated {@link TimeZone} for the specified agency id
     *
     * @param agencyId {@link Agency#getId()}
     * @return the time zone for the specified agency, or null if the agency was
     * not found
     */
    TimeZone getTimeZoneForAgencyId(FeedScopedId agencyId);
}