← 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-importexport/src/main/java/org/hisp/dhis/importexport/ImportObjectStore.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-importexport/src/main/java/org/hisp/dhis/importexport/ImportObjectStore.java
 
1
package org.hisp.dhis.importexport;
 
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
 
 
32
/**
 
33
 * @author Lars Helge Overland
 
34
 * @version $Id: ImportObjectStore.java 5793 2008-10-02 14:14:00Z larshelg $
 
35
 */
 
36
public interface ImportObjectStore
 
37
{
 
38
    String ID = ImportObjectStore.class.getName();
 
39
    
 
40
    /**
 
41
     * Adds an ImportObject.
 
42
     * 
 
43
     * @param importObject The ImportObject to add.
 
44
     * @return The generated identifier.
 
45
     */
 
46
    int addImportObject( ImportObject importObject );
 
47
    
 
48
    /**
 
49
     * Updates an ImportObject.
 
50
     * 
 
51
     * @param importObject The ImportObject to update.
 
52
     */
 
53
    void updateImportObject( ImportObject importObject );
 
54
    
 
55
    /**
 
56
     * Retrieves an ImportObject.
 
57
     * 
 
58
     * @param id The identifier of the ImportObject to retrieve.
 
59
     * @return The retrieved ImportObject.
 
60
     */
 
61
    ImportObject getImportObject( int id );
 
62
    
 
63
    /**
 
64
     * Retrieves ImportObjects of the given class.
 
65
     * 
 
66
     * @param clazz The class of the ImportObjects to retrieve.
 
67
     * @return A collection of retrieved ImportObjects.
 
68
     */
 
69
    Collection<ImportObject> getImportObjects( Class<?> clazz );
 
70
    
 
71
    /**
 
72
     * Retrieves ImportObjects of the given ImportObjectStatus and class.
 
73
     * 
 
74
     * @param status The ImportObjectStatus of the ImportObjects to retrive.
 
75
     * @param clazz The class of the ImportObjects to retrieve.
 
76
     * @return A collection of retrieved ImportObjects.
 
77
     */
 
78
    Collection<ImportObject> getImportObjects( ImportObjectStatus status, Class<?> clazz );
 
79
    
 
80
    /**
 
81
     * Retrives ImportObjects of the given GroupMemberType.
 
82
     * 
 
83
     * @param groupMemberType The GroupMemberType of the ImportObjects to retrieve.
 
84
     * @return A collection of retrieved ImportObjects.
 
85
     */
 
86
    Collection<ImportObject> getImportObjects( GroupMemberType groupMemberType );
 
87
 
 
88
    /**
 
89
     * Deletes an ImportObject.
 
90
     * 
 
91
     * @param importObject The ImportObject to delete. 
 
92
     */
 
93
    void deleteImportObject( ImportObject importObject );
 
94
    
 
95
    /**
 
96
     * Deletes ImportObjects of the given class.
 
97
     * 
 
98
     * @param clazz The class of the ImportObjects to delete.
 
99
     */
 
100
    void deleteImportObjects( Class<?> clazz );
 
101
    
 
102
    /**
 
103
     * Deletes ImportObjects of the given GroupMemberType.
 
104
     * 
 
105
     * @param groupMemberType The GroupMemberType of the ImportObjects to delete.
 
106
     */
 
107
    void deleteImportObjects( GroupMemberType groupMemberType );
 
108
    
 
109
    /**
 
110
     * Deletes all ImportObjects.
 
111
     */
 
112
    void deleteImportObjects();
 
113
}