KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > tigris > scarab > om > Conditioned


1 package org.tigris.scarab.om;
2
3 /* ================================================================
4  * Copyright (c) 2000-2004 CollabNet. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are
8  * met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in the
15  * documentation and/or other materials provided with the distribution.
16  *
17  * 3. The end-user documentation included with the redistribution, if
18  * any, must include the following acknowlegement: "This product includes
19  * software developed by Collab.Net <http://www.Collab.Net/>."
20  * Alternately, this acknowlegement may appear in the software itself, if
21  * and wherever such third-party acknowlegements normally appear.
22  *
23  * 4. The hosted project names must not be used to endorse or promote
24  * products derived from this software without prior written
25  * permission. For written permission, please contact info@collab.net.
26  *
27  * 5. Products derived from this software may not use the "Tigris" or
28  * "Scarab" names nor may "Tigris" or "Scarab" appear in their names without
29  * prior written permission of Collab.Net.
30  *
31  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
32  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
33  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
34  * IN NO EVENT SHALL COLLAB.NET OR ITS CONTRIBUTORS BE LIABLE FOR ANY
35  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
37  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
38  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
39  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
40  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42  *
43  * ====================================================================
44  *
45  * This software consists of voluntary contributions made by many
46  * individuals on behalf of Collab.Net.
47  */
48
49 import org.apache.torque.TorqueException;
50
51 /**
52  * This interface declared the methods that any object subjected to Conditions
53  * should implement. It's meant to enforce the way this objects behave, so the
54  * Condition-related actions could evolve if necessary.
55  *
56  * @author Jorge
57  *
58  */
59 public interface Conditioned
60 {
61     /**
62      * Returns the array of Ids of the conditions that will force the requirement
63      * of this attribute if set. Used by templates to load the combo.
64      * @return
65      */
66     public Integer JavaDoc[] getConditionsArray();
67     /**
68      * Load the attribute options' IDs from the template combo.
69      * @param aOptionId
70      * @throws Exception
71      */
72     public void setConditionsArray(Integer JavaDoc aOptionId[])
73             throws Exception JavaDoc;
74     /**
75      * Return true if the given attributeOptionId will make the current
76      * attribute required.
77      * @param optionID
78      * @return
79      * @throws TorqueException
80      */
81     public boolean isRequiredIf(Integer JavaDoc optionID)
82             throws TorqueException;
83     
84     /**
85      *
86      * @return true if there's any condition associated to this object, false if there's not.
87      */
88     public boolean isConditioned();
89 }
Popular Tags