KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > outerj > daisy > doctaskrunner > DocumentSelection


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.doctaskrunner;
17
18 import org.outerj.daisy.repository.VariantKey;
19 import org.outerj.daisy.repository.Repository;
20 import org.outerj.daisy.repository.RepositoryException;
21
22 /**
23  * Represents a set of documents on which a task willl be run.
24  */

25 public interface DocumentSelection {
26     /**
27      *
28      * @param repository useful if a e.g. a query needs to be executed to determine the result.
29      * @return an array of VariantKeys, in which each VariantKey should be unique (no duplicates).
30      */

31     VariantKey[] getKeys(Repository repository) throws RepositoryException;
32
33     String JavaDoc getDescription();
34 }
35
Popular Tags