source.dussan.org Git - archiva.git/blob

   1 package org.apache.archiva.redback.integration.reports;
   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.io.OutputStream;
  23
  24 /**
  25  * Report
  26  *
  27  * @author <a href="mailto:joakim@erdfelt.com">Joakim Erdfelt</a>
  28  *
  29  */
  30 public interface Report
  31 {
  32     /**
  33      * The Name of the Report (for display to the user)
  34      *
  35      * @return the name of the report.
  36      */
  37     String getName();
  38
  39     /**
  40      * The type of report (example: 'csv', 'xls', 'pdf')
  41      * Used in the display of the report links to the user.
  42      *
  43      * @return the type of report.
  44      */
  45     String getType();
  46
  47     /**
  48      * The mimetype of the report. (used to set download content type correctly)
  49      *
  50      * @return the mimetype.
  51      */
  52     String getMimeType();
  53
  54     /**
  55      * The ID for this report.
  56      *
  57      * @return the ID for this report.
  58      */
  59     String getId();
  60
  61     /**
  62      * Write Report to provided outputstream.
  63      *
  64      * @param os the outputstream to write to.
  65      * @throws ReportException if there was a problem in generating the report.
  66      */
  67     void writeReport( OutputStream os )
  68         throws ReportException;
  69 }