01: /*
02: * Copyright 2005-2006 The Kuali Foundation.
03: *
04: *
05: * Licensed under the Educational Community License, Version 1.0 (the "License");
06: * you may not use this file except in compliance with the License.
07: * You may obtain a copy of the License at
08: *
09: * http://www.opensource.org/licenses/ecl1.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 edu.iu.uis.eden.plugin.attributes;
18:
19: import java.io.Serializable;
20:
21: import edu.iu.uis.eden.actionitem.ActionItem;
22: import edu.iu.uis.eden.actionlist.DefaultCustomActionListAttribute;
23: import edu.iu.uis.eden.actionlist.DisplayParameters;
24: import edu.iu.uis.eden.actionlist.web.ActionListAction;
25: import edu.iu.uis.eden.actions.ActionSet;
26: import edu.iu.uis.eden.web.session.UserSession;
27:
28: /**
29: * An attribute which allows for the Action List to be customized to provide
30: * Mass Actions and an internal frame for displaying a summary view of the
31: * document on each row in the Action List.
32: *
33: * @see ActionListAction
34: * @see DefaultCustomActionListAttribute
35: *
36: * @author rkirkend
37: * @author ewestfal
38: */
39: public interface CustomActionListAttribute extends Serializable {
40:
41: /**
42: * Returns the set of legal actions for this Action List attribute. This set of actions dictates
43: * which actions can be taken on the document from the ActionList. If this method returns null then
44: * action invocation will not be available from the action list.
45: */
46: public ActionSet getLegalActions(UserSession userSession,
47: ActionItem actionItem) throws Exception;
48:
49: /**
50: * Returns the display parameters for the inline framed doc handler on the Action List.
51: * If this method returns null, then a default value will be used.
52: */
53: public DisplayParameters getDocHandlerDisplayParameters(
54: UserSession userSession, ActionItem actionItem)
55: throws Exception;
56:
57: }
|