001/**
002 * Copyright 2005-2017 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.kew.actionlist;
017
018import java.io.Serializable;
019
020import org.kuali.rice.kew.api.action.ActionItem;
021import org.kuali.rice.kew.actionlist.web.ActionListAction;
022import org.kuali.rice.kew.api.action.ActionSet;
023import org.kuali.rice.kew.api.actionlist.DisplayParameters;
024
025
026/**
027 * An attribute which allows for the Action List to be customized to provide
028 * Mass Actions and an internal frame for displaying a summary view of the
029 * document on each row in the Action List.
030 *
031 * @see ActionListAction
032 * @see DefaultCustomActionListAttribute
033 *
034 * @author Kuali Rice Team (rice.collab@kuali.org)
035 */
036public interface CustomActionListAttribute extends Serializable {
037
038        /**
039         * Returns the set of legal actions for this Action List attribute.  This set of actions dictates
040         * which actions can be taken on the document from the ActionList.  If this method returns null then
041         * action invocation will not be available from the action list.
042         */
043        public ActionSet getLegalActions(String principalId, ActionItem actionItem) throws Exception;
044
045        /**
046         * Returns the display parameters for the inline framed doc handler on the Action List.
047         * If this method returns null, then a default value will be used.
048         */
049        public DisplayParameters getDocHandlerDisplayParameters(String principalId, ActionItem actionItem) throws Exception;
050
051}