01: /*
02: * Copyright 2007 Outerthought bvba and Schaubroeck nv
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
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: /**
19: * A hierarchical selection list for link-type fields. It works
20: * by building up a hierarchy from documents which are connected through
21: * a link-type field indicating what the parent document is. The root
22: * documents are those for which this field is null.
23: *
24: * <p>This selection list is created on a field type through
25: * {@link FieldType#createParentLinkedSelectionList}.
26: */
27: public interface ParentLinkedSelectionList extends SelectionList {
28: String getWhereClause();
29:
30: /**
31: *
32: * @param whereClause everything that comes after the 'where' in the query. This can
33: * include an order by clause, the order of the items as returned
34: * from the query will be maintained.
35: */
36: void setWhereClause(String whereClause);
37:
38: boolean getFilterVariants();
39:
40: void setFilterVariants(boolean filterVariants);
41:
42: String getParentLinkField();
43:
44: void setParentLinkField(String parentLinkField);
45: }
|