1 /*
2  * Copyright (C) 2020 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.android.server.people.data;
18 
19 import android.annotation.NonNull;
20 
21 import java.util.List;
22 import java.util.Set;
23 
24 /** The interface for querying the event time distribution and details. */
25 public interface EventHistory {
26 
27     /** Gets the {@link EventIndex} for the specified event type. */
28     @NonNull
getEventIndex(@vent.EventType int eventType)29     EventIndex getEventIndex(@Event.EventType int eventType);
30 
31     /** Gets the combined {@link EventIndex} for a set of event types. */
32     @NonNull
getEventIndex(Set<Integer> eventTypes)33     EventIndex getEventIndex(Set<Integer> eventTypes);
34 
35     /**
36      * Returns a {@link List} of {@link Event}s those timestamps are between the specified {@code
37      * fromTimestamp}, inclusive, and {@code toTimestamp} exclusive, and match the specified event
38      * types.
39      *
40      * @return a list of matched events in chronological order.
41      */
42     @NonNull
queryEvents(Set<Integer> eventTypes, long fromTimestamp, long toTimestamp)43     List<Event> queryEvents(Set<Integer> eventTypes, long fromTimestamp, long toTimestamp);
44 }
45