View Javadoc

1   /*
2    * Copyright 2005-2007 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.attribute;
18  
19  import java.util.List;
20  
21  /**
22   * Represents an extension to a data object.  An Extension is associated with an Attribute which
23   * defines the properties of the Extension.  An Extension has a list of ExtensionData which
24   * store key-values pairs that represent the extension data.
25   *
26   * @author Kuali Rice Team (rice.collab@kuali.org)
27   */
28  public interface Extension {
29  
30  	/**
31  	 * Return the name of the attribute which defines the properties of this Extension.
32       * @return String
33       */
34  	public String getAttributeName();
35  
36  	/**
37  	 * Return the data associated with this Extension.
38       * @return List of Extension Data
39       */
40  	public List<ExtensionData> getData();
41  
42  	/**
43  	 * Returns the value of the ExtensionData with the specified key.
44       * @param key for data value
45       * @return String
46       */
47  	public String getDataValue(String key);
48  
49  }