1 /*
2 * Copyright 2011 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 1.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/ecl1.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.core.api.style;
17
18 import org.kuali.rice.core.api.mo.common.GloballyUnique;
19 import org.kuali.rice.core.api.mo.common.Versioned;
20 import org.kuali.rice.core.api.mo.common.active.Inactivatable;
21
22 /**
23 * This is the contract for a Style. A style represents a stylesheet that is used for transforming data from
24 * one format to another (currently only XSL is supported).
25 *
26 * @author Kuali Rice Team (rice.collab@kuali.org)
27 *
28 */
29 public interface StyleContract extends Versioned, GloballyUnique, Inactivatable {
30
31 /**
32 * Returns the identifier of this style. Should only return null if this
33 * style has not been persisted to a data repository yet. Each
34 * individual style should have a unique identifier.
35 *
36 * @return the id of this style, or null if it has not yet been set
37 */
38 Long getStyleId();
39
40 /**
41 * Returns the name of this style. All styles have a name and this value
42 * can never be null or blank. The name must be unique within the entire
43 * repository of existing styles.
44 *
45 * @return the name of this style
46 */
47 String getName();
48
49 /**
50 * Returns the XML definition of this style as a String.
51 *
52 * @return the xml definition of this style
53 */
54 String getXmlContent();
55 }