org.kuali.rice.kns.inquiry
Interface Inquirable

All Known Implementing Classes:

ComponentInquirableImpl, FiscalOfficerInfoInquiryViewHelperServiceImpl, GroupInquirableImpl, KimTypeInquirableImpl, KualiInquirableImpl, PermissionInquirableImpl, PersonInquirableImpl, ResponsibilityInquirableImpl, RoleInquirableImpl, RoleMemberInquirableImpl, RuleBaseValuesInquirableImpl, RuleDelegationInquirableImpl

public interface Inquirable

Defines business logic methods that support the Inquiry framework

Method Summary

void	addAdditionalSections(List columns, BusinessObject bo) Deprecated.
void	buildInquirableLink(Object dataObject, String propertyName, Inquiry inquiry) Invoked by the ViewHelperService to build a link to the inquiry
BusinessObject	getBusinessObject(Map fieldValues) Deprecated.
Object	getDataObject(Map<String,String> fieldValues) Responsible for retrieving the data object from its data source (database, service call, etc).
String	getHtmlMenuBar() Deprecated.
Map<String,Boolean>	getInactiveRecordDisplay() Deprecated.
HtmlData	getInquiryUrl(BusinessObject businessObject, String attributeName, boolean forceInquiry) Deprecated.
List	getSections(BusinessObject bo) Deprecated.
boolean	getShowInactiveRecords(String collectionName) Deprecated.
String	getTitle() Deprecated.
void	setBusinessObjectClass(Class businessObjectClass) Deprecated.
void	setDataObjectClass(Class<?> dataObjectClass) This method will be called before getDataObject(Map).
void	setShowInactiveRecords(String collectionName, boolean showInactive) Deprecated.

Method Detail

getDataObject

Object getDataObject(Map<String,String> fieldValues)

Responsible for retrieving the data object from its data source (database, service call, etc).

Parameters:

fieldValues - a map of string field names and values

Returns:

the data object or null if not found

setDataObjectClass

void setDataObjectClass(Class<?> dataObjectClass)

This method will be called before getDataObject(Map). This is useful for implementing inquirables that can handle multiple data object types.

Parameters:

dataObjectClass - the class of the dataObject that this inquirable should retrieve

buildInquirableLink

void buildInquirableLink(Object dataObject,
                         String propertyName,
                         Inquiry inquiry)

Invoked by the ViewHelperService to build a link to the inquiry

Note this is used primarily for custom Inquirable implementations to customize the inquiry class or parameters for an inquiry. Instead of building the full inquiry link, implementations can make a callback to org.kuali.rice.kns.uif.widget.Inquiry.buildInquiryLink(Object, String, Class, Map) given an inquiry class and parameters to build the link field.

Parameters:

dataObject - - parent object for the inquiry property

propertyName - - name of the property the inquiry is being built for

inquiry - - instance of the inquiry widget being built for the property

setBusinessObjectClass

@Deprecated
void setBusinessObjectClass(Class businessObjectClass)

Deprecated.

getBusinessObject

@Deprecated
BusinessObject getBusinessObject(Map fieldValues)

Deprecated.

getInquiryUrl

@Deprecated
HtmlData getInquiryUrl(BusinessObject businessObject,
                                  String attributeName,
                                  boolean forceInquiry)

Deprecated.

getHtmlMenuBar

@Deprecated
String getHtmlMenuBar()

Deprecated.

getTitle

@Deprecated
String getTitle()

Deprecated.

getSections

@Deprecated
List getSections(BusinessObject bo)

Deprecated.

addAdditionalSections

@Deprecated
void addAdditionalSections(List columns,
                                      BusinessObject bo)

Deprecated.

getShowInactiveRecords

@Deprecated
boolean getShowInactiveRecords(String collectionName)

Deprecated.

Indicates whether inactive records for the given collection should be display.

Parameters:

collectionName - - name of the collection (or sub-collection) to check inactive record display setting

Returns:

true if inactive records should be displayed, false otherwise

getInactiveRecordDisplay

@Deprecated
Map<String,Boolean> getInactiveRecordDisplay()

Deprecated.

Returns the Map used to control the state of inactive record collection display. Exposed for setting from the maintenance jsp.

setShowInactiveRecords

@Deprecated
void setShowInactiveRecords(String collectionName,
                                       boolean showInactive)

Deprecated.

Indicates to maintainble whether or not inactive records should be displayed for the given collection name.

Parameters:

collectionName - - name of the collection (or sub-collection) to set inactive record display setting

showInactive - - true to display inactive, false to not display inactive records