View Javadoc

1   /**
2    * Copyright 2005-2014 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.coreservice.api.style;
17  
18  import org.kuali.rice.core.api.mo.common.GloballyUnique;
19  import org.kuali.rice.core.api.mo.common.Identifiable;
20  import org.kuali.rice.core.api.mo.common.Versioned;
21  import org.kuali.rice.core.api.mo.common.active.Inactivatable;
22  
23  /**
24   * This is the contract for a Style.  A style represents a stylesheet that is used for transforming data from
25   * one format to another (currently only XSL is supported).
26   * 
27   * @author Kuali Rice Team (rice.collab@kuali.org)
28   *
29   */
30  public interface StyleContract extends Identifiable, Versioned, GloballyUnique, Inactivatable {
31  
32  	/**
33  	 * Returns the name of this style.  All styles have a name and this value
34  	 * can never be null or blank.  The name must be unique within the entire
35  	 * repository of existing styles.
36  	 * 
37  	 * @return the name of this style
38  	 */
39  	String getName();
40  	
41  	/**
42  	 * Returns the XML definition of this style as a String.
43  	 * 
44  	 * @return the xml definition of this style
45  	 */
46  	String getXmlContent();
47  }