← Back to branch summary

~mortenoh/+junk/dhis2-detailed-import-export

« back to all changes in this revision

Viewing changes to dhis-2/dhis-services/dhis-service-reporting/src/main/java/org/hisp/dhis/completeness/DataSetCompletenessService.java

  • Committer: larshelge at gmail
  • Date: 2009-03-03 16:46:36 UTC
  • Revision ID: larshelge@gmail.com-20090303164636-2sjlrquo7ib1gf7r
Initial check-in

Show diffs side-by-side

added added

removed removed

Lines of Context:
dhis-2/dhis-services/dhis-service-reporting/src/main/java/org/hisp/dhis/completeness/DataSetCompletenessService.java
 
1
package org.hisp.dhis.completeness;
 
2
 
 
3
/*
 
4
 * Copyright (c) 2004-2007, University of Oslo
 
5
 * All rights reserved.
 
6
 *
 
7
 * Redistribution and use in source and binary forms, with or without
 
8
 * modification, are permitted provided that the following conditions are met:
 
9
 * * Redistributions of source code must retain the above copyright notice, this
 
10
 *   list of conditions and the following disclaimer.
 
11
 * * Redistributions in binary form must reproduce the above copyright notice,
 
12
 *   this list of conditions and the following disclaimer in the documentation
 
13
 *   and/or other materials provided with the distribution.
 
14
 * * Neither the name of the HISP project nor the names of its contributors may
 
15
 *   be used to endorse or promote products derived from this software without
 
16
 *   specific prior written permission.
 
17
 *
 
18
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 
19
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 
20
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 
21
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 
22
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 
23
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 
24
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 
25
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 
26
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 
27
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
28
 */
 
29
 
 
30
import java.util.Collection;
 
31
import java.util.Date;
 
32
 
 
33
import org.hisp.dhis.dataset.DataSet;
 
34
import org.hisp.dhis.external.configuration.NoConfigurationFoundException;
 
35
import org.hisp.dhis.organisationunit.OrganisationUnit;
 
36
import org.hisp.dhis.period.Period;
 
37
 
 
38
/**
 
39
 * @author Lars Helge Overland
 
40
 * @version $Id$
 
41
 */
 
42
public interface DataSetCompletenessService
 
43
{
 
44
    String ID = DataSetCompletenessService.class.getName();
 
45
    
 
46
    /**
 
47
     * Returns a Collection of DataSetCompletenessResults. The DataSetCompletenessResult
 
48
     * object contains the name of the associated DataSet, the number of
 
49
     * sources being associated with the DataSet AND being a child of the given 
 
50
     * OrganisationUnit, and the number of CompleteDataSetRegistrations for the
 
51
     * mentioned sources. One DataSetCompletenessResult is included for each
 
52
     * distinct DataSet associated with any of the given OrganisationUnit
 
53
     * or its children.
 
54
     * 
 
55
     * @param periodId the identifier of the Period.
 
56
     * @param organisationUnitId the identifier of the root OrganisationUnit.
 
57
     * @return a Collection of DataSetCompletenessResults.
 
58
     */
 
59
    Collection<DataSetCompletenessResult> getDataSetCompleteness( int periodId, int organisationUnitId );
 
60
    
 
61
    /**
 
62
     * Returns a Collection of DataSetCompletenessResults. The DataSetCompletenessResult
 
63
     * object contains the name of the associated OrganisationUnit, the number of
 
64
     * sources being associated with the DataSet AND being a child of the OrganisationUnit,
 
65
     * and the number of CompleteDataSetRegistrations for the mentioned sources
 
66
     * for the DataSet. One DataSetCompletenessResult is included for each child
 
67
     * of the OrganisationUnit.
 
68
     * 
 
69
     * @param periodId the identifier of the Period.
 
70
     * @param parentOrganisationUnitId the identifier of the parent OrganisationUnit.
 
71
     * @param dataSetId the identifier of the DataSet.
 
72
     * @return a Collection of DataSetCompletenessResults.
 
73
     */
 
74
    Collection<DataSetCompletenessResult> getDataSetCompleteness( int periodId, int parentOrganisationUnitId, int dataSetId );
 
75
    
 
76
    /**
 
77
     * Returns a Collection of DataSetCompletenessResults.
 
78
     * 
 
79
     * @param period the Period.
 
80
     * @param unit the OrganisationUnit.
 
81
     * @param dataSet the DataSet.
 
82
     * @return a Collection of DataSetCompletenessResults.
 
83
     */
 
84
    DataSetCompletenessResult getDataSetCompleteness( Period period, Date deadline, OrganisationUnit unit, DataSet dataSet );
 
85
    
 
86
    /**
 
87
     * Sets the configuration for the data completeness functionality.
 
88
     * @param configuration the configuration object.
 
89
     */
 
90
    void setConfiguration( DataSetCompletenessConfiguration configuration );
 
91
    
 
92
    /**
 
93
     * Gets the configuration for the data completeness functionality.
 
94
     * @return the configuration for the data completeness functionality.
 
95
     * @throws NoConfigurationFoundException
 
96
     */
 
97
    DataSetCompletenessConfiguration getConfiguration()
 
98
        throws NoConfigurationFoundException;
 
99
}