View Javadoc

1   /*
2    * Copyright 2005-2007 The Kuali Foundation
3    * 
4    * 
5    * Licensed under the Educational Community License, Version 2.0 (the "License");
6    * you may not use this file except in compliance with the License.
7    * You may obtain a copy of the License at
8    * 
9    * http://www.opensource.org/licenses/ecl2.php
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.kuali.rice.kew.batch;
18  
19  import java.io.File;
20  import java.io.IOException;
21  import java.util.List;
22  
23  /**
24   * Interface describing an abstract XML document source collection
25   * @see org.kuali.rice.kew.batch.XmlDoc
26   * @see org.kuali.rice.kew.batch.BaseXmlDocCollection
27   * @see org.kuali.rice.kew.batch.FileXmlDocCollection
28   * @see org.kuali.rice.kew.batch.DirectoryXmlDocCollection
29   * @see org.kuali.rice.kew.batch.ZipXmlDocCollection
30   * @author Kuali Rice Team (rice.collab@kuali.org)
31   */
32  public interface XmlDocCollection {
33      File getFile();
34      List<? extends XmlDoc> getXmlDocs();
35      void close() throws IOException;
36  }