View Javadoc

1   /*
2    * Copyright 2005-2007 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.kns.service;
17  
18  import javax.xml.transform.TransformerException;
19  
20  /**
21   * This interface defines methods that an XmlObjectSerializer Service must provide. This will wrap our needs for xml to object and
22   * object to xml functionality.
23   * 
24   * 
25   */
26  public interface XmlObjectSerializerService {
27      /**
28       * Marshals out XML from an object instance.
29       * 
30       * @param object
31       * @return
32       */
33      public String toXml(Object object);
34  
35      /**
36       * Retrieves an Object instance from a String of XML - unmarshals.
37       * 
38       * @param xml
39       * @return
40       */
41      public Object fromXml(String xml);
42  
43      /**
44       * Renders an org.w3c.Node to a String.
45       */
46      public String writeNode(org.w3c.dom.Node node, boolean indent) throws TransformerException;
47  
48  }