View Javadoc

1   /**
2    * Copyright 2005-2011 The Kuali Foundation
3    *
4    * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
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.kuali.rice.kew.routeheader;
17  
18  import java.io.Serializable;
19  
20  import org.kuali.rice.kew.engine.RouteContext;
21  import org.w3c.dom.Document;
22  import org.w3c.dom.Element;
23  
24  
25  /**
26   * A facade for the XML content of the document.  Provides methods for
27   * accessing the various relevant portions of the content as well as the
28   * entire document content in DOM or String form.  If the document does
29   * not contain a particular piece, then the associated getter should return
30   * null.
31   * 
32   * @author Kuali Rice Team (rice.collab@kuali.org)
33   */
34  public interface DocumentContent extends Serializable {
35  
36      public Document getDocument();
37      public Element getApplicationContent();
38      public Element getAttributeContent();
39      public Element getSearchableContent();
40      public String getDocContent();
41      
42      /*
43       * This method is a total hacks, once we fix the interface for role attributes and regular attributes, they can go away
44       */
45      public RouteContext getRouteContext();
46      
47  }