1 /*
2 * Licensed to The Apereo Foundation under one or more contributor license
3 * agreements. See the NOTICE file distributed with this work for additional
4 * information regarding copyright ownership.
5 *
6 *
7 * The Apereo Foundation licenses this file to you under the Educational
8 * Community License, Version 2.0 (the "License"); you may not use this file
9 * except in compliance with the License. You may obtain a copy of the License
10 * at:
11 *
12 * http://opensource.org/licenses/ecl2.txt
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
17 * License for the specific language governing permissions and limitations under
18 * the License.
19 *
20 */
21
22 package org.opencastproject.usertracking.api;
23
24 import java.util.Collection;
25 import java.util.List;
26
27 /**
28 * A List of {@link UserAction}s
29 *
30 */
31 public interface UserActionList {
32 /** Set the total number of results for this particular query. **/
33 void setTotal(int total);
34 /** Set the upper limit of the total number of results to return upon request. **/
35 void setLimit(int limit);
36 /** Set the offset * limit to skip over before returning the results. **/
37 void setOffset(int offset);
38 /** Add a single UserAction to this collection. **/
39 void add(UserAction annotation);
40 /** Add a complete Collection of UserActions to this collection. **/
41 void add(Collection<UserAction> userActions);
42 /** Return the total number of possible results for this query. **/
43 int getTotal();
44 /** Return the maximum number of results to collect. **/
45 int getLimit();
46 /** Return the offset of result lists to skip over to get these results. **/
47 int getOffset();
48 /** Return a list of the UserActions in this Collection. **/
49 List<UserAction> getUserActions();
50 }