KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > outerj > daisy > repository > schema > StaticSelectionList


1 /*
2  * Copyright 2004 Outerthought bvba and Schaubroeck nv
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.outerj.daisy.repository.schema;
17
18 import org.outerx.daisy.x10.StaticSelectionListDocument;
19
20
21 /**
22  * A static selection list, manually created
23  * by a daisy administrator for a specific FieldType.
24  */
25 public interface StaticSelectionList extends SelectionList {
26
27     /**
28      * Adds a value to this StaticSelectionList.
29      *
30      * <p>This value will be wrapped in a ListItem object,
31      * i.e. this method is actually a shortcut for the
32      * createStaticListItem(ListItem listItem) method, relieving
33      * the outside world from the task of creating
34      * a ListItem object.
35      *
36      * @param value the object containing the value to be
37      * stored in the StaticSelectionList
38      * @throws Exception
39      */
40     void addItem(Object JavaDoc value) throws Exception JavaDoc;
41
42     /**
43      * Clears this SelectionList
44      */
45     void clear();
46
47     /**
48      * Creates a StaticListItem instance, adds it to this selection
49      * list and returns it.
50      *
51      * @param value the object containing the value to be stored
52      * in the StaticListItem
53      */
54     StaticListItem createStaticListItem(Object JavaDoc value);
55
56     StaticSelectionListDocument getXml();
57
58     void setAllFromXml(org.outerx.daisy.x10.StaticSelectionListDocument.StaticSelectionList list);
59 }
60
Popular Tags