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 package org.opencastproject.assetmanager.api.query;
22
23 import org.opencastproject.assetmanager.api.Property;
24 import org.opencastproject.assetmanager.api.Snapshot;
25
26 import java.util.List;
27 import java.util.Optional;
28
29 /**
30 * The result of a {@link ASelectQuery}. Each record represents a matching
31 * snapshot of a media package. Its purpose is to group the various data that is
32 * associated with a media package and to support their partial loading.
33 */
34 public interface ARecord {
35 /** Get the snapshot ID. This is from the underlying DTO, and thus may be null. */
36 long getSnapshotId();
37 /** Get the media package ID. */
38 String getMediaPackageId();
39
40 /**
41 * Get all properties associated with an episode. If the stream contains any
42 * properties also depends on the query specification. If it has not been
43 * specified to fetch properties the stream is definitely empty.
44 * <p>
45 * Please note that properties are not versioned but stored per episode.
46 */
47 List<Property> getProperties();
48
49 /** Get the snapshot or return none if it has not been specified to fetch it. */
50 Optional<Snapshot> getSnapshot();
51 }