01: /*
02: * Copyright 2006 Pentaho Corporation. All rights reserved.
03: * This software was developed by Pentaho Corporation and is provided under the terms
04: * of the Mozilla Public License, Version 1.1, or any later version. You may not use
05: * this file except in compliance with the license. If you need a copy of the license,
06: * please go to http://www.mozilla.org/MPL/MPL-1.1.txt. The Original Code is the Pentaho
07: * BI Platform. The Initial Developer is Pentaho Corporation.
08: *
09: * Software distributed under the Mozilla Public License is distributed on an "AS IS"
10: * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. Please refer to
11: * the license for the specific language governing your rights and limitations.
12: *
13: * @created Oct 28, 2005
14: * @author dmoran
15: */
16:
17: package org.pentaho.designstudio.editors.xmleditor;
18:
19: import org.dom4j.Document;
20: import org.pentaho.designstudio.controls.IXmlModifier;
21:
22: public interface IXMLDocumentProvider extends IXmlModifier {
23:
24: /**
25: * Returns the DOM4J Document that this provider is responsible for
26: * @return The Document
27: */
28: public Document getDocument();
29:
30: /**
31: * Lets the provider know if the document has changed;
32: * @return The Document
33: */
34: public void setChanged();
35:
36: /**
37: * Tests the document for errors valid. Returns the error message if error or null for ok
38: *
39: * @return true if the document is valid
40: */
41: public String getDocErrors();
42: }
|