/*
 * Copyright (C) 2020 The Android Open Source Project
 *
 * 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 com.android.server.people.data;

import android.annotation.NonNull;

import java.util.List;
import java.util.Set;

/** The interface for querying the event time distribution and details. */
public interface EventHistory {

    /** Gets the {@link EventIndex} for the specified event type. */
    @NonNull
    EventIndex getEventIndex(@Event.EventType int eventType);

    /** Gets the combined {@link EventIndex} for a set of event types. */
    @NonNull
    EventIndex getEventIndex(Set<Integer> eventTypes);

    /**
     * Returns a {@link List} of {@link Event}s those timestamps are between the specified {@code
     * fromTimestamp}, inclusive, and {@code toTimestamp} exclusive, and match the specified event
     * types.
     *
     * @return a list of matched events in chronological order.
     */
    @NonNull
    List<Event> queryEvents(Set<Integer> eventTypes, long fromTimestamp, long toTimestamp);
}
