01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/assignment/tags/taggable_sakai_2-4-1/api/Tag.java $
03: * $Id: Tag.java 22033 2007-03-01 15:58:59Z jmpease@syr.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2005-2006 The Sakai Foundation.
07: *
08: * Licensed under the Educational Community License, Version 1.0 (the "License");
09: * you may not use this file except in compliance with the License.
10: * You may obtain a copy of the License at
11: *
12: * http://www.opensource.org/licenses/ecl1.php
13: *
14: * Unless required by applicable law or agreed to in writing, software
15: * distributed under the License is distributed on an "AS IS" BASIS,
16: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17: * See the License for the specific language governing permissions and
18: * limitations under the License.
19: *
20: **********************************************************************************/package org.sakaiproject.assignment.taggable.api;
21:
22: import java.util.List;
23:
24: /**
25: * A tag from an activity to some object.
26: *
27: * @author The Sakai Foundation.
28: */
29: public interface Tag {
30:
31: /**
32: * @return A reference for the activity from which the tag originated.
33: */
34: public String getActivityRef();
35:
36: /**
37: * @return The object to which the tag was applied.
38: */
39: public Object getObject();
40:
41: /**
42: * Method to get the displayable data for each of this tag's fields. This
43: * list should be in the same order as the columns returned by
44: * {@link TagList#getColumns() TagList.getColumns}.
45: *
46: * @return A list of data corresponding to displayable fields for this tag.
47: */
48: public List<String> getFields();
49:
50: /**
51: * Method to get a specific field of data for this tag based on a specific
52: * column from the list returned by {@link TagList#getColumns()}.
53: *
54: * @param column
55: * The {@link TagColumn} object representing the specific field
56: * of data to retrieve from this tag.
57: * @return The data for the field associated with the given column.
58: */
59: public String getField(TagColumn column);
60: }
|