01: /*
02: * Copyright 2005-2007 The Kuali Foundation.
03: *
04: * Licensed under the Educational Community License, Version 1.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.opensource.org/licenses/ecl1.php
09: *
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.core.inquiry;
17:
18: import java.util.List;
19: import java.util.Map;
20:
21: import org.kuali.core.bo.BusinessObject;
22:
23: /**
24: * This interface defines the methods for inquirables.
25: */
26: public interface Inquirable {
27: public String getHtmlMenuBar();
28:
29: public String getTitle();
30:
31: public BusinessObject getBusinessObject(Map fieldValues);
32:
33: public List getSections(BusinessObject bo);
34:
35: public void setBusinessObjectClass(Class businessObjectClass);
36:
37: public void addAdditionalSections(List columns, BusinessObject bo);
38:
39: /**
40: * Indicates whether inactive records for the given collection should be display.
41: *
42: * @param collectionName - name of the collection (or sub-collection) to check inactive record display setting
43: * @return true if inactive records should be displayed, false otherwise
44: */
45: public boolean getShowInactiveRecords(String collectionName);
46:
47: /**
48: * Returns the Map used to control the state of inactive record collection display. Exposed for setting from the
49: * maintenance jsp.
50: */
51: public Map<String, Boolean> getInactiveRecordDisplay();
52:
53: /**
54: * Indicates to maintainble whether or not inactive records should be displayed for the given collection name.
55: *
56: * @param collectionName - name of the collection (or sub-collection) to set inactive record display setting
57: * @param showInactive - true to display inactive, false to not display inactive records
58: */
59: public void setShowInactiveRecords(String collectionName,
60: boolean showInactive);
61:
62: public String getInquiryUrl(BusinessObject businessObject,
63: String attributeName, boolean forceInquiry);
64: }
|