1 /*
2 * Copyright 2005-2008 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.rice.kns.inquiry;
17
18 import java.util.List;
19 import java.util.Map;
20
21 import org.kuali.rice.kns.bo.BusinessObject;
22 import org.kuali.rice.kns.lookup.HtmlData;
23
24 /**
25 * This interface defines the methods for inquirables.
26 */
27 public interface Inquirable {
28 public String getHtmlMenuBar();
29
30 public String getTitle();
31
32 public BusinessObject getBusinessObject(Map fieldValues);
33
34 public List getSections(BusinessObject bo);
35
36 public void setBusinessObjectClass(Class businessObjectClass);
37
38 public void addAdditionalSections(List columns, BusinessObject bo);
39
40 /**
41 * Indicates whether inactive records for the given collection should be display.
42 *
43 * @param collectionName - name of the collection (or sub-collection) to check inactive record display setting
44 * @return true if inactive records should be displayed, false otherwise
45 */
46 public boolean getShowInactiveRecords(String collectionName);
47
48 /**
49 * Returns the Map used to control the state of inactive record collection display. Exposed for setting from the
50 * maintenance jsp.
51 */
52 public Map<String, Boolean> getInactiveRecordDisplay();
53
54 /**
55 * Indicates to maintainble whether or not inactive records should be displayed for the given collection name.
56 *
57 * @param collectionName - name of the collection (or sub-collection) to set inactive record display setting
58 * @param showInactive - true to display inactive, false to not display inactive records
59 */
60 public void setShowInactiveRecords(String collectionName, boolean showInactive);
61
62 public HtmlData getInquiryUrl(BusinessObject businessObject, String attributeName, boolean forceInquiry);
63 }