01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/osp/tags/sakai_2-4-1/common/api/src/java/org/theospi/portfolio/list/intf/ListGenerator.java $
03: * $Id: ListGenerator.java 18535 2006-11-29 18:32:53Z chmaurer@iupui.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.theospi.portfolio.list.intf;
21:
22: import java.util.List;
23: import java.util.Map;
24:
25: import org.sakaiproject.site.api.ToolConfiguration;
26:
27: public interface ListGenerator {
28:
29: /**
30: *
31: * @return array of coluimn names (should be bean names)
32: */
33: public List getColumns();
34:
35: /**
36: *
37: * @return array of columns a user has by default
38: */
39: public List getDefaultColumns();
40:
41: /**
42: *
43: * @return The list of columns that are sortable
44: */
45: public List getSortableColumns();
46:
47: /**
48: *
49: * @return The column name that is the default sort
50: */
51: public String getDefaultSortColumn();
52:
53: /**
54: *
55: * @return The list of columns that need to have values looked up in the message bundle
56: */
57: public List getBundleLookupColumns();
58:
59: /**
60: *
61: * @return The list of ColumnConfigs that were defined
62: */
63: public List getColumnConfig();
64:
65: /**
66: *
67: * @return the current user's list of objects
68: * (whatever that means to the implentation)
69: */
70: public List getObjects();
71:
72: /**
73: *
74: * @param entry
75: * @return map of params
76: */
77: public Map getToolParams(Object entry);
78:
79: public ToolConfiguration getToolInfo(Map request);
80:
81: public boolean isNewWindow(Object entry);
82:
83: }
|