View Javadoc

1   /*
2    * Copyright 2005-2008 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.IOException;
20  import java.io.InputStream;
21  
22  /**
23   * Interface describing an abstract XML document source
24   * @see org.kuali.rice.kew.batch.XmlDocCollection
25   * @see org.kuali.rice.kew.batch.BaseXmlDoc
26   * @see org.kuali.rice.kew.batch.FileXmlDoc
27   * @see org.kuali.rice.kew.batch.ZipXmlDoc
28   * @author Kuali Rice Team (rice.collab@kuali.org)
29   */
30  public interface XmlDoc {
31      String getName();
32      InputStream getStream() throws IOException;
33      XmlDocCollection getCollection();
34      boolean isProcessed();
35      void setProcessed(boolean processed);
36      String getProcessingMessage();
37      void setProcessingMessage(String message);
38  }