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

« back to all changes in this revision

Viewing changes to dhis-2/dhis-services/dhis-service-importexport/src/main/java/org/hisp/dhis/importexport/ixf/config/IXFConfigurationManager.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:
 
1
package org.hisp.dhis.importexport.ixf.config;
 
2
 
 
3
import java.util.List;
 
4
 
 
5
/*
 
6
 * Copyright (c) 2004-2007, University of Oslo
 
7
 * All rights reserved.
 
8
 *
 
9
 * Redistribution and use in source and binary forms, with or without
 
10
 * modification, are permitted provided that the following conditions are met:
 
11
 * * Redistributions of source code must retain the above copyright notice, this
 
12
 *   list of conditions and the following disclaimer.
 
13
 * * Redistributions in binary form must reproduce the above copyright notice,
 
14
 *   this list of conditions and the following disclaimer in the documentation
 
15
 *   and/or other materials provided with the distribution.
 
16
 * * Neither the name of the HISP project nor the names of its contributors may
 
17
 *   be used to endorse or promote products derived from this software without
 
18
 *   specific prior written permission.
 
19
 *
 
20
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 
21
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 
22
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 
23
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 
24
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 
25
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 
26
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 
27
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 
28
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 
29
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
30
 */
 
31
 
 
32
/**
 
33
 * @author Lars Helge Overland
 
34
 * @version $Id: IXFConfigurationManager.java 4646 2008-02-26 14:54:29Z larshelg $
 
35
 */
 
36
public interface IXFConfigurationManager
 
37
{
 
38
    String ID = IXFConfigurationManager.class.getName();
 
39
    
 
40
    /**
 
41
     * Gets the configuration for the IXF export service. Gets default configuration if
 
42
     * no user configuration exists.
 
43
     * @return the current IXFConfiguration.
 
44
     */
 
45
    IXFConfiguration getConfiguration();
 
46
    
 
47
    /**
 
48
     * Sets the configuration for the IXF export service.
 
49
     * @param configuration the IXFConfiguration
 
50
     */
 
51
    void setConfiguration( IXFConfiguration configuration );
 
52
    
 
53
    /**
 
54
     * Returns all IXFCountries defined for the IXF format.
 
55
     * @return a List containing all countries defined for the IXF format.
 
56
     */
 
57
    List<IXFCountry> getCountries();
 
58
    
 
59
    /**
 
60
     * Returns the IXFCountry with the given key. 
 
61
     * @param key the key of the IXFCountry.
 
62
     * @return the IXFCountry with the given key, or null if no country
 
63
     * with the given key exist.
 
64
     */
 
65
    IXFCountry getCountry( String key );
 
66
}