1 /* 2 * Copyright 2011 The Kuali Foundation 3 * 4 * Licensed under the Educational Community License, Version 2.0 (the 5 * "License"); you may not use this file except in compliance with the 6 * License. You may obtain a copy of the License at 7 * 8 * http://www.osedu.org/licenses/ECL-2.0 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 13 * implied. See the License for the specific language governing 14 * permissions and limitations under the License. 15 */ 16 17 package org.kuali.student.r2.common.infc; 18 19 /** 20 * A small object to hold rich text along with plain formatting that 21 * can be more easily searched. 22 * 23 * @author Kuali Student Team (Kamal) 24 */ 25 26 public interface RichText { 27 28 /** 29 * Plain text version of the rich text with all the special formatting 30 * stripped out. 31 * 32 * @name Plain Text 33 * @required 34 */ 35 public String getPlain(); 36 37 38 /** 39 * Formatted version of the rich text with all the formatting included. 40 * 41 * TODO: Define what format is to be used? Is it assumed to be 42 * HTML? or WORD? or Wiki? 43 * 44 * @name Formatted Text 45 */ 46 public String getFormatted(); 47 } 48