View Javadoc
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.Date;
25  
26  
27  /**
28   * A class that represents a user action.  The type of action (e.g. play_media) is defined by {@link #getType()}.
29   */
30  public interface UserAction {
31  
32    Long getId();
33  
34    void setId(Long id);
35  
36    String getMediapackageId();
37  
38    void setMediapackageId(String mediapackageId);
39  
40    UserSession getSession();
41  
42    void setSession(UserSession session);
43  
44    int getInpoint();
45  
46    void setInpoint(int inpoint);
47  
48    int getOutpoint();
49  
50    void setOutpoint(int outpoint);
51  
52    int getLength();
53  
54    String getType();
55  
56    void setType(String type);
57  
58    boolean getIsPlaying();
59  
60    void setIsPlaying(boolean isPlaying);
61  
62    Date getCreated();
63  }