← Back to branch summary

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

« back to all changes in this revision

Viewing changes to dhis-2/dhis-api/src/main/java/org/hisp/dhis/validation/ValidationRuleStore.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-api/src/main/java/org/hisp/dhis/validation/ValidationRuleStore.java
 
1
package org.hisp.dhis.validation;
 
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
/**
 
34
 * Interface that deals with validation rules.
 
35
 * 
 
36
 * @author Margrethe Store
 
37
 * @version $Id: ValidationRuleStore.java 5434 2008-06-18 18:57:59Z larshelg $
 
38
 */
 
39
public interface ValidationRuleStore
 
40
{
 
41
    String ID = ValidationRuleStore.class.getName();
 
42
 
 
43
    // -------------------------------------------------------------------------
 
44
    // ValidationRule
 
45
    // -------------------------------------------------------------------------
 
46
 
 
47
    /**
 
48
     * Adds a ValidationRule to the database.
 
49
     * 
 
50
     * @param validationRule the ValidationRule to add.
 
51
     * @return the generated unique identifier for the ValidationRule.
 
52
     */
 
53
    int addValidationRule( ValidationRule validationRule );
 
54
 
 
55
    /**
 
56
     * Delete a ValidationRule with the given identifiers from the database.
 
57
     * 
 
58
     * @param id the ValidationRule to delete.
 
59
     */
 
60
    void deleteValidationRule( ValidationRule validationRule );
 
61
 
 
62
    /**
 
63
     * Update a ValidationRule with the given identifiers.
 
64
     * 
 
65
     * @param validationRule the ValidationRule to update.
 
66
     */
 
67
    void updateValidationRule( ValidationRule validationRule );
 
68
 
 
69
    /**
 
70
     * Get ValidationRule with the given identifier.
 
71
     * 
 
72
     * @param id the unique identifier of the ValidationRule.
 
73
     * @return the ValidationRule or null if it doesn't exist.
 
74
     */
 
75
    ValidationRule getValidationRule( int id );
 
76
 
 
77
    /**
 
78
     * Get all ValidationRules.
 
79
     * 
 
80
     * @return a Collection of ValidationRule or null if it there are no validation rules.
 
81
     */    
 
82
    Collection<ValidationRule> getAllValidationRules();
 
83
 
 
84
    /**
 
85
     * Get a ValidationRule with the given name.
 
86
     * 
 
87
     * @param name the name of the ValidationRule.
 
88
     */
 
89
    ValidationRule getValidationRuleByName( String name );
 
90
    
 
91
    // -------------------------------------------------------------------------
 
92
    // ValidationRule
 
93
    // -------------------------------------------------------------------------
 
94
 
 
95
    /**
 
96
     * Adds a ValidationRuleGroup to the database.
 
97
     * 
 
98
     * @param validationRuleGroup the ValidationRuleGroup to add.
 
99
     * @return the generated unique identifier for the ValidationRuleGroup.
 
100
     */
 
101
    int addValidationRuleGroup( ValidationRuleGroup validationRuleGroup );
 
102
 
 
103
    /**
 
104
     * Delete a ValidationRuleGroup with the given identifiers from the database.
 
105
     * 
 
106
     * @param id the ValidationRuleGroup to delete.
 
107
     */
 
108
    void deleteValidationRuleGroup( ValidationRuleGroup validationRuleGroup );
 
109
 
 
110
    /**
 
111
     * Update a ValidationRuleGroup with the given identifiers.
 
112
     * 
 
113
     * @param validationRule the ValidationRule to update.
 
114
     */
 
115
    void updateValidationRuleGroup( ValidationRuleGroup validationRuleGroup );
 
116
 
 
117
    /**
 
118
     * Get ValidationRuleGroup with the given identifier.
 
119
     * 
 
120
     * @param id the unique identifier of the ValidationRuleGroup.
 
121
     * @return the ValidationRule or null if it doesn't exist.
 
122
     */
 
123
    ValidationRuleGroup getValidationRuleGroup( int id );
 
124
 
 
125
    /**
 
126
     * Get all ValidationRuleGroups.
 
127
     * 
 
128
     * @return a Collection of ValidationRuleGroup or null if it there are no ValidationRuleGroups.
 
129
     */    
 
130
    Collection<ValidationRuleGroup> getAllValidationRuleGroups();
 
131
    
 
132
    /**
 
133
     * Get a ValidationRuleGroup with the given name.
 
134
     * 
 
135
     * @param name the name of the ValidationRuleGroup.
 
136
     */
 
137
    ValidationRuleGroup getValidationRuleGroupByName( String name );
 
138
}