| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| DynamicReportSource |
|
| 0.0;0 |
| 1 | package org.apache.maven.archiva.reporting; | |
| 2 | ||
| 3 | /* | |
| 4 | * Licensed to the Apache Software Foundation (ASF) under one | |
| 5 | * or more contributor license agreements. See the NOTICE file | |
| 6 | * distributed with this work for additional information | |
| 7 | * regarding copyright ownership. The ASF licenses this file | |
| 8 | * to you under the Apache License, Version 2.0 (the | |
| 9 | * "License"); you may not use this file except in compliance | |
| 10 | * with the License. You may obtain a copy of the License at | |
| 11 | * | |
| 12 | * http://www.apache.org/licenses/LICENSE-2.0 | |
| 13 | * | |
| 14 | * Unless required by applicable law or agreed to in writing, | |
| 15 | * software distributed under the License is distributed on an | |
| 16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
| 17 | * KIND, either express or implied. See the License for the | |
| 18 | * specific language governing permissions and limitations | |
| 19 | * under the License. | |
| 20 | */ | |
| 21 | ||
| 22 | import java.util.List; | |
| 23 | ||
| 24 | import org.apache.maven.archiva.database.ArchivaDatabaseException; | |
| 25 | import org.apache.maven.archiva.database.ObjectNotFoundException; | |
| 26 | ||
| 27 | /** | |
| 28 | * DynamicReportSource | |
| 29 | * | |
| 30 | * @version $Id: DynamicReportSource.java 755290 2009-03-17 15:53:37Z brett $ | |
| 31 | */ | |
| 32 | public interface DynamicReportSource<T> | |
| 33 | { | |
| 34 | /** | |
| 35 | * The human readable name of this report. | |
| 36 | * | |
| 37 | * @return the name of the report. | |
| 38 | */ | |
| 39 | public String getName(); | |
| 40 | ||
| 41 | /** | |
| 42 | * Get the entire list of values for this report. | |
| 43 | * | |
| 44 | * @return the complete List of objects for this report. | |
| 45 | * @throws ArchivaDatabaseException if there was a fundamental issue with accessing the database. | |
| 46 | * @throws ObjectNotFoundException if no records were found. | |
| 47 | */ | |
| 48 | public List<T> getData() throws ObjectNotFoundException, ArchivaDatabaseException; | |
| 49 | ||
| 50 | /** | |
| 51 | * Get the entire list of values for this report. | |
| 52 | * | |
| 53 | * @param limits the limits on the data to fetch. (NOTE: This object is | |
| 54 | * updated by the underlying implementation of this interface with | |
| 55 | * the current values appropriate for the limits object). | |
| 56 | * @return the complete List of objects for this report. | |
| 57 | * @throws ArchivaDatabaseException if there was a fundamental issue with accessing the database. | |
| 58 | * @throws ObjectNotFoundException if no records were found. | |
| 59 | */ | |
| 60 | public List<T> getData( DataLimits limits ) throws ObjectNotFoundException, ArchivaDatabaseException; | |
| 61 | } |