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